primevue/sidebarrail/index.d.ts

PrimeVue is a premium UI library for Vue featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock, wh

/**
 *
 * SidebarRail component - part of the headless Sidebar compound component family.
 *
 * @module sidebarrail
 *
 */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough';
import { VNode } from 'vue';

export declare type SidebarRailPassThroughOptionType = SidebarRailPassThroughAttributes | ((options: SidebarRailPassThroughMethodOptions) => SidebarRailPassThroughAttributes | string) | string | null | undefined;

/**
 * Custom passthrough(pt) option method.
 */
export interface SidebarRailPassThroughMethodOptions {
    /**
     * Defines instance.
     */
    instance: any;
    /**
     * Defines valid properties.
     */
    props: SidebarRailProps;
    /**
     * Defines valid attributes.
     */
    attrs: any;
    /**
     * Defines parent options.
     */
    parent: any;
    /**
     * Defines passthrough(pt) options in global config.
     */
    global: object | undefined;
}

/**
 * Custom passthrough(pt) options.
 * @see {@link SidebarRailProps.pt}
 */
export interface SidebarRailPassThroughOptions {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: SidebarRailPassThroughOptionType;
    /**
     * Used to manage all lifecycle hooks.
     * @see {@link BaseComponent.ComponentHooks}
     */
    hooks?: ComponentHooks;
}

/**
 * Custom passthrough attributes for each DOM elements.
 */
export interface SidebarRailPassThroughAttributes {
    [key: string]: any;
}

/**
 * Defines valid properties in SidebarRail component.
 */
export interface SidebarRailProps {
    /**
     * The element or component to render. Defaults to a sensible HTML element.
     */
    as?: string | object;
    /**
     * When true, renders the slot content as the root element with merged props.
     * @defaultValue false
     */
    asChild?: boolean;
    /**
     * It generates scoped CSS variables using design tokens for the component.
     */
    dt?: DesignToken<any>;
    /**
     * Used to pass attributes to DOM elements inside the component.
     * @type {SidebarRailPassThroughOptions}
     */
    pt?: PassThrough<SidebarRailPassThroughOptions>;
    /**
     * Used to configure passthrough(pt) options of the component.
     * @type {PassThroughOptions}
     */
    ptOptions?: PassThroughOptions;
    /**
     * When enabled, it removes component related styles in the core.
     * @defaultValue false
     */
    unstyled?: boolean;
}

/**
 * Defines valid slots in SidebarRail component.
 */
export interface SidebarRailSlots {
    /**
     * Default slot.
     *
     * The `scope` argument is only provided when `asChild` is `true`. In that mode the
     * consumer must spread `a11yAttrs`, apply `class` and wire `onClick` on the rendered root.
     * @param {Object} scope - default slot's params.
     */
    default(scope?: {
        /**
         * Class name of the root element.
         */
        class: string;
        /**
         * Accessibility data attributes to spread on the rendered root.
         */
        a11yAttrs: Record<string, any>;
        /**
         * Click handler that toggles the inherited Sidebar.
         * @param {Event} event - Browser event.
         */
        onClick: (event: Event) => void;
    }): VNode[];
}

/**
 * Defines valid emits in SidebarRail component.
 */
export interface SidebarRailEmitsOptions {}

export declare type SidebarRailEmits = EmitFn<SidebarRailEmitsOptions>;

/**
 * **PrimeVue - SidebarRail**
 *
 * _SidebarRail component - part of the headless Sidebar compound component family._
 *
 * @group Component
 *
 */
declare const SidebarRail: DefineComponent<SidebarRailProps, SidebarRailSlots, SidebarRailEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        SidebarRail: DefineComponent<SidebarRailProps, SidebarRailSlots, SidebarRailEmits>;
    }
}

export default SidebarRail;