@agnos-ui/angular-bootstrap 0.4.0-next.1 → 0.4.1

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

@@ -1,6 +1,6 @@
 import type { SlotContent, TransitionFn } from '@agnos-ui/angular-headless';
 import { BaseWidgetDirective, ComponentTemplate } from '@agnos-ui/angular-headless';
-import type { ModalContext, ModalProps, ModalWidget, ModalBeforeCloseEvent } from './modal';
+import type { ModalContext, ModalProps, ModalWidget, ModalBeforeCloseEvent } from './modal.gen';
 import type { AfterContentChecked } from '@angular/core';
 import { EventEmitter, TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
@@ -72,62 +72,89 @@ export declare const modalDefaultSlotStructure: ComponentTemplate<unknown, "stru
 export declare class ModalComponent<Data> extends BaseWidgetDirective<ModalWidget<Data>> implements AfterContentChecked {
     /**
      * Whether the modal and its backdrop (if present) should be animated when shown or hidden.
+     *
+     * @defaultValue `true`
      */
     animated: boolean | undefined;
     /**
      * The transition to use for the backdrop behind the modal (if present).
+     *
+     * @defaultValue `fadeTransition`
      */
     backdropTransition: TransitionFn | undefined;
     /**
      * The transition to use for the modal.
+     *
+     * @defaultValue `fadeTransition`
      */
     modalTransition: TransitionFn | undefined;
     /**
      * Whether the modal should be visible when the transition is completed.
+     *
+     * @defaultValue `false`
      */
     visible: boolean | undefined;
     /**
      * Whether a backdrop should be created behind the modal.
+     *
+     * @defaultValue `true`
      */
     backdrop: boolean | undefined;
     /**
      * Whether the modal should be closed when clicking on the viewport outside the modal.
+     *
+     * @defaultValue `true`
      */
     closeOnOutsideClick: boolean | undefined;
     /**
      * 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 | undefined;
     /**
      * Value of the aria-label attribute to put on the close button.
+     *
+     * @defaultValue `'Close'`
      */
     ariaCloseButtonLabel: string | undefined;
     /**
      * Classes to add on the backdrop DOM element.
+     *
+     * @defaultValue `''`
      */
     backdropClass: string | undefined;
     /**
      * Whether to display the close button.
+     *
+     * @defaultValue `true`
      */
     closeButton: boolean | undefined;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string | undefined;
     /**
      * Option to create a fullscreen modal, according to the bootstrap documentation.
+     *
+     * @defaultValue `false`
      */
     fullscreen: boolean | undefined;
     /**
      * Structure of the modal.
-     * The default structure uses ModalCommonPropsAndState.header header, ModalCommonPropsAndState.children children and ModalCommonPropsAndState.footer footer.
+     * The default structure uses {@link ModalProps.header|header}, {@link ModalProps.children|children} and {@link ModalProps.footer|footer}.
      */
     structure: SlotContent<ModalContext<Data>>;
     slotStructureFromContent: ModalStructureDirective<Data> | undefined;
     /**
-     * Header of the modal. The default header includes ModalCommonPropsAndState.title title.
+     * Header of the modal. The default header includes {@link ModalProps.title|title}.
      */
     header: SlotContent<ModalContext<Data>>;
     slotHeaderFromContent: ModalHeaderDirective<Data> | undefined;
@@ -152,18 +179,43 @@ export declare class ModalComponent<Data> extends BaseWidgetDirective<ModalWidge
     contentData: Data | undefined;
     /**
      * Event to be triggered when the visible property changes.
+     *
+     * @param visible - new value of the visible propery
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     visibleChange: EventEmitter<boolean>;
     /**
-     * Event to be triggered when the modal is about to be closed (i.e. the ModalApi.closeclose  method was called).
+     * 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
+     * () => {}
+     * ```
      */
     beforeClose: EventEmitter<ModalBeforeCloseEvent>;
     /**
      * Event to be triggered when the transition is completed and the modal is not visible.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     hidden: EventEmitter<void>;
     /**
      * Event to be triggered when the transition is completed and the modal is visible.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     shown: EventEmitter<void>;
     readonly defaultSlots: import("@amadeus-it-group/tansu").WritableSignal<Partial<ModalProps<any>>, Partial<ModalProps<any>>>;

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

@@ -1,9 +1,16 @@
-import type { WidgetSlotContext, SlotContent, TransitionFn, Widget, Directive } from '@agnos-ui/angular-headless';
+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 };
 export type ModalContext<Data> = WidgetSlotContext<ModalWidget<Data>>;
 export interface ModalState<Data> {
     /**
-     * Whether the backdrop is fully hidden. This can be true either because {@link ModalProps.backdropbackdrop} is false or
-     * because {@link ModalCommonPropsAndState.visiblevisible} is false and there is no current transition.
+     * 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;
     /**
@@ -20,28 +27,43 @@ export interface ModalState<Data> {
     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;
     /**
@@ -57,12 +79,12 @@ export interface ModalState<Data> {
      */
     footer: SlotContent<ModalContext<Data>>;
     /**
-     * Header of the modal. The default header includes {@link ModalCommonPropsAndState.title title}.
+     * 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 ModalCommonPropsAndState.header header}, {@link ModalCommonPropsAndState.children children} and {@link ModalCommonPropsAndState.footer footer}.
+     * The default structure uses {@link ModalProps.header|header}, {@link ModalProps.children|children} and {@link ModalProps.footer|footer}.
      */
     structure: SlotContent<ModalContext<Data>>;
     /**
@@ -71,70 +93,122 @@ export interface ModalState<Data> {
     title: SlotContent<ModalContext<Data>>;
     /**
      * Option to create a fullscreen modal, according to the bootstrap documentation.
+     *
+     * @defaultValue `false`
      */
     fullscreen: boolean;
 }
 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;
-    /**
-     * The transition to use for the backdrop behind the modal (if present).
-     */
-    backdropTransition: TransitionFn;
     /**
      * Whether the modal should be closed when clicking on the viewport outside the modal.
+     *
+     * @defaultValue `true`
      */
     closeOnOutsideClick: boolean;
     /**
-     * The transition to use for the modal.
-     */
-    modalTransition: TransitionFn;
-    /**
-     * Event to be triggered when the modal is about to be closed (i.e. the {@link ModalApi.closeclose} method was called).
+     * 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;
     /**
@@ -150,12 +224,12 @@ export interface ModalProps<Data> {
      */
     footer: SlotContent<ModalContext<Data>>;
     /**
-     * Header of the modal. The default header includes {@link ModalCommonPropsAndState.title title}.
+     * 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 ModalCommonPropsAndState.header header}, {@link ModalCommonPropsAndState.children children} and {@link ModalCommonPropsAndState.footer footer}.
+     * The default structure uses {@link ModalProps.header|header}, {@link ModalProps.children|children} and {@link ModalProps.footer|footer}.
      */
     structure: SlotContent<ModalContext<Data>>;
     /**
@@ -164,6 +238,8 @@ export interface ModalProps<Data> {
     title: SlotContent<ModalContext<Data>>;
     /**
      * Option to create a fullscreen modal, according to the bootstrap documentation.
+     *
+     * @defaultValue `false`
      */
     fullscreen: boolean;
 }
