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

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

import type { VariantProps } from 'tailwind-variants';
import type { AvatarProps, ButtonProps, IconComponent } from '../types';
import type { DynamicSlots } from '../types/utils';
declare const descriptionList: import("tailwind-variants").TVReturnType<{
    size: {
        sm: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
        md: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
    };
    orientation: {
        horizontal: {
            descriptionWrapper: string;
            actions: string;
        };
        vertical: {
            descriptionWrapper: string;
            actions: string;
        };
    };
    title: {
        true: {
            description: string;
        };
    };
}, {
    root: string;
    legend: string;
    text: string;
    container: string;
    labelWrapper: string;
    icon: string;
    avatar: string;
    avatarSize: string;
    label: string;
    descriptionWrapper: string;
    description: string;
    actions: string;
    footer: string;
}, undefined, {
    size: {
        sm: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
        md: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
    };
    orientation: {
        horizontal: {
            descriptionWrapper: string;
            actions: string;
        };
        vertical: {
            descriptionWrapper: string;
            actions: string;
        };
    };
    title: {
        true: {
            description: string;
        };
    };
}, {
    root: string;
    legend: string;
    text: string;
    container: string;
    labelWrapper: string;
    icon: string;
    avatar: string;
    avatarSize: string;
    label: string;
    descriptionWrapper: string;
    description: string;
    actions: string;
    footer: string;
}, import("tailwind-variants").TVReturnType<{
    size: {
        sm: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
        md: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
    };
    orientation: {
        horizontal: {
            descriptionWrapper: string;
            actions: string;
        };
        vertical: {
            descriptionWrapper: string;
            actions: string;
        };
    };
    title: {
        true: {
            description: string;
        };
    };
}, {
    root: string;
    legend: string;
    text: string;
    container: string;
    labelWrapper: string;
    icon: string;
    avatar: string;
    avatarSize: string;
    label: string;
    descriptionWrapper: string;
    description: string;
    actions: string;
    footer: string;
}, undefined, {
    size: {
        sm: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
        md: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
    };
    orientation: {
        horizontal: {
            descriptionWrapper: string;
            actions: string;
        };
        vertical: {
            descriptionWrapper: string;
            actions: string;
        };
    };
    title: {
        true: {
            description: string;
        };
    };
}, {
    root: string;
    legend: string;
    text: string;
    container: string;
    labelWrapper: string;
    icon: string;
    avatar: string;
    avatarSize: string;
    label: string;
    descriptionWrapper: string;
    description: string;
    actions: string;
    footer: string;
}, import("tailwind-variants").TVReturnType<{
    size: {
        sm: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
        md: {
            legend: string;
            text: string;
            container: string;
            labelWrapper: string;
            avatarSize: string;
            label: string;
            descriptionWrapper: string;
            description: string;
            footer: string;
        };
    };
    orientation: {
        horizontal: {
            descriptionWrapper: string;
            actions: string;
        };
        vertical: {
            descriptionWrapper: string;
            actions: string;
        };
    };
    title: {
        true: {
            description: string;
        };
    };
}, {
    root: string;
    legend: string;
    text: string;
    container: string;
    labelWrapper: string;
    icon: string;
    avatar: string;
    avatarSize: string;
    label: string;
    descriptionWrapper: string;
    description: string;
    actions: string;
    footer: string;
}, undefined, unknown, unknown, undefined>>>;
type DescriptionListVariants = VariantProps<typeof descriptionList>;
export interface DescriptionListItem {
    label?: string;
    /**
     * Display an icon on the left side.
     * @IconComponent
     */
    icon?: IconComponent;
    avatar?: AvatarProps;
    slot?: string;
    description?: string;
    /**
     * The orientation between the content and the actions.
     * @defaultValue 'vertical'
     */
    orientation?: DescriptionListVariants['orientation'];
    /**
     * Display a list of actions:
     * - under the description when orientation is `vertical`
     * - next to the description when orientation is `horizontal`
     * `{ size: 'xs' }`{lang="ts"}
     */
    actions?: ButtonProps[];
    class?: any;
    b24ui?: Partial<typeof descriptionList.slots>;
    [key: string]: any;
}
export interface DescriptionListProps<T extends DescriptionListItem = DescriptionListItem> {
    legend?: string;
    text?: string;
    /**
     * The key used to get the label from the item.
     * @defaultValue 'label'
     */
    labelKey?: string;
    /**
     * The key used to get the description from the item.
     * @defaultValue 'description'
     */
    descriptionKey?: string;
    items?: T[];
    /**
     * @defaultValue 'md'
     */
    size?: DescriptionListVariants['size'];
    class?: any;
    b24ui?: Partial<typeof descriptionList.slots>;
}
type SlotProps<T extends DescriptionListItem> = (props: {
    item: T;
    index: number;
}) => any;
export type DescriptionListSlots<T extends DescriptionListItem = DescriptionListItem> = {
    legend(props?: {}): any;
    text(props?: {}): any;
    leading: SlotProps<T>;
    label: SlotProps<T>;
    description: SlotProps<T>;
    actions: SlotProps<T>;
    content: SlotProps<T>;
    footer(props?: {
        b24ui: any;
    }): any;
} & DynamicSlots<T, undefined, {
    index: number;
}>;
declare const _default: <T extends DescriptionListItem>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, never> & DescriptionListProps<T> & Partial<{}>> & (import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps);
    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
    attrs: any;
    slots: Readonly<{
        legend(props?: {}): any;
        text(props?: {}): any;
        leading: SlotProps<T>;
        label: SlotProps<T>;
        description: SlotProps<T>;
        actions: SlotProps<T>;
        content: SlotProps<T>;
        footer(props?: {
            b24ui: any;
        }): any;
    } & DynamicSlots<T, undefined, {
        index: number;
    }>> & {
        legend(props?: {}): any;
        text(props?: {}): any;
        leading: SlotProps<T>;
        label: SlotProps<T>;
        description: SlotProps<T>;
        actions: SlotProps<T>;
        content: SlotProps<T>;
        footer(props?: {
            b24ui: any;
        }): any;
    } & DynamicSlots<T, undefined, {
        index: number;
    }>;
    emit: {};
}>) => import("vue").VNode & {
    __ctx?: Awaited<typeof __VLS_setup>;
};
export default _default;
type __VLS_PrettifyLocal<T> = {
    [K in keyof T]: T[K];
} & {};