@agnos-ui/angular-bootstrap 0.8.1 → 0.9.0-next.0

package/components/toast/toast.gen.d.ts

@@ -1,308 +0,0 @@
-import type { WidgetSlotContext, SlotContent, TransitionFn, Widget, WidgetFactory, Directive } from '@agnos-ui/angular-headless';
-/**
- * Retrieve a shallow copy of the default Toast config
- * @returns the default Toast config
- */
-declare const export_getToastDefaultConfig: () => ToastProps;
-export { export_getToastDefaultConfig as getToastDefaultConfig };
-/**
- * Represents the context for a Toast widget.
- * This interface is an alias for `WidgetSlotContext<ToastWidget>`.
- */
-export interface ToastContext extends WidgetSlotContext<ToastWidget> {
-}
-/**
- * Represents the state of a Toast component.
- */
-export interface ToastState {
-    /**
-     * Is `true` when the alert is hidden. Compared to `visible`, this is updated after the transition is executed.
-     */
-    hidden: boolean;
-    /**
-     * If `true`, alert can be dismissed by the user.
-     * The close button (×) will be displayed and you can be notified of the event with the (close) output.
-     *
-     * @defaultValue `true`
-     */
-    dismissible: boolean;
-    /**
-     * If `true` the alert is visible to the user
-     *
-     * @defaultValue `true`
-     */
-    visible: boolean;
-    /**
-     * Accessibility close button label
-     *
-     * @defaultValue `'Close'`
-     */
-    ariaCloseButtonLabel: string;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    className: string;
-    /**
-     * If `true` automatically hides the toast after the delay.
-     *
-     * @defaultValue `true`
-     */
-    autoHide: boolean;
-    /**
-     * Delay in milliseconds before hiding the toast.
-     *
-     * @defaultValue `5000`
-     */
-    delay: number;
-    /**
-     * Global template for the toast component
-     */
-    structure: SlotContent<ToastContext>;
-    /**
-     * Template for the toast content
-     */
-    children: SlotContent<ToastContext>;
-    /**
-     * Header template for the toast component
-     */
-    header: SlotContent<ToastContext>;
-}
-/**
- * Interface representing the properties for the Toast component.
- */
-export interface ToastProps {
-    /**
-     * The transition function will be executed when the alert is displayed or hidden.
-     *
-     * Depending on the value of `animatedOnInit`, the animation can be optionally skipped during the showing process.
-     *
-     * @defaultValue `fadeTransition`
-     */
-    transition: TransitionFn;
-    /**
-     * Callback called when the alert visibility changed.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onVisibleChange: (visible: boolean) => void;
-    /**
-     * Callback called when the alert is hidden.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onHidden: () => void;
-    /**
-     * Callback called when the alert is shown.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onShown: () => void;
-    /**
-     * If `true`, alert opening will be animated.
-     *
-     * Animation is triggered  when the `.open()` function is called
-     * or the visible prop is changed
-     *
-     * @defaultValue `false`
-     */
-    animatedOnInit: boolean;
-    /**
-     * If `true`, alert closing will be animated.
-     *
-     * Animation is triggered  when clicked on the close button (×),
-     * via the `.close()` function or the visible prop is changed
-     *
-     * @defaultValue `true`
-     */
-    animated: boolean;
-    /**
-     * If `true`, alert can be dismissed by the user.
-     * The close button (×) will be displayed and you can be notified of the event with the (close) output.
-     *
-     * @defaultValue `true`
-     */
-    dismissible: boolean;
-    /**
-     * If `true` the alert is visible to the user
-     *
-     * @defaultValue `true`
-     */
-    visible: boolean;
-    /**
-     * Accessibility close button label
-     *
-     * @defaultValue `'Close'`
-     */
-    ariaCloseButtonLabel: string;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    className: string;
-    /**
-     * If `true` automatically hides the toast after the delay.
-     *
-     * @defaultValue `true`
-     */
-    autoHide: boolean;
-    /**
-     * Delay in milliseconds before hiding the toast.
-     *
-     * @defaultValue `5000`
-     */
-    delay: number;
-    /**
-     * Global template for the toast component
-     */
-    structure: SlotContent<ToastContext>;
-    /**
-     * Template for the toast content
-     */
-    children: SlotContent<ToastContext>;
-    /**
-     * Header template for the toast component
-     */
-    header: SlotContent<ToastContext>;
-}
-/**
- * Represents a Toast widget component.
- */
-export type ToastWidget = Widget<ToastProps, ToastState, ToastApi, ToastDirectives>;
-/**
- * Create an ToastWidget with given config props
- * @param config - an optional alert config
- * @returns an ToastWidget
- */
-declare const export_createToast: WidgetFactory<ToastWidget>;
-export { export_createToast as createToast };
-/**
- * A mapping of toast position keys to their corresponding CSS class strings of bootstrap.
- * These classes define the positioning of toast notifications on the screen.
- *
- * The keys represent various positions on the screen, such as top-left, top-center,
- * middle-right, etc., and the values are the CSS classes of bootstrap that apply the respective
- * positioning styles.
- *
- * Example usage:
- * ```typescript
- * const positionClass = toastPositions.topLeft; // "top-0 start-0"
- * ```
- */
-declare const export_toastPositions: Record<ToastPositions, string>;
-export { export_toastPositions as toastPositions };
-/**
- * Represents the API for the toast component.
- */
-export interface ToastApi {
-    /**
-     * Triggers alert closing programmatically (same as clicking on the close button (×)).
-     */
-    close(): void;
-    /**
-     * Triggers the alert to be displayed for the user.
-     */
-    open(): void;
-}
-/**
- * Interface representing the directives for a toast component.
- */
-export interface ToastDirectives {
-    /**
-     * the transition directive, piloting what is the visual effect of going from hidden to visible
-     */
-    transitionDirective: Directive;
-    /**
-     * Directive that handles the autohide of the toast component
-     */
-    autoHideDirective: Directive;
-    /**
-     * Directive that adds all the necessary attributes to the body
-     */
-    bodyDirective: Directive;
-    /**
-     * Directive that adds all the necessary attributes to the close button depending on the presence of the header
-     */
-    closeButtonDirective: Directive;
-}
-/**
- * Represents the possible positions for displaying a toast notification.
- *
- * The positions are defined based on a grid layout with three horizontal
- * alignments (left, center, right) and three vertical alignments (top, middle, bottom).
- *
- * Available positions:
- * - `topLeft`: Top-left corner of the screen.
- * - `topCenter`: Top-center of the screen.
- * - `topRight`: Top-right corner of the screen.
- * - `middleLeft`: Middle-left side of the screen.
- * - `middleCenter`: Center of the screen.
- * - `middleRight`: Middle-right side of the screen.
- * - `bottomLeft`: Bottom-left corner of the screen.
- * - `bottomCenter`: Bottom-center of the screen.
- * - `bottomRight`: Bottom-right corner of the screen.
- */
-export type ToastPositions = 'topLeft' | 'topCenter' | 'topRight' | 'middleLeft' | 'middleCenter' | 'middleRight' | 'bottomLeft' | 'bottomCenter' | 'bottomRight';
-/**
- * Props of the toaster
- */
-export interface ToasterProps {
-    /** How much time (ms) a toast is displayed; 0 means it won't be removed until a manual action */
-    duration: number;
-    /** Where to position the toasts */
-    position: ToastPositions;
-    /** Maximum number of toasts displayed */
-    limit?: number;
-    /**  Pause toast when hover */
-    pauseOnHover?: boolean;
-    /** Display a dismiss button on each toast. When duration = 0, this is enforced to true */
-    dismissible: boolean;
-    /** Add a button to close all the toasts at once */
-    closeAll?: boolean;
-    /** Close all label */
-    closeAllLabel?: string;
-}
-/**
- * Toast object
- * @template Props Type of the toast properties.
- */
-export interface ToasterToast<Props> {
-    /** Identifier of the toasts in the toaster */
-    id: number;
-    /** Properties of the toast */
-    props: Props;
-}
-/**
- * Represents a timer used by the toaster service.
- */
-export interface ToasterTimer {
-    /**
-     * The timeout identifier returned by `setTimeout`.
-     */
-    timeout: ReturnType<typeof setTimeout> | null;
-    /**
-     * The timestamp when the timer was started.
-     */
-    started: number;
-    /**
-     * The timestamp when the timer was paused (optional).
-     */
-    paused?: number;
-    /**
-     * The duration for which the timer is set (optional). Used internally to compute the remaining time.
-     */
-    duration: number;
-}
-declare const export_defaultToasterProps: ToasterProps;
-export { export_defaultToasterProps as defaultToasterProps };

