@aotearoan/neon 28.5.0 → 28.6.0

package/dist/src/components/layout/basic-layout/NeonBasicLayout.d.ts

@@ -0,0 +1,427 @@
+import type { NeonBreadcrumbLink } from '@/model/navigation/breadcrumbs/NeonBreadcrumbLink';
+import { NeonHeaderLevel } from '@/model/presentation/header/NeonHeaderLevel';
+/**
+ * NeonBasicLayout is a component for a basic page layout with a header (NeonHeader) followed by the page content.
+ */
+declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /** The page title */
+    title: {
+        type: StringConstructor;
+    };
+    /** The page subtitle */
+    subtitle: {
+        type: StringConstructor;
+    };
+    /**
+     * Breadcrumbs to display above the header.
+     */
+    breadcrumbs: {
+        type: () => NeonBreadcrumbLink[];
+        default: () => never[];
+    };
+    /**
+     * Whether to display a back button.
+     */
+    backButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Override the label for the back button.
+     */
+    backLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Sticky button support on mobile */
+    stickyButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    hasHeader: import("vue").ComputedRef<string | import("vue").Slot<any> | undefined>;
+    NeonHeaderLevel: typeof NeonHeaderLevel;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The page title */
+    title: {
+        type: StringConstructor;
+    };
+    /** The page subtitle */
+    subtitle: {
+        type: StringConstructor;
+    };
+    /**
+     * Breadcrumbs to display above the header.
+     */
+    breadcrumbs: {
+        type: () => NeonBreadcrumbLink[];
+        default: () => never[];
+    };
+    /**
+     * Whether to display a back button.
+     */
+    backButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Override the label for the back button.
+     */
+    backLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Sticky button support on mobile */
+    stickyButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    breadcrumbs: NeonBreadcrumbLink[];
+    backButton: boolean;
+    backLabel: string;
+    stickyButtons: boolean;
+}, {}, {
+    NeonHeader: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+        title: {
+            type: StringConstructor;
+            required: true;
+        };
+        subtitle: {
+            type: StringConstructor;
+        };
+        level: {
+            type: () => NeonHeaderLevel;
+            default: () => NeonHeaderLevel;
+        };
+        breadcrumbs: {
+            type: () => NeonBreadcrumbLink[];
+            default: () => never[];
+        };
+        backButton: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        backLabel: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>, {
+        titleLevel: import("vue").ComputedRef<string>;
+        NeonHeaderLevel: typeof NeonHeaderLevel;
+        slots: Readonly<{
+            [name: string]: import("vue").Slot<any> | undefined;
+        }>;
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+        title: {
+            type: StringConstructor;
+            required: true;
+        };
+        subtitle: {
+            type: StringConstructor;
+        };
+        level: {
+            type: () => NeonHeaderLevel;
+            default: () => NeonHeaderLevel;
+        };
+        breadcrumbs: {
+            type: () => NeonBreadcrumbLink[];
+            default: () => never[];
+        };
+        backButton: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        backLabel: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & Readonly<{}>, {
+        breadcrumbs: NeonBreadcrumbLink[];
+        level: NeonHeaderLevel;
+        backButton: boolean;
+        backLabel: string;
+    }, {}, {
+        NeonBreadcrumbs: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+            breadcrumbs: {
+                type: () => NeonBreadcrumbLink[];
+                default: () => never[];
+            };
+            backButton: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            backLabel: {
+                type: StringConstructor;
+                default: string;
+            };
+            responsiveStyle: {
+                type: () => import("../../../neon").NeonBreadcrumbResponsiveStyle;
+                default: import("../../../neon").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<{
+            breadcrumbs: {
+                type: () => NeonBreadcrumbLink[];
+                default: () => never[];
+            };
+            backButton: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            backLabel: {
+                type: StringConstructor;
+                default: string;
+            };
+            responsiveStyle: {
+                type: () => import("../../../neon").NeonBreadcrumbResponsiveStyle;
+                default: import("../../../neon").NeonBreadcrumbResponsiveStyle;
+            };
+        }>> & Readonly<{}>, {
+            breadcrumbs: NeonBreadcrumbLink[];
+            backButton: boolean;
+            backLabel: string;
+            responsiveStyle: import("../../../neon").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>;
+        NeonInline: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+            gap: {
+                type: () => import("../../../neon").NeonLayoutSize; /** The page title */
+                default: () => import("../../../neon").NeonLayoutSize;
+            };
+            breakpoint: {
+                type: () => import("../../../neon").NeonResponsive;
+            };
+        }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+            gap: {
+                type: () => import("../../../neon").NeonLayoutSize; /** The page title */
+                default: () => import("../../../neon").NeonLayoutSize;
+            };
+            breakpoint: {
+                type: () => import("../../../neon").NeonResponsive;
+            };
+        }>> & Readonly<{}>, {
+            gap: import("../../../neon").NeonLayoutSize;
+        }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+        NeonStack: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+            gap: {
+                type: () => import("../../../neon").NeonLayoutSize;
+                default: () => import("../../../neon").NeonLayoutSize;
+            };
+        }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+            gap: {
+                type: () => import("../../../neon").NeonLayoutSize;
+                default: () => import("../../../neon").NeonLayoutSize;
+            };
+        }>> & Readonly<{}>, {
+            gap: import("../../../neon").NeonLayoutSize;
+        }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+    }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/src/components/layout/basic-layout/NeonBasicLayout.vue.d.ts

@@ -0,0 +1,2 @@
+export * from './NeonBasicLayout.js';
+export { default } from './NeonBasicLayout.js';