@agnos-ui/core 0.9.3 → 0.10.0-next.1

package/components/drawer/drawer.d.ts

@@ -0,0 +1,242 @@
+import type { TransitionFn } from '../../services/transitions/baseTransitions';
+import type { Directive, WidgetFactory } from '../../types';
+import { type Widget } from '../../types';
+import type { WidgetsCommonPropsAndState } from '../commonProps';
+/**
+ * Possible values for the drawer positions
+ */
+export type DrawerPositions = 'inline-start' | 'inline-end' | 'block-start' | 'block-end';
+interface DrawerCommonPropsAndState extends WidgetsCommonPropsAndState {
+    /**
+     * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `'w-full'`
+     */
+    className: string;
+    /**
+     * Which element should contain the drawer and backdrop DOM elements.
+     * If it is not null, the drawer 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;
+    /**
+     * Classes to add on the backdrop DOM element.
+     *
+     * @defaultValue `''`
+     */
+    backdropClass: string;
+    /**
+     * If `true`, the drawer is shown; otherwise, it is hidden.
+     *
+     * @defaultValue `false`
+     */
+    visible: boolean;
+    /**
+     * If `true`, the drawer can be resized by the user.
+     *
+     * @defaultValue `false`
+     */
+    resizable: boolean;
+}
+/**
+ * Interface representing the properties for the Drawer component.
+ */
+export interface DrawerProps extends DrawerCommonPropsAndState {
+    /**
+     * The transition function will be executed when the drawer is displayed or hidden.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    transition: TransitionFn;
+    /**
+     * The transition function for vertically positioned drawer (top, bottom) that will be executed when the drawer is displayed or hidden.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    verticalTransition: TransitionFn;
+    /**
+     * The transition to use for the backdrop behind the drawer (if present).
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    backdropTransition: TransitionFn;
+    /**
+     * If `true` opening and closing will be animated.
+     *
+     * @defaultValue `true`
+     */
+    animated: boolean;
+    /**
+     * aria-labelledby attribute to use for the drawer element.
+     *
+     * @defaultValue `''`
+     */
+    ariaLabelledBy: string;
+    /**
+     * aria-describedby attribute to use for the drawer element.
+     *
+     * @defaultValue `''`
+     */
+    ariaDescribedBy: string;
+    /**
+     * The width of the drawer in pixels.
+     *
+     * @defaultValue `200`
+     */
+    width: number;
+    /**
+     * The height of the drawer in pixels.
+     *
+     * @defaultValue `200`
+     */
+    height: number;
+    /**
+     * If `true` displays the backdrop element and disables the body scrolling, otherwise the body of the document is navigable
+     *
+     * @defaultValue `true`
+     */
+    backdrop: boolean;
+    /**
+     * If `true` allows body scrolling when the drawer is open.
+     *
+     * @defaultValue `false`
+     */
+    bodyScroll: boolean;
+    /**
+     * Event to be triggered when the transition is completed and the drawer is not visible.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    onHidden: () => void;
+    /**
+     * Event to be triggered when the transition is completed and the drawer is visible.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    onShown: () => void;
+    /**
+     * An event emitted when the width is changed.
+     *
+     * Event payload is equal to the newly selected width.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    onWidthChange: (width: number) => void;
+    /**
+     * An event emitted when the height is changed.
+     *
+     * Event payload is equal to the newly selected height.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    onHeightChange: (width: number) => void;
+    /**
+     * Event to be triggered when the visible property changes.
+     *
+     * @param visible - new value of the visible propery
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    onVisibleChange: (visible: boolean) => void;
+}
+/**
+ * Represents the state of a Drawer component.
+ */
+export interface DrawerState extends DrawerCommonPropsAndState {
+    /**
+     * Whether the backdrop is fully hidden. This can be true either because {@link DrawerProps.backdrop|backdrop} is false or
+     * because {@link DrawerProps.visible|visible} is false and there is no current transition.
+     */
+    backdropHidden: boolean;
+    /**
+     * Flag to show whether the drawer is fully hidden.
+     */
+    hidden: boolean;
+}
+/**
+ * Interface representing the API for a Drawer component.
+ */
+export interface DrawerApi {
+    /**
+     * Trigger the opening of the drawer.
+     */
+    open: () => void;
+    /**
+     * Trigger the closing of the drawer.
+     */
+    close: () => void;
+}
+/**
+ * Interface representing various directives used in the Drawer component.
+ */
+export interface DrawerDirectives {
+    /**
+     * Directive to put on the drawer DOM element.
+     */
+    drawerDirective: Directive;
+    /**
+     * Portal directive to put on the drawer DOM element.
+     */
+    drawerPortalDirective: Directive;
+    /**
+     * Directive to put on the backdrop DOM element.
+     */
+    backdropDirective: Directive;
+    /**
+     * Portal directive to put on the backdrop DOM element.
+     */
+    backdropPortalDirective: Directive;
+    /**
+     * Directive to put on the splitter DOM element.
+     */
+    splitterDirective: Directive;
+    /**
+     * Directive to put on the container DOM element in order for the drawer to size correctly.
+     */
+    containerDirective: Directive;
+}
+/**
+ * Represents a Drawer widget component.
+ */
+export type DrawerWidget = Widget<DrawerProps, DrawerState, DrawerApi, DrawerDirectives>;
+/**
+ * Retrieve a shallow copy of the default Drawer config
+ * @returns the default Drawer config
+ */
+export declare function getDrawerDefaultConfig(): DrawerProps;
+/**
+ * Create a Drawer widget with given config props
+ * @param config - an optional Drawer config
+ * @returns a DrawerWidget
+ */
+export declare const createDrawer: WidgetFactory<DrawerWidget>;
+export {};

package/components/drawer/index.cjs

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const drawer = require("../../drawer-DP7UPojk.cjs");
+exports.createDrawer = drawer.createDrawer;
+exports.getDrawerDefaultConfig = drawer.getDrawerDefaultConfig;

package/components/drawer/index.d.ts

@@ -0,0 +1 @@
+export * from './drawer';

package/components/drawer/index.js

@@ -0,0 +1,5 @@
+import { c, g } from "../../drawer-D5SO73ew.js";
+export {
+  c as createDrawer,
+  g as getDrawerDefaultConfig
+};

package/components/modal/index.cjs

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const modal = require("../../modal-BEnQ6c5M.cjs");
+const modal = require("../../modal-DiXZXYjR.cjs");
 exports.createModal = modal.createModal;
 exports.getModalDefaultConfig = modal.getModalDefaultConfig;
 exports.modalCloseButtonClick = modal.modalCloseButtonClick;
+exports.modalCloseEscape = modal.modalCloseEscape;
 exports.modalOutsideClick = modal.modalOutsideClick;

package/components/modal/index.js

@@ -1,7 +1,8 @@
-import { c, g, a, m } from "../../modal-D3wGIDlj.js";
+import { c, g, a, b, m } from "../../modal-CAvQW-vo.js";
 export {
   c as createModal,
   g as getModalDefaultConfig,
   a as modalCloseButtonClick,
+  b as modalCloseEscape,
   m as modalOutsideClick
 };

package/components/modal/modal.d.ts

@@ -11,6 +11,11 @@ export declare const modalOutsideClick: unique symbol;
  * and returned by the {@link ModalApi.open|open} method, when the modal is closed by a click on the close button.
  */
 export declare const modalCloseButtonClick: unique symbol;
+/**
+ * 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 pressing the Escape key.
+ */
+export declare const modalCloseEscape: unique symbol;
 /**
  * Properties of the modal widget that are also in the state of the modal.
  */

package/components/pagination/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const pagination = require("../../pagination-C1TT-oea.cjs");
+const pagination = require("../../pagination-DvZ2rLsz.cjs");
 exports.createPagination = pagination.createPagination;
 exports.getPaginationDefaultConfig = pagination.getPaginationDefaultConfig;

package/components/pagination/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../pagination-B97wBLok.js";
+import { c, g } from "../../pagination-BKbMROV6.js";
 export {
   c as createPagination,
   g as getPaginationDefaultConfig

package/components/progressbar/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const progressbar = require("../../progressbar-CRvhNB5R.cjs");
+const progressbar = require("../../progressbar-i9xfAxb7.cjs");
 exports.createProgressbar = progressbar.createProgressbar;
 exports.getProgressbarDefaultConfig = progressbar.getProgressbarDefaultConfig;

package/components/progressbar/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../progressbar-BWBlRk_Y.js";
+import { c, g } from "../../progressbar-D8zIcm9n.js";
 export {
   c as createProgressbar,
   g as getProgressbarDefaultConfig

package/components/rating/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const rating = require("../../rating-DAb6nR67.cjs");
+const rating = require("../../rating-DmG4oUkr.cjs");
 exports.createRating = rating.createRating;
 exports.getRatingDefaultConfig = rating.getRatingDefaultConfig;

package/components/rating/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../rating-BXvy9kXq.js";
+import { c, g } from "../../rating-DEXTGWCU.js";
 export {
   c as createRating,
   g as getRatingDefaultConfig

package/components/select/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const select = require("../../select-C0rJJQfl.cjs");
+const select = require("../../select-MFjAnIt7.cjs");
 exports.createSelect = select.createSelect;
 exports.getSelectDefaultConfig = select.getSelectDefaultConfig;

package/components/select/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../select-BdjpnE7_.js";
+import { c, g } from "../../select-Bw68Xdu5.js";
 export {
   c as createSelect,
   g as getSelectDefaultConfig

package/components/slider/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const slider = require("../../slider-DSx5CAce.cjs");
+const slider = require("../../slider-Dl4Trh32.cjs");
 exports.createSlider = slider.createSlider;
 exports.getSliderDefaultConfig = slider.getSliderDefaultConfig;

package/components/slider/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../slider-BmxQ3A_u.js";
+import { c, g } from "../../slider-Cx50Eghd.js";
 export {
   c as createSlider,
   g as getSliderDefaultConfig

package/components/slider/slider.d.ts

@@ -248,7 +248,7 @@ export interface SliderProps extends SliderCommonPropsAndState {
      *
      * @defaultValue
      * ```ts
-     * (value: number) => ''
+     * () => ''
      * ```
      */
     ariaValueText: (value: number, sortedIndex: number) => string;
@@ -280,21 +280,21 @@ export interface SliderProps extends SliderCommonPropsAndState {
      * Minimum distance between two values.
      * When set to 0, no minimum distance constraint is applied.
      *
-     * @defaultValue 0
+     * @defaultValue `0`
      */
     minRange: number;
     /**
      * Maximum distance between two values
      * When set to 0, no maximum distance constraint is applied.
      *
-     * @defaultValue 0
+     * @defaultValue `0`
      */
     maxRange: number;
     /**
      * When true, if moving a value would break the minRange or maxRange constraint,
      * it will instead push or pull the neighboring values to keep the allowed range rather than just stopping.
      *
-     * @defaultValue false
+     * @defaultValue `false`
      */
     pushRange: boolean;
 }

package/components/toast/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const toaster = require("../../toaster-Cayg6Lbq.cjs");
+const toaster = require("../../toaster-UDglac7x.cjs");
 exports.Toaster = toaster.Toaster;
 exports.createToast = toaster.createToast;
 exports.defaultToasterProps = toaster.defaultToasterProps;

package/components/toast/index.js

@@ -1,4 +1,4 @@
-import { T, c, d, g } from "../../toaster-XfzHDqz_.js";
+import { T, c, d, g } from "../../toaster-_p1GTtHI.js";
 export {
   T as Toaster,
   c as createToast,

package/components/tree/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const tree = require("../../tree-Pvr2rZ-D.cjs");
+const tree = require("../../tree-rGHtmCnS.cjs");
 exports.createTree = tree.createTree;
 exports.getTreeDefaultConfig = tree.getTreeDefaultConfig;

package/components/tree/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../tree-BFrXdJox.js";
+import { c, g } from "../../tree-DV0tfPlZ.js";
 export {
   c as createTree,
   g as getTreeDefaultConfig

package/components/tree/tree.d.ts

@@ -40,12 +40,6 @@ export interface NormalizedTreeItem extends TreeItem {
     children: NormalizedTreeItem[];
 }
 interface TreeCommonPropsAndState extends WidgetsCommonPropsAndState {
-    /**
-     * Optional accessibility label for the tree if there is no explicit label
-     *
-     * @defaultValue `''`
-     */
-    ariaLabel?: string;
 }
 /**
  * Interface representing the properties for the Tree component.

package/config.cjs

@@ -21,9 +21,9 @@ const mergeInto = (destination, source, levels = Infinity) => {
 };
 const createWidgetsConfig = (parent$, adaptParentConfig = utils_func.identity) => {
   const own$ = tansu.writable({});
-  const adaptedParent$ = adaptParentConfig === utils_func.identity ? parent$ : tansu.computed(() => adaptParentConfig(mergeInto({}, parent$ == null ? void 0 : parent$(), 2)));
+  const adaptedParent$ = adaptParentConfig === utils_func.identity ? parent$ : tansu.computed(() => adaptParentConfig(mergeInto({}, parent$?.(), 2)));
   return tansu.asWritable(
-    tansu.computed(() => mergeInto(mergeInto({}, adaptedParent$ == null ? void 0 : adaptedParent$(), 2), own$(), 2)),
+    tansu.computed(() => mergeInto(mergeInto({}, adaptedParent$?.(), 2), own$(), 2)),
     {
       ...own$,
       own$,

package/config.d.ts

@@ -11,6 +11,7 @@ import type { ToastProps } from './components/toast/toast';
 import type { TreeProps } from './components/tree/tree';
 import type { CarouselProps } from './components/carousel';
 import type { CollapseProps } from './components/collapse';
+import type { DrawerProps } from './components/drawer/drawer';
 /**
  * A utility type that makes all properties of an object type `T` optional,
  * and also makes all properties of the nested objects within `T` optional.
@@ -114,4 +115,8 @@ export type WidgetsConfig = {
      * collapse widget config
      */
     collapse: CollapseProps;
+    /**
+     * drawer widget config
+     */
+    drawer: DrawerProps;
 };

package/config.js

@@ -19,9 +19,9 @@ const mergeInto = (destination, source, levels = Infinity) => {
 };
 const createWidgetsConfig = (parent$, adaptParentConfig = identity) => {
   const own$ = writable({});
-  const adaptedParent$ = adaptParentConfig === identity ? parent$ : computed(() => adaptParentConfig(mergeInto({}, parent$ == null ? void 0 : parent$(), 2)));
+  const adaptedParent$ = adaptParentConfig === identity ? parent$ : computed(() => adaptParentConfig(mergeInto({}, parent$?.(), 2)));
   return asWritable(
-    computed(() => mergeInto(mergeInto({}, adaptedParent$ == null ? void 0 : adaptedParent$(), 2), own$(), 2)),
+    computed(() => mergeInto(mergeInto({}, adaptedParent$?.(), 2), own$(), 2)),
     {
       ...own$,
       own$,