@bitrix24/b24ui-nuxt/dist/runtime/components/Slideover.vue.d.ts

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

import type { DialogRootProps, DialogRootEmits, DialogContentProps, DialogContentEmits } from 'reka-ui';
import type { AppConfig } from '@nuxt/schema';
import theme from '#build/b24ui/slideover';
import type { ButtonProps, IconComponent } from '../types';
import type { EmitsToProps, ComponentConfig } from '../types/utils';
type Slideover = ComponentConfig<typeof theme, AppConfig, 'slideover'>;
export interface SlideoverProps extends DialogRootProps {
    title?: string;
    description?: string;
    /**
     * The content of the slideover
     */
    content?: Omit<DialogContentProps, 'as' | 'asChild' | 'forceMount'> & Partial<EmitsToProps<DialogContentEmits>>;
    /**
     * Render an overlay behind the slideover.
     * @defaultValue true
     */
    overlay?: boolean;
    /**
     * Render an overlay blur behind the slideover.
     * `auto` use `motion-safe`.
     * @defaultValue 'auto'
     */
    overlayBlur?: Slideover['variants']['overlayBlur'];
    /**
     * Animate the slideover when opening or closing.
     * @defaultValue true
     */
    transition?: boolean;
    /**
     * The side of the slideover.
     * @defaultValue 'right'
     */
    side?: Slideover['variants']['side'];
    /**
     * Render the slideover in a portal.
     * @defaultValue true
     */
    portal?: boolean | string | HTMLElement;
    /**
     * Display a close button to dismiss the slideover.
     * `{ color: 'primary' }`{lang="ts"} for `left`, `right`
     * `{ color: 'link' }`{lang="ts"} for `top`, `bottom`
     * @defaultValue true
     */
    close?: boolean | Partial<ButtonProps>;
    /**
     * The icon displayed in the close button.
     * @defaultValue icons.close
     * @IconifyIcon
     */
    closeIcon?: IconComponent;
    /**
     * When `false`, the slideover will not close when clicking outside or pressing escape.
     * @defaultValue false
     */
    dismissible?: boolean;
    /**
     * @defaultValue true
     */
    scrollbarThin?: boolean;
    class?: any;
    b24ui?: Slideover['slots'];
}
export interface SlideoverEmits extends DialogRootEmits {
    'after:leave': [];
    'after:enter': [];
    'close:prevent': [];
}
export interface SlideoverSlots {
    default(props: {
        open: boolean;
    }): any;
    content(props: {
        close: () => void;
    }): any;
    header(props: {
        close: () => void;
    }): any;
    title(props?: {}): any;
    description(props?: {}): any;
    actions(props?: {}): any;
    close(props: {
        close: () => void;
        b24ui: {
            [K in keyof Required<Slideover['slots']>]: (props?: Record<string, any>) => string;
        };
    }): any;
    body(props: {
        close: () => void;
    }): any;
    footer(props: {
        close: () => void;
    }): any;
}
declare const _default: __VLS_WithSlots<import("vue").DefineComponent<SlideoverProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
    "update:open": (value: boolean) => any;
    "after:leave": () => any;
    "after:enter": () => any;
    "close:prevent": () => any;
}, string, import("vue").PublicProps, Readonly<SlideoverProps> & Readonly<{
    "onUpdate:open"?: ((value: boolean) => any) | undefined;
    "onAfter:leave"?: (() => any) | undefined;
    "onAfter:enter"?: (() => any) | undefined;
    "onClose:prevent"?: (() => any) | undefined;
}>, {
    close: boolean | Partial<ButtonProps>;
    modal: boolean;
    portal: boolean | string | HTMLElement;
    overlay: boolean;
    side: Slideover["variants"]["side"];
    overlayBlur: Slideover["variants"]["overlayBlur"];
    transition: boolean;
    dismissible: boolean;
    scrollbarThin: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, SlideoverSlots>;
export default _default;
type __VLS_WithSlots<T, S> = T & {
    new (): {
        $slots: S;
    };
};