Interface IRunningItem

A running item.

interface IRunningItem {
    children?: IRunningItem[];
    className?: string;
    context?: string;
    detail?: (() => string);
    icon: (() => string | LabIcon);
    label: (() => ReactNode);
    labelTitle?: (() => string);
    open?: (() => void);
    shutdown?: (() => void);
}

Implemented by

    Properties

    children? className? context? detail? icon label labelTitle? open? shutdown?

    Properties

    Optional children

    children?: IRunningItem[]

    Optional child nodes that belong to a top-level running item.

    Optional className

    className?: string

    Optional CSS class name to add to the running item.

    Optional context

    context?: string

    Optional context hint to add to the data-context attribute of an item.

    Optional detail

    detail?: (() => string)

    Called to determine the detail attribute, which is shown optionally in a column after the label.

    Type declaration

      • (): string

      • Returns string

    icon

    icon: (() => string | LabIcon)

    The LabIcon to use as the icon for the running item or the string src URL.

    Type declaration

    label

    label: (() => ReactNode)

    Called to determine the label for each item.

    Type declaration

      • (): ReactNode

      • Returns ReactNode

    Optional labelTitle

    labelTitle?: (() => string)

    Called to determine the title attribute for each item, which is revealed on hover.

    Type declaration

      • (): string

      • Returns string

    Optional open

    open?: (() => void)

    Called when the running item is clicked.

    Type declaration

      • (): void

      • Returns void

    Optional shutdown

    shutdown?: (() => void)

    Called when the shutdown button is pressed on a particular item.

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    childrenclassNamecontextdetailiconlabellabelTitleopenshutdown