@bitrix24/b24ui-nuxt/dist/unplugin.d.mts

Bitrix24 UI-Kit for developing web applications REST API for NUXT & VUE

import * as unplugin from 'unplugin';
import { Options } from 'unplugin-auto-import/types';
import { Options as Options$1 } from 'unplugin-vue-components/types';
import * as b24ui from '#build/b24ui';
import { ModuleOptions } from './module.mjs';
import { TVConfig } from '../dist/runtime/types/tv.js';
import { ColorModeType, ColorModeTypeLight } from '../dist/runtime/types/index.js';
import '@nuxt/schema';

type AppConfigB24UI = {
    prefix?: string;
} & TVConfig<typeof b24ui>;
interface Bitrix24UIOptions extends Omit<ModuleOptions, 'colorMode' | 'content' | 'experimental'> {
    /** Whether to generate declaration files for auto-imported components. */
    dts?: boolean;
    b24ui?: AppConfigB24UI;
    /**
     * Enable or disable `@vueuse/core` color-mode integration
     * @defaultValue `true`
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/vue/#colormode
     */
    colorMode?: boolean;
    colorModeInitialValue?: ColorModeType;
    colorModeTypeLight?: ColorModeTypeLight;
    /**
     * Key to persist the data into localStorage/sessionStorage.
     * Pass `null` to disable persistence
     * @defaultValue 'vueuse-color-scheme'
     */
    colorModeStorageKey?: string | null;
    /**
     * Override options for `unplugin-auto-import`, or `false` to disable composable auto-imports
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/vue/#autoimport
     */
    autoImport?: false | Partial<Options>;
    /**
     * Override options for `unplugin-vue-components`, or `false` to disable component auto-imports
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/vue/#components
     */
    components?: false | Partial<Options$1>;
    /**
     * Router integration mode
     * - `true` (default): Use vue-router integration
     * - `false`: Disable routing, use anchor tags
     * - `'inertia'`: Use Inertia.js compatibility layer
     * @defaultValue `true`
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/vue/#router
     */
    router?: boolean | 'inertia';
    /**
     * Enables compatibility layer for InertiaJS
     * @deprecated Use `router: 'inertia'` instead
     */
    inertia?: boolean;
    /**
     * Additional packages to scan for components using Nuxt UI
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/vue/#scanpackages
     */
    scanPackages?: string[];
    /**
     * Root directory where the `.b24ui-nuxt` directory (generated theme templates) is created.
     * Useful for setups like `electron-vite` where `config.root` points to a sub-directory
     * (e.g. `src/renderer`) that Tailwind doesn't scan.
     * @defaultValue `config.root`
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/vue/#root
     */
    root?: string;
}
declare const runtimeDir: string;
declare const Bitrix24UIPlugin: unplugin.UnpluginInstance<Bitrix24UIOptions | undefined, boolean>;

export { Bitrix24UIPlugin, runtimeDir };
export type { Bitrix24UIOptions };