ziko/src/hooks/use-title.d.ts

A versatile JavaScript library offering a rich set of Hyperscript Based UI components, advanced mathematical utilities, interactivity ,animations, client side routing and more ...

export declare class UseTitle {
    /**
     * Create a reactive title manager.
     * @param title Initial title. Defaults to `document.title`.
     * @param withEmitter Whether to create an internal event emitter. Default: true.
     */
    constructor(title?: string, withEmitter?: boolean);

    /**
     * Enables the internal event emitter.
     */
    useEventEmitter(): this;

    /**
     * Sets the document title.
     * Emits "ziko:title-changed" if emitter is enabled.
     */
    setTitle(title: string): this;

    /**
     * Returns the current document title.
     */
    readonly current: string;

    /**
     * Listen for title changes.
     */
    onChange(callback: (title: string) => void): this;

    /**
     * To Do 
     * Disable or remove the internal event emitter entirely.
     */
    removeEventEmitter(): this;
}

export declare const useTitle: (title?: string, withEmitter?: boolean) => UseTitle;