@aotearoan/neon/dist/src/components/navigation/breadcrumbs/NeonBreadcrumbs.d.ts

Neon is a lightweight design library of Vue 3 components with minimal dependencies.

import type { NeonBreadcrumbLink } from '@/model/navigation/breadcrumbs/NeonBreadcrumbLink';
import { NeonBreadcrumbResponsiveStyle } from '@/model/navigation/breadcrumbs/NeonBreadcrumbResponsiveStyle';
/**
 * The <em>NeonBreadcrumbs</em> component displays an optional list of breadcrumbs with an optional back button. This is
 * used in the <em>NeonHeader</em> component to display the current page hierarchy.
 */
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
    /**
     * The list of breadcrumbs to display.
     */
    breadcrumbs: {
        type: () => NeonBreadcrumbLink[];
        default: () => never[];
    };
    /**
     * Whether to display the back button.
     */
    backButton: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The label override for the back button.
     */
    backLabel: {
        type: StringConstructor;
        default: string;
    };
    /**
     * The responsive style (mobile-large breakpoint), either place in a swiper or display a larger back button & no
     * breadcrumbs.
     */
    responsiveStyle: {
        type: () => NeonBreadcrumbResponsiveStyle;
        default: NeonBreadcrumbResponsiveStyle;
    };
}>, {
    back: () => Promise<void>;
    linksRef: import("vue").Ref<HTMLDivElement | null, HTMLDivElement | null>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    /**
     * The list of breadcrumbs to display.
     */
    breadcrumbs: {
        type: () => NeonBreadcrumbLink[];
        default: () => never[];
    };
    /**
     * Whether to display the back button.
     */
    backButton: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The label override for the back button.
     */
    backLabel: {
        type: StringConstructor;
        default: string;
    };
    /**
     * The responsive style (mobile-large breakpoint), either place in a swiper or display a larger back button & no
     * breadcrumbs.
     */
    responsiveStyle: {
        type: () => NeonBreadcrumbResponsiveStyle;
        default: NeonBreadcrumbResponsiveStyle;
    };
}>> & Readonly<{}>, {
    breadcrumbs: NeonBreadcrumbLink[];
    backButton: boolean;
    backLabel: string;
    responsiveStyle: NeonBreadcrumbResponsiveStyle;
}, {}, {
    NeonIcon: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
        name: {
            type: StringConstructor;
            required: true;
        };
        id: {
            type: StringConstructor;
            default: null;
        };
        color: {
            type: () => import("../../../neon").NeonFunctionalColor;
            default: null;
        };
        inverse: {
            type: BooleanConstructor;
            default: boolean;
        };
        disabled: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>, {
        sanitizedAttributes: import("vue").ComputedRef<{
            [x: string]: unknown;
        }>;
        icon: import("vue").ComputedRef<string | undefined>;
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
        name: {
            type: StringConstructor;
            required: true;
        };
        id: {
            type: StringConstructor;
            default: null;
        };
        color: {
            type: () => import("../../../neon").NeonFunctionalColor;
            default: null;
        };
        inverse: {
            type: BooleanConstructor;
            default: boolean;
        };
        disabled: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>> & Readonly<{}>, {
        color: import("../../../neon").NeonFunctionalColor;
        id: string;
        inverse: boolean;
        disabled: boolean;
    }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
    NeonLink: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
        href: {
            type: StringConstructor;
            default: null;
        };
        noStyle: {
            type: BooleanConstructor;
            default: boolean;
        };
        outlineStyle: {
            type: () => import("../../../neon").NeonOutlineStyle;
            default: import("../../../neon").NeonOutlineStyle;
        };
        externalIndicator: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>, {
        neonLink: import("vue").Ref<HTMLAnchorElement | null, HTMLAnchorElement | null>;
        routerUrl: import("vue").ComputedRef<string | undefined>;
        sanitizedAttributes: import("vue").ComputedRef<{
            [x: string]: unknown;
        }>;
        activeRoute: import("vue").ComputedRef<boolean | "" | undefined>;
        exactRoute: import("vue").ComputedRef<boolean | "" | undefined>;
        onClick: () => void;
        onSpace: () => Promise<void>;
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
        href: {
            type: StringConstructor;
            default: null;
        };
        noStyle: {
            type: BooleanConstructor;
            default: boolean;
        };
        outlineStyle: {
            type: () => import("../../../neon").NeonOutlineStyle;
            default: import("../../../neon").NeonOutlineStyle;
        };
        externalIndicator: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>> & Readonly<{
        onClick?: ((...args: any[]) => any) | undefined;
    }>, {
        href: string;
        noStyle: boolean;
        outlineStyle: import("../../../neon").NeonOutlineStyle;
        externalIndicator: boolean;
    }, {}, {
        NeonIcon: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
            name: {
                type: StringConstructor;
                required: true;
            };
            id: {
                type: StringConstructor;
                default: null;
            };
            color: {
                type: () => import("../../../neon").NeonFunctionalColor;
                default: null;
            };
            inverse: {
                type: BooleanConstructor;
                default: boolean;
            };
            disabled: {
                type: BooleanConstructor;
                default: boolean;
            };
        }>, {
            sanitizedAttributes: import("vue").ComputedRef<{
                [x: string]: unknown;
            }>;
            icon: import("vue").ComputedRef<string | undefined>;
        }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
            name: {
                type: StringConstructor;
                required: true;
            };
            id: {
                type: StringConstructor;
                default: null;
            };
            color: {
                type: () => import("../../../neon").NeonFunctionalColor;
                default: null;
            };
            inverse: {
                type: BooleanConstructor;
                default: boolean;
            };
            disabled: {
                type: BooleanConstructor;
                default: boolean;
            };
        }>> & Readonly<{}>, {
            color: import("../../../neon").NeonFunctionalColor;
            id: string;
            inverse: boolean;
            disabled: boolean;
        }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
    }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
    NeonSwiper: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
        fade: {
            type: BooleanConstructor;
            default: boolean;
        };
        orientation: {
            type: () => import("../../../neon").NeonOrientation;
            default: import("../../../neon").NeonOrientation;
        };
        hideFadeStart: {
            type: BooleanConstructor;
            default: boolean;
        };
        hideFadeEnd: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>, {
        isOverflowing: import("vue").Ref<boolean, boolean>;
        isScrollStart: import("vue").Ref<boolean, boolean>;
        isScrollEnd: import("vue").Ref<boolean, boolean>;
        scrollable: import("vue").Ref<HTMLElement | null, HTMLElement | null>;
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
        fade: {
            type: BooleanConstructor;
            default: boolean;
        };
        orientation: {
            type: () => import("../../../neon").NeonOrientation;
            default: import("../../../neon").NeonOrientation;
        };
        hideFadeStart: {
            type: BooleanConstructor;
            default: boolean;
        };
        hideFadeEnd: {
            type: BooleanConstructor;
            default: boolean;
        };
    }>> & Readonly<{}>, {
        orientation: import("../../../neon").NeonOrientation;
        fade: boolean;
        hideFadeStart: boolean;
        hideFadeEnd: boolean;
    }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;