buefy/src/utils/vue-augmentation.ts

Lightweight UI components for Vue.js (v3) based on Bulma

// Resulting `vue-augmentation.d.ts` file of this file must be appended to
// `buefy.d.ts` after its generation, because `api-extractor` won't include the
// module augmentation in the rolled up output.
// https://github.com/microsoft/rushstack/issues/1709

// KEEP a SINGLE IMPORT statement in a SINGLE LINE,
// otherwise the post processing will be messed up.
import 'vue'

import type { DialogProgrammatic } from '../components/dialog'
import type { LoadingProgrammatic } from '../components/loading'
import type { ModalProgrammatic } from '../components/modal'
import type { NotificationProgrammatic } from '../components/notification'
import type { SnackbarProgrammatic } from '../components/snackbar'
import type { ToastProgrammatic } from '../components/toast'
import ConfigComponent from './ConfigComponent'

// Augments the global property with `$buefy`.
// https://vuejs.org/guide/typescript/options-api.html#augmenting-global-properties
declare module 'vue' {
    /* @public */
    interface ComponentCustomProperties {
        /* Global Buefy API. */
        $buefy: {
            config: typeof ConfigComponent,
            globalNoticeInterval?: ReturnType<typeof setTimeout>,
            dialog: DialogProgrammatic,
            loading: LoadingProgrammatic,
            modal: ModalProgrammatic,
            notification: NotificationProgrammatic,
            snackbar: SnackbarProgrammatic,
            toast: ToastProgrammatic
        }
    }
}