@agnos-ui/core 0.4.0-next.1 → 0.4.0

package/{alert-C-V64Qcs.cjs → alert-CEFbEgvG.cjs}

@@ -1,5 +1,5 @@
 "use strict";
-const common = require("./common-Kb96q7i4.cjs");
+const common = require("./common-nxv_hKNE.cjs");
 function getAlertDefaultConfig() {
   return { ...common.getCommonAlertDefaultConfig() };
 }

package/{alert-8ilqhLst.js → alert-DdGuK__c.js}

@@ -1,4 +1,4 @@
-import { g as getCommonAlertDefaultConfig, a as createCommonAlert } from "./common-BCEqowKw.js";
+import { g as getCommonAlertDefaultConfig, c as createCommonAlert } from "./common-CO5b5G_J.js";
 function getAlertDefaultConfig() {
   return { ...getCommonAlertDefaultConfig() };
 }

package/{common-BCEqowKw.js → common-CO5b5G_J.js}

@@ -69,8 +69,6 @@ function createCommonAlert(config) {
   };
 }
 export {
-  createCommonAlert as a,
-  commonAlertConfigValidator as c,
-  defaultCommonAlertConfig as d,
+  createCommonAlert as c,
   getCommonAlertDefaultConfig as g
 };

package/{common-Kb96q7i4.cjs → common-nxv_hKNE.cjs}

@@ -69,7 +69,5 @@ function createCommonAlert(config) {
     actions: {}
   };
 }
-exports.commonAlertConfigValidator = commonAlertConfigValidator;
 exports.createCommonAlert = createCommonAlert;
-exports.defaultCommonAlertConfig = defaultCommonAlertConfig;
 exports.getCommonAlertDefaultConfig = getCommonAlertDefaultConfig;

package/components/accordion/accordion.d.ts

@@ -4,55 +4,88 @@ import type { WidgetsCommonPropsAndState } from '../commonProps';
 export interface AccordionProps extends WidgetsCommonPropsAndState {
     /**
      * 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.
+     *
+     * @defaultValue
+     * ```ts
+     * async () => {}
+     * ```
      */
     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;
 }
@@ -161,7 +194,7 @@ export interface AccordionItemDirectives {
      */
     itemDirective: Directive;
 }
