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

package/README.md

@@ -1,4 +1,4 @@
-# @agnos-ui/angular
+# @agnos-ui/angular-bootstrap
 
 [![npm](https://img.shields.io/npm/v/@agnos-ui/angular-bootstrap)](https://www.npmjs.com/package/@agnos-ui/angular-bootstrap)
 

package/components/accordion/accordion.component.d.ts

@@ -2,7 +2,7 @@ import type { SlotContent, TransitionFn } from '@agnos-ui/angular-headless';
 import { BaseWidgetDirective, ComponentTemplate } from '@agnos-ui/angular-headless';
 import type { AfterContentChecked, AfterViewInit } from '@angular/core';
 import { EventEmitter, TemplateRef } from '@angular/core';
-import type { AccordionItemContext, AccordionItemProps, AccordionItemWidget, AccordionWidget } from './accordion';
+import type { AccordionItemContext, AccordionItemProps, AccordionItemWidget, AccordionWidget } from './accordion.gen';
 import * as i0 from "@angular/core";
 export declare class AccordionBodyDirective {
     templateRef: TemplateRef<any>;
@@ -63,6 +63,8 @@ export declare class AccordionItemComponent extends BaseWidgetDirective<Accordio
     transition: TransitionFn | undefined;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string | undefined;
     /**
@@ -132,34 +134,57 @@ export declare class AccordionItemComponent extends BaseWidgetDirective<Accordio
 export declare class AccordionDirective extends BaseWidgetDirective<AccordionWidget> {
     /**
      * If `true`, only one accordion-item at the time can stay open.
+     *
+     * @defaultValue `false`
      */
     closeOthers: boolean | undefined;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string | undefined;
     /**
      * An event fired when an item is shown.
      *
      * Event payload is the id of the item.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     itemShown: EventEmitter<string>;
     /**
      * An event fired when an item is hidden.
      *
      * Event payload is the id of the item.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     itemHidden: EventEmitter<string>;
     /**
      * If `true`, the accordion-item body container will be removed from the DOM when the accordion-item is collapsed. It will be just hidden otherwise.
+     *
+     * @defaultValue `true`
      */
     itemDestroyOnHide: boolean | undefined;
     /**
      * If `true`, accordion-item will be animated.
+     *
+     * @defaultValue `true`
      */
     itemAnimated: boolean | undefined;
     /**
      * The transition to use for the accordion-item body-container when the accordion-item is toggled.
+     *
+     * @defaultValue
+     * ```ts
+     * collapseVerticalTransition
+     * ```
      */
     itemTransition: TransitionFn | undefined;
     /**
@@ -173,27 +198,39 @@ export declare class AccordionDirective extends BaseWidgetDirective<AccordionWid
     itemStructure: SlotContent<AccordionItemContext>;
     /**
      * CSS classes to add on the accordion-item DOM element.
+     *
+     * @defaultValue `''`
      */
     itemClassName: string | undefined;
     /**
      * CSS classes to add on the accordion-item header DOM element.
+     *
+     * @defaultValue `''`
      */
     itemHeaderClassName: string | undefined;
     /**
      * CSS classes to add on the accordion-item toggle button DOM element.
+     *
+     * @defaultValue `''`
      */
     itemButtonClassName: string | undefined;
     /**
      * CSS classes to add on the accordion-item body container DOM element.
      * The accordion-item body container is the DOM element on what the itemTransition is applied.
+     *
+     * @defaultValue `''`
      */
     itemBodyContainerClassName: string | undefined;
     /**
      * CSS classes to add on the accordion-item body DOM element.
+     *
+     * @defaultValue `''`
      */
     itemBodyClassName: string | undefined;
     /**
      * The html tag to use for the accordion-item-header.
+     *
+     * @defaultValue `''`
      */
     itemHeadingTag: string | undefined;
     readonly _widget: import("@agnos-ui/angular-headless").AngularWidget<AccordionWidget>;

package/components/accordion/accordion.gen.d.ts

@@ -1,4 +1,10 @@
-import type { WidgetSlotContext, SlotContent, TransitionFn, Widget, PropsConfig, Directive } from '@agnos-ui/angular-headless';
+import type { WidgetSlotContext, SlotContent, TransitionFn, Widget, WidgetFactory, ConfigValidator, PropsConfig, Directive } from '@agnos-ui/angular-headless';
+/**
+ * Retrieve a shallow copy of the default accordion config
+ * @returns the default accordion config
+ */
+declare const export_getAccordionDefaultConfig: () => AccordionProps;
+export { export_getAccordionDefaultConfig as getAccordionDefaultConfig };
 export type AccordionItemContext = WidgetSlotContext<AccordionItemWidget>;
 export interface AccordionState {
     /**
@@ -7,6 +13,8 @@ export interface AccordionState {
     itemWidgets: AccordionItemWidget[];
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -20,61 +28,96 @@ export interface AccordionState {
     itemStructure: SlotContent<AccordionItemContext>;
 }
 export interface AccordionProps {
+    /**
+     * The transition to use for the accordion-item body-container when the accordion-item is toggled.
+     *
+     * @defaultValue
+     * ```ts
+     * collapseVerticalTransition
+     * ```
+     */
+    itemTransition: TransitionFn;
     /**
      * If `true`, only one accordion-item at the time can stay open.
+     *
+     * @defaultValue `false`
      */
     closeOthers: boolean;
     /**
      * An event fired when an item is shown.
      *
      * Event payload is the id of the item.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onItemShown: (itemId: string) => void;
     /**
      * An event fired when an item is hidden.
      *
      * Event payload is the id of the item.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onItemHidden: (itemId: string) => void;
     /**
      * If `true`, the accordion-item body container will be removed from the DOM when the accordion-item is collapsed. It will be just hidden otherwise.
+     *
+     * @defaultValue `true`
      */
     itemDestroyOnHide: boolean;
     /**
      * If `true`, accordion-item will be animated.
+     *
+     * @defaultValue `true`
      */
     itemAnimated: boolean;
-    /**
-     * The transition to use for the accordion-item body-container when the accordion-item is toggled.
-     */
-    itemTransition: TransitionFn;
     /**
      * CSS classes to add on the accordion-item DOM element.
+     *
+     * @defaultValue `''`
      */
     itemClassName: string;
     /**
      * CSS classes to add on the accordion-item header DOM element.
+     *
+     * @defaultValue `''`
      */
     itemHeaderClassName: string;
     /**
      * CSS classes to add on the accordion-item toggle button DOM element.
+     *
+     * @defaultValue `''`
      */
     itemButtonClassName: string;
     /**
      * CSS classes to add on the accordion-item body container DOM element.
      * The accordion-item body container is the DOM element on what the itemTransition is applied.
+     *
+     * @defaultValue `''`
      */
     itemBodyContainerClassName: string;
     /**
      * CSS classes to add on the accordion-item body DOM element.
+     *
+     * @defaultValue `''`
      */
     itemBodyClassName: string;
     /**
      * The html tag to use for the accordion-item-header.
+     *
+     * @defaultValue `''`
      */
     itemHeadingTag: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -130,6 +173,8 @@ export interface AccordionItemState {
     headingTag: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -217,6 +262,8 @@ export interface AccordionItemProps {
     headingTag: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -242,6 +289,31 @@ export interface AccordionItemProps {
     header: SlotContent<AccordionItemContext>;
 }
 export type AccordionItemWidget = Widget<AccordionItemProps, AccordionItemState, AccordionItemApi, AccordionItemActions, AccordionItemDirectives>;
+/**
+ * Create an AccordionItemWidget with given config props
+ * @param config - an optional AccordionItem config
+ * @returns an AccordionItemWidget
+ */
+declare const export_createAccordionItem: WidgetFactory<AccordionItemWidget>;
+export { export_createAccordionItem as createAccordionItem };
+/**
+ * Create an AccordionWidget with given config props
+ * @param config - an optional accordion config
+ * @returns an AccordionWidget
+ */
+declare const export_createAccordion: WidgetFactory<AccordionWidget>;
+export { export_createAccordion as createAccordion };
+/**
+ * Create an accordion WidgetFactory based on a item factory and the list of item props that should inherit from the parent accordion
+ *
+ * @param itemFactory - the item factory
+ * @param accordionItemProps - the list of item props
+ * @param accordionConfig - the default accordion config
+ * @param accordionValidator - the validator of props
+ * @returns the accordion widget factory
+ */
+declare const export_factoryCreateAccordion: (itemFactory?: WidgetFactory<AccordionItemWidget>, accordionItemProps?: string[], accordionConfig?: AccordionProps, accordionValidator?: ConfigValidator<AccordionProps>) => WidgetFactory<AccordionWidget>;
+export { export_factoryCreateAccordion as factoryCreateAccordion };
 export interface AccordionApi {
     /**
      * Given the itemId, will expand the corresponding accordion-item.

package/components/accordion/index.d.ts

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

package/components/alert/alert.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 { AlertContext, AlertProps, AlertWidget } from './alert';
+import type { AlertContext, AlertProps, AlertWidget } from './alert.gen';
 import { type WritableSignal } from '@amadeus-it-group/tansu';
 import type { AfterContentChecked } from '@angular/core';
 import { EventEmitter, TemplateRef } from '@angular/core';
@@ -28,21 +28,29 @@ export type PartialAlertProps = Partial<AlertProps>;
 export declare class AlertComponent extends BaseWidgetDirective<AlertWidget> implements AfterContentChecked {
     /**
      * Type of the alert, following bootstrap types.
+     *
+     * @defaultValue `'primary'`
      */
     type: BSContextualClass | undefined;
     /**
      * 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 | undefined;
     /**
      * 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 | undefined;
     /**
      * If `true` the alert is visible to the user
+     *
+     * @defaultValue `true`
      */
     visible: boolean | undefined;
     /**
@@ -50,6 +58,8 @@ export declare class AlertComponent extends BaseWidgetDirective<AlertWidget> imp
      *
      * Animation is triggered  when the `.open()` function is called
      * or the visible prop is changed
+     *
+     * @defaultValue `false`
      */
     animatedOnInit: boolean | undefined;
     /**
@@ -57,10 +67,14 @@ export declare class AlertComponent extends BaseWidgetDirective<AlertWidget> imp
      *
      * Animation is triggered  when clicked on the close button (×),
      * via the `.close()` function or the visible prop is changed
+     *
+     * @defaultValue `true`
      */
     animated: boolean | undefined;
     /**
      * Accessibility close button label
+     *
+     * @defaultValue `'Close'`
      */
     ariaCloseButtonLabel: string | undefined;
     /**
@@ -75,19 +89,36 @@ export declare class AlertComponent extends BaseWidgetDirective<AlertWidget> imp
     slotStructureFromContent: AlertStructureDirective | undefined;
     /**
      * Callback called when the alert visibility changed.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     visibleChange: EventEmitter<boolean>;
     /**
      * Callback called when the alert is hidden.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     hidden: EventEmitter<void>;
     /**
      * Callback called when the alert is shown.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     shown: EventEmitter<void>;
     readonly defaultSlots: WritableSignal<PartialAlertProps>;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string | undefined;
     readonly _widget: import("@agnos-ui/angular-headless").AngularWidget<AlertWidget>;

package/components/alert/alert.gen.d.ts

@@ -1,5 +1,11 @@
-import type { WidgetSlotContext, SlotContent, TransitionFn, Widget, Directive } from '@agnos-ui/angular-headless';
+import type { WidgetSlotContext, SlotContent, TransitionFn, Widget, WidgetFactory, Directive } from '@agnos-ui/angular-headless';
 import type { BSContextualClass } from '@agnos-ui/core-bootstrap/types';
+/**
+ * Retrieve a shallow copy of the default Alert config
+ * @returns the default Alert config
+ */
+declare const export_getAlertDefaultConfig: () => AlertProps;
+export { export_getAlertDefaultConfig as getAlertDefaultConfig };
 export type AlertContext = WidgetSlotContext<AlertWidget>;
 export interface AlertState {
     /**
@@ -9,18 +15,26 @@ export interface AlertState {
     /**
      * 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;
     /**
@@ -33,33 +47,54 @@ export interface AlertState {
     children: SlotContent<AlertContext>;
     /**
      * Type of the alert, following bootstrap types.
+     *
+     * @defaultValue `'primary'`
      */
     type: BSContextualClass;
 }
 export interface AlertProps {
+    /**
+     * 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.
-     */
-    onShown: () => void;
-    /**
-     * 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
+     * ```ts
+     * () => {}
+     * ```
      */
-    transition: TransitionFn;
+    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;
     /**
@@ -67,23 +102,33 @@ export interface AlertProps {
      *
      * 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;
     /**
@@ -96,10 +141,19 @@ export interface AlertProps {
     children: SlotContent<AlertContext>;
     /**
      * Type of the alert, following bootstrap types.
+     *
+     * @defaultValue `'primary'`
      */
     type: BSContextualClass;
 }
 export type AlertWidget = Widget<AlertProps, AlertState, AlertApi, object, AlertDirectives>;
+/**
+ * Create an AlertWidget with given config props
+ * @param config - an optional alert config
+ * @returns an AlertWidget
+ */
+declare const export_createAlert: WidgetFactory<AlertWidget>;
+export { export_createAlert as createAlert };
 export interface AlertApi {
     /**
      * Triggers alert closing programmatically (same as clicking on the close button (×)).

package/components/alert/index.d.ts

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

package/components/modal/index.d.ts

@@ -1,3 +1,3 @@
-export * from './modal';
 export * from './modal.component';
+export * from './modal.gen';
 export * from './modal.service';