usePageHeader

Stores shared page header state for title and icon. Passing a config updates the shared refs and can update document.title, making it useful for route-level page setup.

Importing

import { usePageHeader } from '@almighty-shogun/vue-utils'

Usage

import { usePageHeader } from '@almighty-shogun/vue-utils'

const header = usePageHeader({
    title: 'Users',
    icon: 'users',
    page: 'Users - Dashboard'
});

Parameters

Name	Type	Description
config	HeaderData	Optional header data.

Returns

Name	Type	Description
pageTitle	Ref<string>	Shared title value for the current page header.
pageIcon	Ref<FluxIconName>	Shared icon name for the current page header.

Type signature

declare function usePageHeader(config?: HeaderData): UsePageHeader;

type HeaderData = {
    title: string;
    icon: FluxIconName;
    page?: string;
};

type UsePageHeader = {
    readonly pageTitle: Ref<string>;
    readonly pageIcon: Ref<FluxIconName>;
};