Icon

public struct Icon : Equatable

A struct that represents the image used in a row.

Show on GitHub

Properties

  • Returns Icon with an image of the given name for the normal state. The “-highlighted” suffix is appended to the name for the highlighted image.

    Declaration

    Swift

    public static func named(_ name: String, in bundle: Bundle? = nil, compatibleWith traitCollection: UITraitCollection? = nil) -> Icon

    Parameters

    name

    The name of the image asset.
    bundle

    The bundle containing the image file or asset catalog. Specify nil to search the app’s main bundle.
    traitCollection

    The traits associated with the intended environment for the image. Specify nil to use the traits associated with the main screen.
    Show on GitHub

  • Returns Icon with an image for the normal state. The image for the highlighted state is nil. A method to provide backward compatiblility with the previous enum case image(UIImage).

    Declaration

    Swift

    public static func image(_ image: UIImage) -> Icon
    Show on GitHub

  • Returns Icon with images for the normal and highlighted states. A method to provide backward compatiblility with the previous enum case images(normal: UIImage, highlighted: UIImage).

    Declaration

    Swift

    public static func images(normal: UIImage, highlighted: UIImage) -> Icon
    Show on GitHub

  • Returns Icon with the specified SF Symbol as the image for the normal state. The image for the highlighted state is nil.

    Declaration

    Swift

    @available(iOS 13.0, tvOS 13.0, *)
public static func sfSymbol(_ name: String, withConfiguration configuration: UIImage.Configuration? = nil) -> Icon

    Parameters

    name

    The name of the system symbol image.
    configuration

    The configuration to specify traits and other details that define the variant of image.
    Show on GitHub