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

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

import * as _nuxt_schema from '@nuxt/schema';
import { HookResult } from '@nuxt/schema';
import { ColorModeType, ColorModeTypeLight } from '../dist/runtime/types/index.js';
export * from '../dist/runtime/types/index.js';

type Color = 'air-primary' | 'air-secondary' | 'air-tertiary' | 'air-primary-success' | 'air-primary-warning' | 'air-primary-alert' | 'air-primary-copilot' | 'air-secondary-accent' | 'air-secondary-accent-1' | (string & {});
type Size = 'xss' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | (string & {});
interface ModuleOptions {
    /**
     * Enable or disable `@vueuse/core` color-mode module
     * @memo We not use `@nuxtjs/color-mode`
     * @defaultValue `true`
     * @link https://bitrix24.github.io/b24ui/docs/getting-started/installation/nuxt/#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;
    version?: string;
    /**
     * Customize how the theme is generated
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/theme/design-system/
     */
    theme?: {
        /**
         * The default variants to use for components
         * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/nuxt/#themedefaultvariants
         */
        defaultVariants?: {
            /**
             * The default color variant to use for components
             * @defaultValue `'primary'`
             */
            color?: Color;
            /**
             * The default size variant to use for components
             * @defaultValue `'md'`
             */
            size?: Size;
        };
        /**
         * Prefix for Tailwind CSS utility classes
         * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/nuxt/#themeprefix
         * @example 'tw'
         */
        prefix?: string;
    };
    /**
     * Force the import of prose components even if `@nuxtjs/mdc` or `@nuxt/content` are not installed
     * @defaultValue true
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/nuxt/#prose
     */
    prose?: boolean;
    /**
     * @deprecated Use `prose` instead
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/nuxt/#mdc
     */
    mdc?: boolean;
    /**
     * Force the import of content & prose components even if `@nuxt/content` is not installed
     * @defaultValue false
     * @see https://bitrix24.github.io/b24ui/docs/getting-started/installation/nuxt/#content
     */
    content?: boolean;
    /**
     * Experimental features
     */
    experimental?: {
        /**
         * Enable automatic component detection for tree-shaking
         * Only generates theme files for components actually used in your app
         * - `true`: Enable automatic detection
         * - `string[]`: Enable detection and include additional components (useful for dynamic components)
         * @defaultValue false
         * @example true
         * @example ['Modal', 'Dropdown']
         */
        componentDetection?: boolean | string[];
    };
}
declare module '#app' {
    interface RuntimeNuxtHooks {
        'dashboard:search:toggle': () => HookResult;
        'dashboard:sidebar:toggle': () => HookResult;
        'dashboard:sidebar:collapse': (value: boolean) => HookResult;
    }
}
declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;

export { _default as default };
export type { ModuleOptions };