nuxt/dist/app/composables/route-announcer.d.ts

Nuxt is a free and open-source framework with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with Vue.js.

import type { Ref } from 'vue';
export type Politeness = 'assertive' | 'polite' | 'off';
export type NuxtRouteAnnouncerOpts = {
    /** @default 'polite' */
    politeness?: Politeness;
};
export type RouteAnnouncer = {
    message: Ref<string>;
    politeness: Ref<Politeness>;
    set: (message: string, politeness: Politeness) => void;
    polite: (message: string) => void;
    assertive: (message: string) => void;
    _cleanup: () => void;
};
/**
 * composable to handle the route announcer
 * @since 3.12.0
 */
export declare function useRouteAnnouncer(opts?: Partial<NuxtRouteAnnouncerOpts>): Omit<RouteAnnouncer, '_cleanup'>;