-export interface AccordionItemCommonPropsAndState extends WidgetsCommonPropsAndState {
+interface AccordionItemCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * If `true`, the accordion-item will be visible (expanded). Otherwise, it will be hidden (collapsed).
      */
@@ -260,3 +293,4 @@ export declare function factoryCreateAccordion(itemFactory?: WidgetFactory<Accor
  * @returns a new accordion widget instance
  */
 export declare const createAccordion: WidgetFactory<AccordionWidget>;
+export {};

package/components/alert/common.d.ts

@@ -1,18 +1,24 @@
 import type { TransitionFn } from '../../services/transitions/baseTransitions';
 import type { WidgetsCommonPropsAndState } from '../commonProps';
-import type { ConfigValidator, Directive, PropsConfig, Widget } from '../../types';
+import type { Directive, PropsConfig, Widget } from '../../types';
 export interface CommonAlertCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * 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;
 }
@@ -25,20 +31,40 @@ export interface CommonAlertState extends CommonAlertCommonPropsAndState {
 export interface CommonAlertProps extends CommonAlertCommonPropsAndState {
     /**
      * 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;
     /**
      * 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
+     * async () => {}
+     * ```
      */
     transition: TransitionFn;
     /**
@@ -46,6 +72,8 @@ export interface CommonAlertProps extends CommonAlertCommonPropsAndState {
      *
      * Animation is triggered  when the `.open()` function is called
      * or the visible prop is changed
+     *
+     * @defaultValue `false`
      */
     animatedOnInit: boolean;
     /**
@@ -53,6 +81,8 @@ export interface CommonAlertProps extends CommonAlertCommonPropsAndState {
      *
      * Animation is triggered  when clicked on the close button (×),
      * via the `.close()` function or the visible prop is changed
+     *
+     * @defaultValue `true`
      */
     animated: boolean;
 }
@@ -73,13 +103,11 @@ export interface CommonAlertDirectives {
     transitionDirective: Directive;
 }
 export type CommonAlertWidget = Widget<CommonAlertProps, CommonAlertState, CommonAlertApi, object, CommonAlertDirectives>;
-export declare const defaultCommonAlertConfig: CommonAlertProps;
 /**
  * Retrieve a shallow copy of the default alert config
  * @returns the default alert config
  */
 export declare function getCommonAlertDefaultConfig(): CommonAlertProps;
-export declare const commonAlertConfigValidator: ConfigValidator<CommonAlertProps>;
 /**
  * Create an AlertWidget with given config props
  * @param config - an optional alert config

package/components/alert/index.cjs

@@ -1,10 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const common = require("../../common-Kb96q7i4.cjs");
-const alert = require("../../alert-C-V64Qcs.cjs");
-exports.commonAlertConfigValidator = common.commonAlertConfigValidator;
-exports.createCommonAlert = common.createCommonAlert;
-exports.defaultCommonAlertConfig = common.defaultCommonAlertConfig;
-exports.getCommonAlertDefaultConfig = common.getCommonAlertDefaultConfig;
+const alert = require("../../alert-CEFbEgvG.cjs");
 exports.createAlert = alert.createAlert;
 exports.getAlertDefaultConfig = alert.getAlertDefaultConfig;

package/components/alert/index.d.ts

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

package/components/alert/index.js

@@ -1,10 +1,5 @@
-import { c, a, d, g } from "../../common-BCEqowKw.js";
-import { c as c2, g as g2 } from "../../alert-8ilqhLst.js";
+import { c, g } from "../../alert-DdGuK__c.js";
 export {
-  c as commonAlertConfigValidator,
-  c2 as createAlert,
-  a as createCommonAlert,
-  d as defaultCommonAlertConfig,
-  g2 as getAlertDefaultConfig,
-  g as getCommonAlertDefaultConfig
+  c as createAlert,
+  g as getAlertDefaultConfig
 };

package/components/commonProps.d.ts

@@ -1,6 +1,8 @@
 export interface WidgetsCommonPropsAndState {
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
 }

package/components/modal/modal.d.ts

@@ -14,27 +14,40 @@ export declare const modalCloseButtonClick: unique symbol;
 /**
  * Properties of the modal widget that are also in the state of the modal.
  */
-export interface ModalCommonPropsAndState extends WidgetsCommonPropsAndState {
+interface ModalCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * 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;
 }
@@ -60,22 +73,38 @@ export interface ModalBeforeCloseEvent {
 export interface ModalProps extends ModalCommonPropsAndState {
     /**
      * 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).
+     *
+     * @defaultValue
+     * ```ts
+     * async () => {}
+     * ```
      */
     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.
+     *
+     * @defaultValue
+     * ```ts
+     * async () => {}
+     * ```
      */
     modalTransition: TransitionFn;
     /**
@@ -83,20 +112,40 @@ export interface ModalProps extends ModalCommonPropsAndState {
      *
      * @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;
 }
@@ -106,7 +155,7 @@ export interface ModalProps extends ModalCommonPropsAndState {
 export interface ModalState extends ModalCommonPropsAndState {
     /**
      * Whether the backdrop is fully hidden. This can be true either because {@link ModalProps.backdrop|backdrop} is false or
-     * because {@link ModalCommonPropsAndState.visible|visible} is false and there is no current transition.
+     * because {@link ModalProps.visible|visible} is false and there is no current transition.
      */
     backdropHidden: boolean;
     /**
@@ -202,22 +251,38 @@ export type ModalWidget = Widget<ModalProps, ModalState, ModalApi, ModalActions,
 export declare function getModalDefaultConfig(): {
     /**
      * 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).
+     *
+     * @defaultValue
+     * ```ts
+     * async () => {}
+     * ```
      */
     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.
+     *
+     * @defaultValue
+     * ```ts
+     * async () => {}
+     * ```
      */
     modalTransition: TransitionFn;
     /**
@@ -225,42 +290,75 @@ export declare function getModalDefaultConfig(): {
      *
      * @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;
     className: string;
@@ -271,3 +369,4 @@ export declare function getModalDefaultConfig(): {
  * @returns a new modal widget instance
  */
 export declare function createModal(config$?: PropsConfig<ModalProps>): ModalWidget;
+export {};