maz-ui/nuxt/index.d.mts

A standalone components library for Vue.Js 3 & Nuxt.Js 3

import * as _nuxt_schema from '@nuxt/schema';
import { AosOptions, ToasterOptions, DialogOptions, ThemeHandlerOptions, vLazyImgOptions, vTooltipOptions } from 'maz-ui';

interface MazUiNuxtOptions {
    /**
     * Prefix for composables
     * @description This prefix will be added after `use` keyword
     * @example `autoImportPrefix: 'Maz'` will generate `useMazToast` composable instead of `useToast`
     * @default ''
     */
    autoImportPrefix?: string;
    /**
     * Enable auto-import of main css file
     * @default true
     */
    injectCss?: boolean;
    /**
     * Install aos plugin and enable auto-import of useAos composable
     * @default true
     */
    injectAos?: boolean | (Omit<AosOptions, 'router'> & {
        /**
         * Auto inject aos CSS file
         * @default true
         */
        injectCss?: boolean;
        /**
         * Set `true` to re-run animations on page change
         * @default false
         */
        router?: boolean;
    });
    /**
     * Install toaster plugin and enable auto-import of useToast composable
     * @default true
     */
    injectUseToast?: boolean | ToasterOptions;
    /**
     * Install dialog plugin and enable auto-import of useToast composable
     * @default true
     */
    injectUseDialog?: boolean | DialogOptions;
    /**
     * Install wait plugin and enable auto-import of useWait composable
     * @default true
     */
    injectUseWait?: boolean;
    /**
     * Enable auto-import of useSwipe composable
     * @default true
     */
    injectUseSwiper?: boolean;
    /**
     * Enable auto-import of useThemeHandler composable
     * @default true
     */
    injectUseThemeHandler?: boolean | ThemeHandlerOptions;
    /**
     * Enable auto-import of useIdleTimeout composable
     * @default true
     */
    injectUseIdleTimeout?: boolean;
    /**
     * Enable auto-import of useUserVisibility composable
     * @default true
     */
    injectUseUserVisibility?: boolean;
    /**
     * Enable auto-import of useTimer composable
     * @default true
     */
    injectUseTimer?: boolean;
    /**
     * Enable auto-import of useWindowSize composable
     * @default true
     */
    injectUseWindowSize?: boolean;
    /**
     * Enable auto-import of useBreakpoints composable
     * @default true
     */
    injectUseBreakpoints?: boolean;
    /**
     * Enable auto-import of useReadingTime composable
     * @default true
     */
    injectUseReadingTime?: boolean;
    /**
     * Enable auto-import of useStringMatching composable
     * @default true
     */
    injectUseStringMatching?: boolean;
    /**
     * Enable auto-import of useFormValidator and useFormField composables
     * @default true
     */
    injectUseFormValidator?: boolean;
    /**
     * Enable auto-import of useLanguageDisplayNames composable
     * @default true
     */
    injectUseLanguageDisplayNames?: boolean;
    /**
     * Globally install of v-zoom-img directive
     * @default true
     */
    installVZoomImg?: boolean;
    /**
     * Globally install of v-click-outside directive
     * @default true
     */
    installVClickOutside?: boolean;
    /**
     * Globally install of v-fullscreen-img directive
     * @default true
     */
    installVFullscreenImg?: boolean;
    /**
     * Globally install of v-lazy-img directive
     * @default true
     */
    installVLazyImg?: boolean | vLazyImgOptions;
    /**
     * Globally install of v-tooltip directive
     * @default true
     */
    installVTooltip?: boolean | vTooltipOptions;
    /**
     * Enable auto-import of all components
     * @default true
     */
    injectComponents?: boolean;
    /**
     * Default path to public svg icons folder for `<MazIcon />` component
     * @default ''
     */
    defaultMazIconPath?: string;
    /**
     * Enable Nuxt Devtools integration
     * @default true
     */
    devtools?: boolean;
}
declare module '@nuxt/schema' {
    interface NuxtConfig {
        mazUi?: MazUiNuxtOptions;
    }
    interface NuxtOptions {
        mazUi: MazUiNuxtOptions;
    }
    interface PublicRuntimeConfig {
        mazUi: MazUiNuxtOptions;
    }
}
declare const _default: _nuxt_schema.NuxtModule<MazUiNuxtOptions, MazUiNuxtOptions, false>;

export { type MazUiNuxtOptions, _default as default };