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

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

import type { TreeProps as CoreProps, TreeState as CoreState, TreeApi, TreeDirectives, NormalizedTreeItem } from '@agnos-ui/core/components/tree';
import type { SlotContent, Widget, WidgetFactory, WidgetSlotContext } from '@agnos-ui/core/types';
export * from '@agnos-ui/core/components/tree';
/**
 * Represents the context for a Tree widget.
 * This interface is an alias for `WidgetSlotContext<TreeWidget>`.
 */
export type TreeContext = WidgetSlotContext<TreeWidget>;
/**
 * Represents the context for a tree item, extending the base `TreeContext`
 * with an additional `item` property.
 */
export type TreeSlotItemContext = TreeContext & {
    item: NormalizedTreeItem;
};
interface TreeExtraProps {
    /**
     * Slot to change the default display of the tree
     */
    structure: SlotContent<TreeContext>;
    /**
     * Slot to change the default tree item
     */
    item: SlotContent<TreeSlotItemContext>;
    /**
     * Slot to change the default tree item content
     */
    itemContent: SlotContent<TreeSlotItemContext>;
    /**
     * Slot to change the default tree item toggle
     */
    itemToggle: SlotContent<TreeSlotItemContext>;
}
/**
 * Represents the state of a Tree component.
 */
export interface TreeState extends CoreState, TreeExtraProps {
}
/**
 * Represents the properties for the Tree component.
 */
export interface TreeProps extends CoreProps, TreeExtraProps {
}
/**
 * Represents a Tree widget component.
 */
export type TreeWidget = Widget<TreeProps, TreeState, TreeApi, TreeDirectives>;
/**
 * Retrieve a shallow copy of the default Tree config
 * @returns the default Tree config
 */
export declare function getTreeDefaultConfig(): TreeProps;
/**
 * Create a Tree with given config props
 * @param config - an optional tree config
 * @returns a TreeWidget
 */
export declare const createTree: WidgetFactory<TreeWidget>;