@@ -174,39 +250,63 @@ export interface ModalApi<Data> {
     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.closeclose} method and possibly changed by the
-     * {@link ModalProps.onBeforeCloseonBeforeClose} event handler
+     * 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>;
 }
 export type ModalWidget<Data> = Widget<ModalProps<Data>, ModalState<Data>, ModalApi<Data>, ModalActions, 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 };
 export interface ModalBeforeCloseEvent {
     /**
-     * Result of the modal, which is the value passed to the {@link ModalApi.closeclose} method
-     * and later resolved by the promise returned by the {@link ModalApi.openopen} method.
-     * If needed, it can be changed from the {@link ModalProps.onBeforeCloseonBeforeClose} event handler.
+     * 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.onBeforeCloseonBeforeClose} event handler.
+     * It can be changed from the {@link ModalProps.onBeforeClose|onBeforeClose} event handler.
      */
     cancel: boolean;
 }
 export interface ModalActions {
     /**
      * Action to be called when the user clicks on the close button. It closes the modal with the {@link modalCloseButtonClick} result.
+     * @param event - mouse event
      */
     closeButtonClick(event: Pick<MouseEvent, never>): void;
     /**
      * Action to be called when the user clicks on the modal DOM element (which is supposed to have the size of the full viewport).
      * If the click is not done on a descendant of the modal DOM element, it is considered to be done outside the modal
-     * and, depending on the value of the {@link ModalProps.closeOnOutsideClickcloseOnOutsideClick} prop, the modal is or isn't closed
+     * and, depending on the value of the {@link ModalProps.closeOnOutsideClick|closeOnOutsideClick} prop, the modal is or isn't closed
      * (with the {@link modalOutsideClick} result).
+     * @param event - mouse event
      */
     modalClick(event: Pick<MouseEvent, 'target' | 'currentTarget'>): void;
 }

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

@@ -1,5 +1,5 @@
-import type { ModalProps } from './modal';
 import { Injector } from '@angular/core';
+import type { ModalProps } from './modal.gen';
 import * as i0 from "@angular/core";
 export interface ModalServiceOpenOptions {
     injector?: Injector;

package/components/pagination/index.d.ts

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