@agnos-ui/angular-bootstrap 0.8.1 → 0.9.0

package/components/modal/modal.component.d.ts

@@ -1,220 +0,0 @@
-import type { SlotContent, TransitionFn } from '@agnos-ui/angular-headless';
-import { BaseWidgetDirective } from '@agnos-ui/angular-headless';
-import type { ModalContext, ModalWidget, ModalBeforeCloseEvent } from './modal.gen';
-import { TemplateRef } from '@angular/core';
-import * as i0 from "@angular/core";
-/**
- * Directive to provide the slot structure for the modal widget.
- * This directive provides a template reference for the {@link ModalContext<Data>}.
- */
-export declare class ModalStructureDirective<Data> {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard<Data>(_dir: ModalStructureDirective<Data>, context: unknown): context is ModalContext<Data>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModalStructureDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ModalStructureDirective<any>, "ng-template[auModalStructure]", never, {}, {}, never, never, true, never>;
-}
-/**
- * Directive to provide the slot header for the modal widget.
- * This directive provides a template reference for the {@link ModalContext<Data>}.
- */
-export declare class ModalHeaderDirective<Data> {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard<Data>(_dir: ModalHeaderDirective<Data>, context: unknown): context is ModalContext<Data>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModalHeaderDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ModalHeaderDirective<any>, "ng-template[auModalHeader]", never, {}, {}, never, never, true, never>;
-}
-/**
- * Directive to provide the slot title for the modal widget.
- * This directive provides a template reference for the {@link ModalContext<Data>}.
- */
-export declare class ModalTitleDirective<Data> {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard<Data>(_dir: ModalTitleDirective<Data>, context: unknown): context is ModalContext<Data>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModalTitleDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ModalTitleDirective<any>, "ng-template[auModalTitle]", never, {}, {}, never, never, true, never>;
-}
-/**
- * Directive to provide the default slot for the modal widget.
- * This directive provides a template reference for the {@link ModalContext<Data>}.
- */
-export declare class ModalBodyDirective<Data> {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard<Data>(_dir: ModalBodyDirective<Data>, context: unknown): context is ModalContext<Data>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModalBodyDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ModalBodyDirective<any>, "ng-template[auModalBody]", never, {}, {}, never, never, true, never>;
-}
-/**
- * Directive to provide the slot footer for the modal widget.
- * This directive provides a template reference for the {@link ModalContext<Data>}.
- */
-export declare class ModalFooterDirective<Data> {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard<Data>(_dir: ModalFooterDirective<Data>, context: unknown): context is ModalContext<Data>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModalFooterDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ModalFooterDirective<any>, "ng-template[auModalFooter]", never, {}, {}, never, never, true, never>;
-}
-/**
- * Default slot for modal header.
- */
-export declare const modalDefaultSlotHeader: SlotContent<ModalContext<any>>;
-/**
- * Default slot for modal structure.
- */
-export declare const modalDefaultSlotStructure: SlotContent<ModalContext<any>>;
-/**
- * Modal component.
- */
-export declare class ModalComponent<Data> extends BaseWidgetDirective<ModalWidget<Data>> {
-    /**
-     * Whether the modal and its backdrop (if present) should be animated when shown or hidden.
-     *
-     * @defaultValue `true`
-     */
-    readonly animated: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * The transition to use for the backdrop behind the modal (if present).
-     *
-     * @defaultValue `fadeTransition`
-     */
-    readonly backdropTransition: import("@angular/core").InputSignal<TransitionFn | undefined>;
-    /**
-     * The transition to use for the modal.
-     *
-     * @defaultValue `fadeTransition`
-     */
-    readonly modalTransition: import("@angular/core").InputSignal<TransitionFn | undefined>;
-    /**
-     * Whether the modal should be visible when the transition is completed.
-     *
-     * @defaultValue `false`
-     */
-    readonly visible: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * Whether a backdrop should be created behind the modal.
-     *
-     * @defaultValue `true`
-     */
-    readonly backdrop: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * Whether the modal should be closed when clicking on the viewport outside the modal.
-     *
-     * @defaultValue `true`
-     */
-    readonly closeOnOutsideClick: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * Which element should contain the modal and backdrop DOM elements.
-     * If it is not null, the modal and backdrop DOM elements are moved to the specified container.
-     * Otherwise, they stay where the widget is located.
-     *
-     * @defaultValue
-     * ```ts
-     * typeof window !== 'undefined' ? document.body : null
-     * ```
-     */
-    readonly container: import("@angular/core").InputSignal<HTMLElement | null | undefined>;
-    /**
-     * Value of the aria-label attribute to put on the close button.
-     *
-     * @defaultValue `'Close'`
-     */
-    readonly ariaCloseButtonLabel: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * Classes to add on the backdrop DOM element.
-     *
-     * @defaultValue `''`
-     */
-    readonly backdropClass: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * Whether to display the close button.
-     *
-     * @defaultValue `true`
-     */
-    readonly closeButton: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    readonly className: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * Option to create a fullscreen modal, according to the bootstrap documentation.
-     *
-     * @defaultValue `false`
-     */
-    readonly fullscreen: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * Structure of the modal.
-     * The default structure uses {@link ModalProps.header|header}, {@link ModalProps.children|children} and {@link ModalProps.footer|footer}.
-     */
-    readonly structure: import("@angular/core").InputSignal<SlotContent<ModalContext<Data>>>;
-    readonly slotStructureFromContent: import("@angular/core").Signal<ModalStructureDirective<any> | undefined>;
-    /**
-     * Header of the modal. The default header includes {@link ModalProps.title|title}.
-     */
-    readonly header: import("@angular/core").InputSignal<SlotContent<ModalContext<Data>>>;
-    readonly slotHeaderFromContent: import("@angular/core").Signal<ModalHeaderDirective<any> | undefined>;
-    /**
-     * Title of the modal.
-     */
-    readonly title: import("@angular/core").InputSignal<SlotContent<ModalContext<Data>>>;
-    readonly slotTitleFromContent: import("@angular/core").Signal<ModalTitleDirective<any> | undefined>;
-    /**
-     * Body of the modal.
-     */
-    readonly children: import("@angular/core").InputSignal<SlotContent<ModalContext<Data>>>;
-    readonly slotDefaultFromContent: import("@angular/core").Signal<ModalBodyDirective<any> | undefined>;
-    /**
-     * Footer of the modal.
-     */
-    readonly footer: import("@angular/core").InputSignal<SlotContent<ModalContext<Data>>>;
-    readonly slotFooterFromContent: import("@angular/core").Signal<ModalFooterDirective<any> | undefined>;
-    /**
-     * Data to use in content slots
-     */
-    readonly contentData: import("@angular/core").InputSignal<Data | undefined>;
-    /**
-     * Event to be triggered when the visible property changes.
-     *
-     * @param visible - new value of the visible propery
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    readonly visibleChange: import("@angular/core").OutputEmitterRef<boolean>;
-    /**
-     * Event to be triggered when the modal is about to be closed (i.e. the {@link ModalApi.close|close} method was called).
-     *
-     * @param event - event giving access to the argument given to the {@link ModalApi.close|close} method and allowing
-     * to cancel the close process.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    readonly beforeClose: import("@angular/core").OutputEmitterRef<ModalBeforeCloseEvent>;
-    /**
-     * Event to be triggered when the transition is completed and the modal is not visible.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    readonly hidden: import("@angular/core").OutputEmitterRef<void>;
-    /**
-     * Event to be triggered when the transition is completed and the modal is visible.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    readonly shown: import("@angular/core").OutputEmitterRef<void>;
-    readonly slotChildren: import("@angular/core").Signal<TemplateRef<void> | undefined>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModalComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ModalComponent<any>, "[auModal]", never, { "animated": { "alias": "auAnimated"; "required": false; "isSignal": true; }; "backdropTransition": { "alias": "auBackdropTransition"; "required": false; "isSignal": true; }; "modalTransition": { "alias": "auModalTransition"; "required": false; "isSignal": true; }; "visible": { "alias": "auVisible"; "required": false; "isSignal": true; }; "backdrop": { "alias": "auBackdrop"; "required": false; "isSignal": true; }; "closeOnOutsideClick": { "alias": "auCloseOnOutsideClick"; "required": false; "isSignal": true; }; "container": { "alias": "auContainer"; "required": false; "isSignal": true; }; "ariaCloseButtonLabel": { "alias": "auAriaCloseButtonLabel"; "required": false; "isSignal": true; }; "backdropClass": { "alias": "auBackdropClass"; "required": false; "isSignal": true; }; "closeButton": { "alias": "auCloseButton"; "required": false; "isSignal": true; }; "className": { "alias": "auClassName"; "required": false; "isSignal": true; }; "fullscreen": { "alias": "auFullscreen"; "required": false; "isSignal": true; }; "structure": { "alias": "auStructure"; "required": false; "isSignal": true; }; "header": { "alias": "auHeader"; "required": false; "isSignal": true; }; "title": { "alias": "auTitle"; "required": false; "isSignal": true; }; "children": { "alias": "auChildren"; "required": false; "isSignal": true; }; "footer": { "alias": "auFooter"; "required": false; "isSignal": true; }; "contentData": { "alias": "auContentData"; "required": false; "isSignal": true; }; }, { "visibleChange": "auVisibleChange"; "beforeClose": "auBeforeClose"; "hidden": "auHidden"; "shown": "auShown"; }, ["slotStructureFromContent", "slotHeaderFromContent", "slotTitleFromContent", "slotDefaultFromContent", "slotFooterFromContent"], ["*"], true, never>;
-}

package/components/modal/modal.gen.d.ts

@@ -1,355 +0,0 @@
-import { modalOutsideClick, modalCloseButtonClick } from '@agnos-ui/core-bootstrap/components/modal';
-import type { WidgetSlotContext, SlotContent, TransitionFn, Widget, PropsConfig, Directive } from '@agnos-ui/angular-headless';
-/**
- * Retrieve a shallow copy of the default modal config
- * @returns the default modal config
- */
-declare const export_getModalDefaultConfig: () => ModalProps<any>;
-export { export_getModalDefaultConfig as getModalDefaultConfig };
-/**
- * Represents the context for a modal component.
- *
- * @template Data - The type of data associated with the modal.
- */
-export interface ModalContext<Data> extends WidgetSlotContext<ModalWidget<Data>> {
-}
-/**
- * Represents the state of a modal component.
- *
- * @template Data - The type of the data associated with the modal.
- */
-export interface ModalState<Data> {
-    /**
-     * Whether the backdrop is fully hidden. This can be true either because {@link ModalProps.backdrop|backdrop} is false or
-     * because {@link ModalProps.visible|visible} is false and there is no current transition.
-     */
-    backdropHidden: boolean;
-    /**
-     * Whether the modal is fully hidden.
-     */
-    hidden: boolean;
-    /**
-     * Whether there is an active transition to either display or hide the modal.
-     */
-    transitioning: boolean;
-    /**
-     * DOM element of the modal.
-     */
-    modalElement: HTMLElement | null;
-    /**
-     * Value of the aria-label attribute to put on the close button.
-     *
-     * @defaultValue `'Close'`
-     */
-    ariaCloseButtonLabel: string;
-    /**
-     * Classes to add on the backdrop DOM element.
-     *
-     * @defaultValue `''`
-     */
-    backdropClass: string;
-    /**
-     * Whether to display the close button.
-     *
-     * @defaultValue `true`
-     */
-    closeButton: boolean;
-    /**
-     * Which element should contain the modal and backdrop DOM elements.
-     * If it is not null, the modal and backdrop DOM elements are moved to the specified container.
-     * Otherwise, they stay where the widget is located.
-     *
-     * @defaultValue
-     * ```ts
-     * typeof window !== 'undefined' ? document.body : null
-     * ```
-     */
-    container: HTMLElement | null;
-    /**
-     * Whether the modal should be visible when the transition is completed.
-     *
-     * @defaultValue `false`
-     */
-    visible: boolean;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    className: string;
-    /**
-     * Data to use in content slots
-     */
-    contentData: Data;
-    /**
-     * Body of the modal.
-     */
-    children: SlotContent<ModalContext<Data>>;
-    /**
-     * Footer of the modal.
-     */
-    footer: SlotContent<ModalContext<Data>>;
-    /**
-     * Header of the modal. The default header includes {@link ModalProps.title|title}.
-     */
-    header: SlotContent<ModalContext<Data>>;
-    /**
-     * Structure of the modal.
-     * The default structure uses {@link ModalProps.header|header}, {@link ModalProps.children|children} and {@link ModalProps.footer|footer}.
-     */
-    structure: SlotContent<ModalContext<Data>>;
-    /**
-     * Title of the modal.
-     */
-    title: SlotContent<ModalContext<Data>>;
-    /**
-     * Option to create a fullscreen modal, according to the bootstrap documentation.
-     *
-     * @defaultValue `false`
-     */
-    fullscreen: boolean;
-}
-/**
- * Interface representing the properties for a modal component.
- *
- * @template Data - The type of data that the modal will handle.
- */
-export interface ModalProps<Data> {
-    /**
-     * The transition to use for the backdrop behind the modal (if present).
-     *
-     * @defaultValue `fadeTransition`
-     */
-    backdropTransition: TransitionFn;
-    /**
-     * The transition to use for the modal.
-     *
-     * @defaultValue `fadeTransition`
-     */
-    modalTransition: TransitionFn;
-    /**
-     * Whether the modal and its backdrop (if present) should be animated when shown or hidden.
-     *
-     * @defaultValue `true`
-     */
-    animated: boolean;
-    /**
-     * Whether a backdrop should be created behind the modal.
-     *
-     * @defaultValue `true`
-     */
-    backdrop: boolean;
-    /**
-     * Whether the modal should be closed when clicking on the viewport outside the modal.
-     *
-     * @defaultValue `true`
-     */
-    closeOnOutsideClick: boolean;
-    /**
-     * Event to be triggered when the modal is about to be closed (i.e. the {@link ModalApi.close|close} method was called).
-     *
-     * @param event - event giving access to the argument given to the {@link ModalApi.close|close} method and allowing
-     * to cancel the close process.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onBeforeClose: (event: ModalBeforeCloseEvent) => void;
-    /**
-     * Event to be triggered when the visible property changes.
-     *
-     * @param visible - new value of the visible propery
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onVisibleChange: (visible: boolean) => void;
-    /**
-     * Event to be triggered when the transition is completed and the modal is not visible.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onHidden: () => void;
-    /**
-     * Event to be triggered when the transition is completed and the modal is visible.
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onShown: () => void;
-    /**
-     * Value of the aria-label attribute to put on the close button.
-     *
-     * @defaultValue `'Close'`
-     */
-    ariaCloseButtonLabel: string;
-    /**
-     * Classes to add on the backdrop DOM element.
-     *
-     * @defaultValue `''`
-     */
-    backdropClass: string;
-    /**
-     * Whether to display the close button.
-     *
-     * @defaultValue `true`
-     */
-    closeButton: boolean;
-    /**
-     * Which element should contain the modal and backdrop DOM elements.
-     * If it is not null, the modal and backdrop DOM elements are moved to the specified container.
-     * Otherwise, they stay where the widget is located.
-     *
-     * @defaultValue
-     * ```ts
-     * typeof window !== 'undefined' ? document.body : null
-     * ```
-     */
-    container: HTMLElement | null;
-    /**
-     * Whether the modal should be visible when the transition is completed.
-     *
-     * @defaultValue `false`
-     */
-    visible: boolean;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    className: string;
-    /**
-     * Data to use in content slots
-     */
-    contentData: Data;
-    /**
-     * Body of the modal.
-     */
-    children: SlotContent<ModalContext<Data>>;
-    /**
-     * Footer of the modal.
-     */
-    footer: SlotContent<ModalContext<Data>>;
-    /**
-     * Header of the modal. The default header includes {@link ModalProps.title|title}.
-     */
-    header: SlotContent<ModalContext<Data>>;
-    /**
-     * Structure of the modal.
-     * The default structure uses {@link ModalProps.header|header}, {@link ModalProps.children|children} and {@link ModalProps.footer|footer}.
-     */
-    structure: SlotContent<ModalContext<Data>>;
-    /**
-     * Title of the modal.
-     */
-    title: SlotContent<ModalContext<Data>>;
-    /**
-     * Option to create a fullscreen modal, according to the bootstrap documentation.
-     *
-     * @defaultValue `false`
-     */
-    fullscreen: boolean;
-}
-/**
- * Interface representing the API for a modal component.
- *
- * @template Data - The type of data associated with the modal.
- */
-export interface ModalApi<Data> {
-    /**
-     * Method to change some modal properties.
-     */
-    patch: ModalWidget<Data>['patch'];
-    /**
-     * Closes the modal with the given result.
-     *
-     * @param result - result of the modal, as passed in the {@link ModalBeforeCloseEvent.result|result} property of the event passed to the
-     * {@link ModalProps.onBeforeClose|onBeforeClose} event handler (and possibly changed by it) and resolved by the promise returned by the {@link ModalApi.open|open} method.
-     */
-    close(result?: any): void;
-    /**
-     * Opens the modal and returns a promise that is resolved when the modal is closed.
-     * The resolved value is the result passed to the {@link ModalApi.close|close} method and possibly changed by the
-     * {@link ModalProps.onBeforeClose|onBeforeClose} event handler
-     */
-    open(): Promise<any>;
-}
-/**
- * Represents a modal widget with specific data type.
- *
- * @template Data - The type of data that the modal widget will handle.
- */
-export type ModalWidget<Data> = Widget<ModalProps<Data>, ModalState<Data>, ModalApi<Data>, ModalDirectives>;
-/**
- * Creates a new modal widget instance.
- * @param config - config of the modal, either as a store or as an object containing values or stores.
- * @returns a new modal widget instance
- */
-declare const export_createModal: <Data>(config?: PropsConfig<ModalProps<Data>>) => ModalWidget<Data>;
-export { export_createModal as createModal };
-/**
- * Value present in the {@link ModalBeforeCloseEvent.result|result} property of the {@link ModalProps.onBeforeClose|onBeforeClose} event
- * and returned by the {@link ModalApi.open|open} method, when the modal is closed by a click inside the viewport but outside the modal.
- */
-declare const export_modalOutsideClick: typeof modalOutsideClick;
-export { export_modalOutsideClick as modalOutsideClick };
-/**
- * Value present in the {@link ModalBeforeCloseEvent.result|result} property of the {@link ModalProps.onBeforeClose|onBeforeClose} event
- * and returned by the {@link ModalApi.open|open} method, when the modal is closed by a click on the close button.
- */
-declare const export_modalCloseButtonClick: typeof modalCloseButtonClick;
-export { export_modalCloseButtonClick as modalCloseButtonClick };
-/**
- * Type of the parameter of {@link ModalProps.onBeforeClose|onBeforeClose}.
- */
-export interface ModalBeforeCloseEvent {
-    /**
-     * Result of the modal, which is the value passed to the {@link ModalApi.close|close} method
-     * and later resolved by the promise returned by the {@link ModalApi.open|open} method.
-     * If needed, it can be changed from the {@link ModalProps.onBeforeClose|onBeforeClose} event handler.
-     */
-    result: any;
-    /**
-     * Whether to cancel the close of the modal.
-     * It can be changed from the {@link ModalProps.onBeforeClose|onBeforeClose} event handler.
-     */
-    cancel: boolean;
-}
-/**
- * Directives of the modal widget.
- */
-export interface ModalDirectives {
-    /**
-     * Directive to put on the modal DOM element.
-     */
-    modalDirective: Directive;
-    /**
-     * Directive to put on the backdrop DOM element.
-     */
-    backdropDirective: Directive;
-    /**
-     * Portal directive to put on the modal DOM element.
-     */
-    modalPortalDirective: Directive;
-    /**
-     * Portal directive to put on the backdrop DOM element.
-     */
-    backdropPortalDirective: Directive;
-    /**
-     * Directive that adds all the necessary attributes to the close button
-     */
-    closeButtonDirective: Directive;
-    /**
-     * Directive to apply to the dialog element when using the native {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement | HTMLDialogElement}
-     */
-    dialogDirective: Directive;
-}

package/components/modal/modal.service.d.ts

@@ -1,21 +0,0 @@
-import { Injector } from '@angular/core';
-import type { ModalProps } from './modal.gen';
-import * as i0 from "@angular/core";
-/**
- * Service to handle the opening and management of modal components.
- */
-export declare class ModalService {
-    private readonly _injector;
-    private readonly _applicationRef;
-    /**
-     * Opens a modal dialog with the specified options.
-     *
-     * @template Data - The type of data that the modal will handle.
-     * @param options - The options to configure the modal.
-     * @param injector - The injector to use when creating the modal component
-     * @returns A promise that resolves when the modal is closed.
-     */
-    open<Data>(options: Partial<ModalProps<Data>>, injector?: Injector): Promise<any>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModalService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ModalService>;
-}

package/components/pagination/index.d.ts

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