Interface IBreadcrumbsOption<T>

Represents the options for the Breadcrumbs component.

interface IBreadcrumbsOption<T extends any = any> {
    action?: string;
    divider?: boolean;
    icon?: any;
    isDisabled?: (payload: T) => boolean | Promise<boolean>;
    isVisible?: (payload: T) => boolean | Promise<boolean>;
    label?: string;
    primary?: number | boolean;
}

Type Parameters

  • T extends any = any

    The type of the payload that can be passed to the isVisible and isDisabled functions.

Hierarchy

  • Omit<IOption, keyof { isDisabled: never; isVisible: never }>
    • IBreadcrumbsOption

Properties

action? divider? icon? isDisabled? isVisible? label? primary?

Properties

Optionalaction

action?: string

Optionaldivider

divider?: boolean

Optionalicon

icon?: any

OptionalisDisabled

isDisabled?: (payload: T) => boolean | Promise<boolean>

Checks if the payload is disabled.

Type declaration

    • (payload: T): boolean | Promise<boolean>

    • Parameters

      • payload: T

        The payload to check.

      Returns boolean | Promise<boolean>

      • A promise or a boolean indicating if the payload is disabled.

OptionalisVisible

isVisible?: (payload: T) => boolean | Promise<boolean>

Determines whether the given payload is visible.

Type declaration

    • (payload: T): boolean | Promise<boolean>

    • Parameters

      • payload: T

        The payload to be checked for visibility.

      Returns boolean | Promise<boolean>

      • A promise that resolves to a boolean or a direct boolean value indicating the visibility of the payload.

Optionallabel

label?: string

Optionalprimary

primary?: number | boolean

Settings

Member Visibility

On This Page

Properties