26 lines
946 B
TypeScript
26 lines
946 B
TypeScript
/** Which part comes first in a composed title. */
|
|
export type TitleOrder = 'page-first' | 'site-first';
|
|
type ComposeTitleArgs = {
|
|
/** Defaults to 'page-first' — the page title is what a visitor scans for. */
|
|
order?: TitleOrder;
|
|
/** Page-specific title, e.g. 'About Us'. */
|
|
pageTitle?: null | string;
|
|
/** Separator between page title and site name. Defaults to ' | '. */
|
|
separator?: string;
|
|
/** Site name, e.g. 'Acme Inc'. */
|
|
siteName?: null | string;
|
|
};
|
|
/**
|
|
* Composes a full document title from a page title and the site name.
|
|
*
|
|
* - both, page-first: "About Us | Acme Inc"
|
|
* - both, site-first: "Acme Inc | About Us"
|
|
* - page only: "About Us"
|
|
* - site only: "Acme Inc"
|
|
* - neither: ""
|
|
*
|
|
* Pure function — no dependency on Payload or request state.
|
|
*/
|
|
export declare function composeTitle({ order, pageTitle, separator, siteName, }: ComposeTitleArgs): string;
|
|
export {};
|