@agnos-ui/core-bootstrap/components/select/select.d.ts

Styles and component interface extensions necessary to use AgnosUI with Bootstrap.

import type { ItemContext, SelectApi, SelectDirectives, SelectProps as CoreProps, SelectState as CoreState } from '@agnos-ui/core/components/select';
import type { PropsConfig, SlotContent, Widget, WidgetSlotContext } from '@agnos-ui/core/types';
export * from '@agnos-ui/core/components/select';
/**
 * Interface for the slot context of the pagination widget
 * @template Item - The type of the items in the Select component.
 */
export interface SelectContext<Item> extends WidgetSlotContext<SelectWidget<Item>> {
}
/**
 * Represents the context for a select item, extending the base `SelectContext` with additional
 * contextual data specific to an item.
 *
 * @template Item - The type of the item within the select context.
 */
export interface SelectItemContext<Item> extends SelectContext<Item> {
    /**
     * Contextual data related to an item
     */
    itemContext: ItemContext<Item>;
}
interface SelectExtraProps<Item> {
    /**
     * The template to override the way each badge on the left of the input is displayed.
     * This define the content of the badge inside the badge container.
     *
     * @defaultValue
     * ```ts
     * ({itemContext}: SelectItemContext<any>) => itemContext.item
     * ```
     */
    badgeLabel: SlotContent<SelectItemContext<Item>>;
    /**
     * The template to override the way each item is displayed in the list.
     * This define the content of the badge inside the badge container.
     *
     * @defaultValue
     * ```ts
     * ({itemContext}: SelectItemContext<any>) => itemContext.item
     * ```
     */
    itemLabel: SlotContent<SelectItemContext<Item>>;
}
/**
 * Represents the state of a Select component.
 *
 * @template Item - The type of the items in the select component.
 */
export interface SelectState<Item> extends CoreState<Item>, SelectExtraProps<Item> {
}
/**
 * Represents the properties for the Select component.
 *
 * @template Item - The type of the items in the select component.
 */
export interface SelectProps<Item> extends CoreProps<Item>, SelectExtraProps<Item> {
}
/**
 * Represents a Select widget component.
 *
 * @template Item - The type of the items that the select widget will handle.
 */
export type SelectWidget<Item> = Widget<SelectProps<Item>, SelectState<Item>, SelectApi<Item>, SelectDirectives<Item>>;
/**
 * Retrieve a shallow copy of the default Select config
 * @returns the default Select config
 */
export declare function getSelectDefaultConfig(): SelectProps<any>;
/**
 * Creates a new select widget instance.
 * @param config - config of the modal, either as a store or as an object containing values or stores.
 * @returns a new select widget instance
 */
export declare const createSelect: <Item>(config?: PropsConfig<SelectProps<Item>>) => SelectWidget<Item>;