FabItem

open class FabItem: NSObject

Undocumented

  • The action the item should perform when tapped.

    Declaration

    Swift

    public var action: FabItemAction?

  • The item’s button diameter. Default diameter of 35.

    Declaration

    Swift

    public let buttonDiameter: CGFloat = 35

  • The distance between the item’s label and button.

    Declaration

    Swift

    public var labelButtonOffset: CGFloat = 0

  • Whether the menu is dismissed when this item is selected.

    Declaration

    Swift

    public var dismissMenuOnSelection: Bool = true

  • The value to scale the button to when the cursor enters its bounds.

    Declaration

    Swift

    public var buttonMouseOverScale: CGFloat = 1.05

  • Whether the item ignores mouse down events.

    Declaration

    Swift

    public var isDisabled: Bool = false

  • The key-equivalent of the Fab item.

    Declaration

    Swift

    public var keyEquivalent: FabKeyEquivalent

  • Description of the item’s action.

    Declaration

    Swift

    open var text: String

  • Creates a new Fab item with an image and optional label.

    Declaration

    Swift

    public init(label: String?, image: NSImage, action: FabItemAction? = nil)

    Parameters

    label

    The string to display in the label.
    emoji

    The emoji to display in the button.

  • Creates a new Fab item with a label and button from an attributed string.

    Declaration

    Swift

    public init(label: String?, buttonIcon: NSAttributedString, action: FabItemAction? = nil)

    Parameters

    label

    The string to display in the label.
    buttonIcon

    The attributed string to display in the button. Should be a single character.

  • Creates a new Fab item with only a label.

    Declaration

    Swift

    public init(label: String, action: FabItemAction? = nil)

    Parameters

    label

    The string to display in the label.

  • A convenience initializer that creates a new Fab item with an emoji and optional label.

    Applies some default formatting to the button that should satisfy most emojis.

    Declaration

    Swift

    public convenience init(label: String?, emoji: String, action: FabItemAction? = nil)

    Parameters

    label

    The string to display in the label.
    emoji

    The emoji to display in the button.