@userfrosting/sprinkle-core
Version:
Core Sprinkle for UserFrosting
52 lines (51 loc) • 1.67 kB
TypeScript
/**
* Page Meta Composable
*
* Handles the page meta data such as title, description, plus generate
* breadcrumbs from the frontend router. The title, description and breadcrumbs
* are updated automatically when the route changes.
*
* Available States : breadcrumbs, title, description
*/
export declare const usePageMeta: import('pinia').StoreDefinition<"pageMeta", Pick<{
breadcrumbs: import('vue').Ref<{
label: string;
to: string;
}[], Breadcrumb[] | {
label: string;
to: string;
}[]>;
title: import('vue').Ref<string, string>;
description: import('vue').Ref<string, string>;
hideBreadcrumbs: import('vue').Ref<boolean, boolean>;
hideTitle: import('vue').Ref<boolean, boolean>;
}, "breadcrumbs" | "title" | "description" | "hideBreadcrumbs" | "hideTitle">, Pick<{
breadcrumbs: import('vue').Ref<{
label: string;
to: string;
}[], Breadcrumb[] | {
label: string;
to: string;
}[]>;
title: import('vue').Ref<string, string>;
description: import('vue').Ref<string, string>;
hideBreadcrumbs: import('vue').Ref<boolean, boolean>;
hideTitle: import('vue').Ref<boolean, boolean>;
}, never>, Pick<{
breadcrumbs: import('vue').Ref<{
label: string;
to: string;
}[], Breadcrumb[] | {
label: string;
to: string;
}[]>;
title: import('vue').Ref<string, string>;
description: import('vue').Ref<string, string>;
hideBreadcrumbs: import('vue').Ref<boolean, boolean>;
hideTitle: import('vue').Ref<boolean, boolean>;
}, never>>;
interface Breadcrumb {
label: string;
to: string;
}
export {};