package/components/toast/toaster.component.d.ts

@@ -1,17 +0,0 @@
-import { ToasterService } from './toaster.service';
-import * as i0 from "@angular/core";
-export declare class ToasterComponent {
-    readonly toasterService: ToasterService;
-    readonly auDismissible: import("@angular/core").InputSignal<boolean>;
-    readonly auDuration: import("@angular/core").InputSignal<number>;
-    readonly auPosition: import("@angular/core").InputSignal<import("@agnos-ui/angular-headless").ToastPositions>;
-    readonly auLimit: import("@angular/core").InputSignal<number | undefined>;
-    readonly auPauseOnHover: import("@angular/core").InputSignal<boolean | undefined>;
-    readonly auCloseAll: import("@angular/core").InputSignal<boolean | undefined>;
-    readonly auCloseAllLabel: import("@angular/core").InputSignal<string | undefined>;
-    readonly positionClass: import("@angular/core").Signal<string>;
-    constructor();
-    handleHidden(toast: any): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ToasterComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ToasterComponent, "[auToaster]", never, { "auDismissible": { "alias": "auDismissible"; "required": false; "isSignal": true; }; "auDuration": { "alias": "auDuration"; "required": false; "isSignal": true; }; "auPosition": { "alias": "auPosition"; "required": false; "isSignal": true; }; "auLimit": { "alias": "auLimit"; "required": false; "isSignal": true; }; "auPauseOnHover": { "alias": "auPauseOnHover"; "required": false; "isSignal": true; }; "auCloseAll": { "alias": "auCloseAll"; "required": false; "isSignal": true; }; "auCloseAllLabel": { "alias": "auCloseAllLabel"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}

package/components/toast/toaster.service.d.ts

@@ -1,7 +0,0 @@
-import type { ToastProps } from './toast.gen';
-import { ToasterService as headlessToaster } from '@agnos-ui/angular-headless';
-import * as i0 from "@angular/core";
-export declare class ToasterService extends headlessToaster<Partial<ToastProps>> {
-    static ɵfac: i0.ɵɵFactoryDeclaration<ToasterService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ToasterService>;
-}

package/components/tree/index.d.ts

@@ -1,2 +0,0 @@
-export * from './tree.component';
-export * from './tree.gen';

package/components/tree/tree.component.d.ts

@@ -1,145 +0,0 @@
-import type { SlotContent } from '@agnos-ui/angular-headless';
-import { BaseWidgetDirective } from '@agnos-ui/angular-headless';
-import { TemplateRef } from '@angular/core';
-import type { TreeContext, TreeItem, NormalizedTreeItem, TreeSlotItemContext, TreeWidget } from './tree.gen';
-import * as i0 from "@angular/core";
-/**
- * Directive to provide a template reference for tree structure.
- *
- * This directive uses a template reference to render the {@link TreeContext}.
- */
-export declare class TreeStructureDirective {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard(_dir: TreeStructureDirective, context: unknown): context is TreeContext;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TreeStructureDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<TreeStructureDirective, "ng-template[auTreeStructure]", never, {}, {}, never, never, true, never>;
-}
-/**
- * A constant representing the default slot for tree structure.
- */
-export declare const treeDefaultSlotStructure: SlotContent<TreeContext>;
-/**
- * Directive to provide a template reference for tree item toggle.
- *
- * This directive uses a template reference to render the {@link TreeSlotItemContext}.
- */
-export declare class TreeItemToggleDirective {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard(_dir: TreeItemToggleDirective, context: unknown): context is TreeSlotItemContext;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TreeItemToggleDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<TreeItemToggleDirective, "ng-template[auTreeItemToggle]", never, {}, {}, never, never, true, never>;
-}
-/**
- * A constant representing the default slot for tree item toggle.
- */
-export declare const treeDefaultItemToggle: SlotContent<TreeSlotItemContext>;
-/**
- * Directive to provide a template reference for tree item content.
- *
- * This directive uses a template reference to render the {@link TreeSlotItemContext}.
- */
-export declare class TreeItemContentDirective {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard(_dir: TreeItemContentDirective, context: unknown): context is TreeSlotItemContext;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TreeItemContentDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<TreeItemContentDirective, "ng-template[auTreeItemContent]", never, {}, {}, never, never, true, never>;
-}
-/**
- * A constant representing the default slot for tree item.
- */
-export declare const treeDefaultSlotItemContent: SlotContent<TreeSlotItemContext>;
-/**
- * Directive to provide a template reference for tree item.
- *
- * This directive uses a template reference to render the {@link TreeSlotItemContext}.
- */
-export declare class TreeItemDirective {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard(_dir: TreeItemDirective, context: unknown): context is TreeSlotItemContext;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TreeItemDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<TreeItemDirective, "ng-template[auTreeItem]", never, {}, {}, never, never, true, never>;
-}
-/**
- * A constant representing the default slot for tree item.
- */
-export declare const treeDefaultSlotItem: SlotContent<TreeSlotItemContext>;
-/**
- * TreeComponent is an Angular component that extends the BaseWidgetDirective
- * to provide a customizable tree widget. This component allows for various
- * configurations and customizations through its inputs and outputs.
- */
-export declare class TreeComponent extends BaseWidgetDirective<TreeWidget> {
-    constructor();
-    /**
-     * Optional accessibility label for the tree if there is no explicit label
-     *
-     * @defaultValue `''`
-     */
-    readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * Array of the tree nodes to display
-     *
-     * @defaultValue `[]`
-     */
-    readonly nodes: import("@angular/core").InputSignal<TreeItem[] | undefined>;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    readonly className: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * Retrieves expand items of the TreeItem
-     *
-     * @param node - HTML element that is representing the expand item
-     *
-     * @defaultValue
-     * ```ts
-     * (node: HTMLElement) => node.querySelectorAll('button')
-     * ```
-     */
-    readonly navSelector: import("@angular/core").InputSignal<((node: HTMLElement) => NodeListOf<HTMLElement>) | undefined>;
-    /**
-     * Return the value for the 'aria-label' attribute of the toggle
-     * @param label - tree item label
-     *
-     * @defaultValue
-     * ```ts
-     * (label: string) => `Toggle ${label}`
-     * ```
-     */
-    readonly ariaLabelToggleFn: import("@angular/core").InputSignal<((label: string) => string) | undefined>;
-    /**
-     * An event emitted when the user toggles the expand of the TreeItem.
-     *
-     * Event payload is equal to the TreeItem clicked.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    readonly expandToggle: import("@angular/core").OutputEmitterRef<NormalizedTreeItem>;
-    /**
-     * Slot to change the default tree item content
-     */
-    readonly itemContent: import("@angular/core").InputSignal<SlotContent<TreeSlotItemContext>>;
-    readonly slotItemContentFromContent: import("@angular/core").Signal<TreeItemContentDirective | undefined>;
-    /**
-     * Slot to change the default display of the tree
-     */
-    readonly structure: import("@angular/core").InputSignal<SlotContent<TreeContext>>;
-    readonly slotStructureFromContent: import("@angular/core").Signal<TreeStructureDirective | undefined>;
-    /**
-     * Slot to change the default tree item toggle
-     */
-    readonly itemToggle: import("@angular/core").InputSignal<SlotContent<TreeSlotItemContext>>;
-    readonly slotItemToggleFromContent: import("@angular/core").Signal<TreeItemToggleDirective | undefined>;
-    /**
-     * Slot to change the default tree item
-     */
-    readonly item: import("@angular/core").InputSignal<SlotContent<TreeSlotItemContext>>;
-    readonly slotItemFromContent: import("@angular/core").Signal<TreeItemDirective | undefined>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TreeComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TreeComponent, "[auTree]", never, { "ariaLabel": { "alias": "auAriaLabel"; "required": false; "isSignal": true; }; "nodes": { "alias": "auNodes"; "required": false; "isSignal": true; }; "className": { "alias": "auClassName"; "required": false; "isSignal": true; }; "navSelector": { "alias": "auNavSelector"; "required": false; "isSignal": true; }; "ariaLabelToggleFn": { "alias": "auAriaLabelToggleFn"; "required": false; "isSignal": true; }; "itemContent": { "alias": "auItemContent"; "required": false; "isSignal": true; }; "structure": { "alias": "auStructure"; "required": false; "isSignal": true; }; "itemToggle": { "alias": "auItemToggle"; "required": false; "isSignal": true; }; "item": { "alias": "auItem"; "required": false; "isSignal": true; }; }, { "expandToggle": "auExpandToggle"; }, never, never, true, never>;
-}

package/components/tree/tree.gen.d.ts

@@ -1,216 +0,0 @@
-import type { WidgetSlotContext, SlotContent, Widget, WidgetFactory, Directive } from '@agnos-ui/angular-headless';
-/**
- * Retrieve a shallow copy of the default Tree config
- * @returns the default Tree config
- */
-declare const export_getTreeDefaultConfig: () => TreeProps;
-export { export_getTreeDefaultConfig as getTreeDefaultConfig };
-/**
- * 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;
-};
-/**
- * Represents the state of a Tree component.
- */
-export interface TreeState {
-    /**
-     * Array of normalized tree nodes
-     */
-    normalizedNodes: NormalizedTreeItem[];
-    /**
-     * Getter of expanded state for each tree node
-     */
-    expandedMap: {
-        get(item: NormalizedTreeItem): boolean | undefined;
-    };
-    /**
-     * Optional accessibility label for the tree if there is no explicit label
-     *
-     * @defaultValue `''`
-     */
-    ariaLabel?: string;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    className: string;
-    /**
-     * 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 properties for the Tree component.
- */
-export interface TreeProps {
-    /**
-     * Array of the tree nodes to display
-     *
-     * @defaultValue `[]`
-     */
-    nodes: TreeItem[];
-    /**
-     * An event emitted when the user toggles the expand of the TreeItem.
-     *
-     * Event payload is equal to the TreeItem clicked.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onExpandToggle: (node: NormalizedTreeItem) => void;
-    /**
-     * Retrieves expand items of the TreeItem
-     *
-     * @param node - HTML element that is representing the expand item
-     *
-     * @defaultValue
-     * ```ts
-     * (node: HTMLElement) => node.querySelectorAll('button')
-     * ```
-     */
-    navSelector(node: HTMLElement): NodeListOf<HTMLElement>;
-    /**
-     * Return the value for the 'aria-label' attribute of the toggle
-     * @param label - tree item label
-     *
-     * @defaultValue
-     * ```ts
-     * (label: string) => `Toggle ${label}`
-     * ```
-     */
-    ariaLabelToggleFn: (label: string) => string;
-    /**
-     * Optional accessibility label for the tree if there is no explicit label
-     *
-     * @defaultValue `''`
-     */
-    ariaLabel?: string;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    className: string;
-    /**
-     * 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 a Tree widget component.
- */
-export type TreeWidget = Widget<TreeProps, TreeState, TreeApi, TreeDirectives>;
-/**
- * Create a Tree with given config props
- * @param config - an optional tree config
- * @returns a TreeWidget
- */
-declare const export_createTree: WidgetFactory<TreeWidget>;
-export { export_createTree as createTree };
-/**
- * Represents a tree item component.
- */
-export interface TreeItem {
-    /**
-     * Optional accessibility label for the node
-     */
-    ariaLabel?: string;
-    /**
-     * Optional array of children nodes
-     */
-    children?: TreeItem[];
-    /**
-     * If `true` the node is expanded
-     */
-    isExpanded?: boolean;
-    /**
-     * String title of the node
-     */
-    label: string;
-}
-/**
- * Normalized TreeItem object
- */
-export interface NormalizedTreeItem {
-    /**
-     * Accessibility label for the node
-     */
-    ariaLabel: string;
-    /**
-     * Level in the hierarchy, starts with 0 for a root node
-     */
-    level: number;
-    /**
-     * An array of children nodes
-     */
-    children: NormalizedTreeItem[];
-    /**
-     * If `true` the node is expanded
-     */
-    isExpanded?: boolean;
-    /**
-     * String title of the node
-     */
-    label: string;
-}
-/**
- * Interface representing the API for a Tree component.
- */
-export interface TreeApi {
-}
-/**
- * Interface representing various directives used in the Tree component.
- */
-export interface TreeDirectives {
-    /**
-     * Directive to attach navManager for the tree
-     */
-    navigationDirective: Directive;
-    /**
-     * Directive to handle toggle for the tree item
-     */
-    itemToggleDirective: Directive<{
-        item: NormalizedTreeItem;
-    }>;
-    /**
-     * Directive to handle attributes for the tree item
-     */
-    itemAttributesDirective: Directive<{
-        item: NormalizedTreeItem;
-    }>;
-}