@agnos-ui/core 0.9.1 → 0.9.3

package/collapse-DRp53EuG.cjs

@@ -0,0 +1,81 @@
+"use strict";
+const services_transitions_baseTransitions = require("./services/transitions/baseTransitions.cjs");
+const utils_stores = require("./utils/stores.cjs");
+const utils_directive = require("./dom-CuBx1JPZ.cjs");
+const utils_writables = require("./writables-Bn3uhKEG.cjs");
+const tansu = require("@amadeus-it-group/tansu");
+const utils_func = require("./utils/func.cjs");
+const utils_widget = require("./utils/widget.cjs");
+const defaultCollapseConfig = {
+  visible: false,
+  onVisibleChange: utils_func.noop,
+  onShown: utils_func.noop,
+  onHidden: utils_func.noop,
+  animated: true,
+  animatedOnInit: false,
+  id: "",
+  transition: utils_func.noop
+};
+function getCollapseDefaultConfig() {
+  return { ...defaultCollapseConfig };
+}
+const commonCollapseConfigValidator = {
+  onVisibleChange: utils_writables.typeFunction,
+  onHidden: utils_writables.typeFunction,
+  onShown: utils_writables.typeFunction,
+  animatedOnInit: utils_writables.typeBoolean,
+  animated: utils_writables.typeBoolean,
+  visible: utils_writables.typeBoolean,
+  id: utils_writables.typeString,
+  transition: utils_writables.typeFunction
+};
+const createCollapse = utils_widget.createWidgetFactory("collapse", (config) => {
+  const [
+    { transition$, animatedOnInit$, animated$, visible$: requestedVisible$, onVisibleChange$, onHidden$, onShown$, id$: _dirtyId$, ...stateProps },
+    patch
+  ] = utils_stores.writablesForProps(defaultCollapseConfig, config, commonCollapseConfigValidator);
+  const id$ = utils_stores.idWithDefault(_dirtyId$);
+  const transition = services_transitions_baseTransitions.createTransition({
+    props: {
+      transition: transition$,
+      visible: requestedVisible$,
+      animated: animated$,
+      animatedOnInit: animatedOnInit$,
+      onVisibleChange: onVisibleChange$,
+      onHidden: onHidden$,
+      onShown: onShown$
+    }
+  });
+  const visible$ = transition.stores.visible$;
+  const hidden$ = transition.stores.hidden$;
+  return {
+    ...utils_stores.stateStores({ ...stateProps, visible$, hidden$ }),
+    patch,
+    api: {
+      open: transition.api.show,
+      close: transition.api.hide,
+      toggle: transition.api.toggle
+    },
+    directives: {
+      collapseDirective: utils_directive.mergeDirectives(
+        transition.directives.directive,
+        utils_directive.createAttributesDirective(() => ({
+          attributes: {
+            id: id$
+          }
+        }))
+      ),
+      triggerDirective: utils_directive.createAttributesDirective(() => ({
+        attributes: {
+          "aria-expanded": tansu.computed(() => `${visible$()}`),
+          "aria-controls": id$
+        },
+        events: {
+          click: () => transition.api.toggle()
+        }
+      }))
+    }
+  };
+});
+exports.createCollapse = createCollapse;
+exports.getCollapseDefaultConfig = getCollapseDefaultConfig;

package/collapse-DwXz2kNw.js

@@ -0,0 +1,82 @@
+import { createTransition } from "./services/transitions/baseTransitions.js";
+import { writablesForProps, idWithDefault, stateStores } from "./utils/stores.js";
+import { n as createAttributesDirective, k as mergeDirectives } from "./dom-gfxqXJpK.js";
+import { g as typeFunction, e as typeString, c as typeBoolean } from "./writables-CgpOQ4hA.js";
+import { computed } from "@amadeus-it-group/tansu";
+import { noop } from "./utils/func.js";
+import { createWidgetFactory } from "./utils/widget.js";
+const defaultCollapseConfig = {
+  visible: false,
+  onVisibleChange: noop,
+  onShown: noop,
+  onHidden: noop,
+  animated: true,
+  animatedOnInit: false,
+  id: "",
+  transition: noop
+};
+function getCollapseDefaultConfig() {
+  return { ...defaultCollapseConfig };
+}
+const commonCollapseConfigValidator = {
+  onVisibleChange: typeFunction,
+  onHidden: typeFunction,
+  onShown: typeFunction,
+  animatedOnInit: typeBoolean,
+  animated: typeBoolean,
+  visible: typeBoolean,
+  id: typeString,
+  transition: typeFunction
+};
+const createCollapse = createWidgetFactory("collapse", (config) => {
+  const [
+    { transition$, animatedOnInit$, animated$, visible$: requestedVisible$, onVisibleChange$, onHidden$, onShown$, id$: _dirtyId$, ...stateProps },
+    patch
+  ] = writablesForProps(defaultCollapseConfig, config, commonCollapseConfigValidator);
+  const id$ = idWithDefault(_dirtyId$);
+  const transition = createTransition({
+    props: {
+      transition: transition$,
+      visible: requestedVisible$,
+      animated: animated$,
+      animatedOnInit: animatedOnInit$,
+      onVisibleChange: onVisibleChange$,
+      onHidden: onHidden$,
+      onShown: onShown$
+    }
+  });
+  const visible$ = transition.stores.visible$;
+  const hidden$ = transition.stores.hidden$;
+  return {
+    ...stateStores({ ...stateProps, visible$, hidden$ }),
+    patch,
+    api: {
+      open: transition.api.show,
+      close: transition.api.hide,
+      toggle: transition.api.toggle
+    },
+    directives: {
+      collapseDirective: mergeDirectives(
+        transition.directives.directive,
+        createAttributesDirective(() => ({
+          attributes: {
+            id: id$
+          }
+        }))
+      ),
+      triggerDirective: createAttributesDirective(() => ({
+        attributes: {
+          "aria-expanded": computed(() => `${visible$()}`),
+          "aria-controls": id$
+        },
+        events: {
+          click: () => transition.api.toggle()
+        }
+      }))
+    }
+  };
+});
+export {
+  createCollapse as c,
+  getCollapseDefaultConfig as g
+};

package/components/collapse/collapse.d.ts

@@ -0,0 +1,132 @@
+import { type TransitionFn } from '../../services/transitions/baseTransitions';
+import type { Directive, Widget, WidgetFactory } from '../../types';
+/**
+ * Interface representing the common properties and state for a collapse component.
+ */
+interface CollapseCommonPropsAndState {
+    /**
+     * If `true` the collapse is visible to the user
+     *
+     * @defaultValue `true`
+     */
+    visible: boolean;
+}
+/**
+ * Represents the state of a Collapse component.
+ */
+export interface CollapseState extends CollapseCommonPropsAndState {
+    /**
+     * Is `true` when the collapse is hidden. Compared to `visible`, this is updated after the transition is executed.
+     */
+    hidden: boolean;
+}
+/**
+ * Properties for the Collapse component.
+ */
+export interface CollapseProps extends CollapseCommonPropsAndState {
+    /**
+     * Callback called when the collapse visibility changed.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     * @param visible - The new visibility state of the collapse.
+     */
+    onVisibleChange: (visible: boolean) => void;
+    /**
+     * Callback called when the collapse is hidden.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    onHidden: () => void;
+    /**
+     * Callback called when the collapse is shown.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
+     */
+    onShown: () => void;
+    /**
+     * If `true`, collapse opening will be animated at init time.
+     *
+     * @defaultValue `false`
+     */
+    animatedOnInit: boolean;
+    /**
+     * If `true`, collapse closing and opening will be animated.
+     *
+     * @defaultValue `true`
+     */
+    animated: boolean;
+    /**
+     * id of the collapse
+     *
+     * @defaultValue `''`
+     */
+    id: string;
+    /**
+     * The transition function will be executed when the collapse is displayed or hidden.
+     *
+     * Depending on the value of `animatedOnInit`, the animation can be optionally skipped during the showing process.
+     *
+     * @defaultValue `() => {}`
+     */
+    transition: TransitionFn;
+}
+/**
+ * Interface representing the API for a collapsible component.
+ */
+export interface CollapseApi {
+    /**
+     * Triggers collapse closing programmatically.
+     */
+    close(): void;
+    /**
+     * Triggers the collapse content to be displayed for the user.
+     */
+    open(): void;
+    /**
+     * Toggles the collapse content visibility.
+     */
+    toggle(): void;
+}
+/**
+ * Interface representing the directives used in a collapse component.
+ */
+export interface CollapseDirectives {
+    /**
+     * Directive to apply the collapse.
+     */
+    collapseDirective: Directive;
+    /**
+     * Directive to apply to a trigger;
+     */
+    triggerDirective: Directive;
+}
+/**
+ * Represents a widget for handling collapse functionality.
+ *
+ * This type defines the structure of a CollapseWidget, which includes properties, state, API, and directives
+ * necessary for managing the collapse behavior in the UI.
+ *
+ * @type {Widget<CollapseProps, CollapseState, CollapseApi, CollapseDirectives>}
+ */
+export type CollapseWidget = Widget<CollapseProps, CollapseState, CollapseApi, CollapseDirectives>;
+/**
+ * Retrieve a shallow copy of the default collapse config
+ * @returns the default collapse config
+ */
+export declare function getCollapseDefaultConfig(): CollapseProps;
+/**
+ * Create an CollapseWidget factory
+ * @param transitionFn - the transition function that will be used for the collapse
+ * @returns an CollapseWidget
+ */
+export declare const createCollapse: WidgetFactory<CollapseWidget>;
+export {};

package/components/collapse/index.cjs

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const collapse = require("../../collapse-DRp53EuG.cjs");
+exports.createCollapse = collapse.createCollapse;
+exports.getCollapseDefaultConfig = collapse.getCollapseDefaultConfig;

package/components/collapse/index.d.ts

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

package/components/collapse/index.js

@@ -0,0 +1,5 @@
+import { c, g } from "../../collapse-DwXz2kNw.js";
+export {
+  c as createCollapse,
+  g as getCollapseDefaultConfig
+};

package/config.d.ts

@@ -10,6 +10,7 @@ import type { SliderProps } from './components/slider/slider';
 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';
 /**
  * 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.
@@ -109,4 +110,8 @@ export type WidgetsConfig = {
      * carousel widget config
      */
     carousel: CarouselProps;
+    /**
+     * collapse widget config
+     */
+    collapse: CollapseProps;
 };

package/index.cjs

@@ -3,6 +3,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const types = require("./types.cjs");
 const accordion = require("./accordion-cR5JqWJ8.cjs");
 const alert = require("./alert-DtDozJal.cjs");
+const collapse = require("./collapse-DRp53EuG.cjs");
 const modal = require("./modal-BEnQ6c5M.cjs");
 const pagination = require("./pagination-C1TT-oea.cjs");
 const progressbar = require("./progressbar-CRvhNB5R.cjs");
@@ -36,6 +37,8 @@ exports.factoryCreateAccordion = accordion.factoryCreateAccordion;
 exports.getAccordionDefaultConfig = accordion.getAccordionDefaultConfig;
 exports.createAlert = alert.createAlert;
 exports.getAlertDefaultConfig = alert.getAlertDefaultConfig;
+exports.createCollapse = collapse.createCollapse;
+exports.getCollapseDefaultConfig = collapse.getCollapseDefaultConfig;
 exports.createModal = modal.createModal;
 exports.getModalDefaultConfig = modal.getModalDefaultConfig;
 exports.modalCloseButtonClick = modal.modalCloseButtonClick;

package/index.d.ts

@@ -1,6 +1,7 @@
 export * from './types';
 export * from './components/accordion';
 export * from './components/alert';
+export * from './components/collapse';
 export * from './components/modal';
 export * from './components/pagination';
 export * from './components/progressbar';

package/index.js

@@ -1,14 +1,15 @@
 import { FACTORY_WIDGET_NAME, INVALID_VALUE } from "./types.js";
 import { a, c, f, g } from "./accordion-CoM4efp-.js";
 import { c as c2, g as g2 } from "./alert-YIlqdEPO.js";
-import { c as c3, g as g3, a as a2, m } from "./modal-D3wGIDlj.js";
-import { c as c4, g as g4 } from "./pagination-B97wBLok.js";
-import { c as c5, g as g5 } from "./progressbar-BWBlRk_Y.js";
-import { c as c6, g as g6 } from "./rating-BXvy9kXq.js";
-import { c as c7, g as g7 } from "./select-BdjpnE7_.js";
-import { c as c8, g as g8 } from "./slider-BmxQ3A_u.js";
-import { T, c as c9, d, g as g9 } from "./toaster-XfzHDqz_.js";
-import { c as c10, g as g10 } from "./tree-BFrXdJox.js";
+import { c as c3, g as g3 } from "./collapse-DwXz2kNw.js";
+import { c as c4, g as g4, a as a2, m } from "./modal-D3wGIDlj.js";
+import { c as c5, g as g5 } from "./pagination-B97wBLok.js";
+import { c as c6, g as g6 } from "./progressbar-BWBlRk_Y.js";
+import { c as c7, g as g7 } from "./rating-BXvy9kXq.js";
+import { c as c8, g as g8 } from "./select-BdjpnE7_.js";
+import { c as c9, g as g9 } from "./slider-BmxQ3A_u.js";
+import { T, c as c10, d, g as g10 } from "./toaster-XfzHDqz_.js";
+import { c as c11, g as g11 } from "./tree-BFrXdJox.js";
 import { createWidgetsConfig, mergeInto } from "./config.js";
 import { extendWidgetProps } from "./services/extendWidget.js";
 import { createFloatingUI } from "./services/floatingUI.js";
@@ -23,9 +24,9 @@ import { hash$ } from "./services/hash.js";
 import { createTransition, noAnimation } from "./services/transitions/baseTransitions.js";
 import { createCSSTransition, getTransitionDurationMs, hasTransition } from "./services/transitions/cssTransitions.js";
 import { createSimpleClassTransition } from "./services/transitions/simpleClassTransition.js";
-import { o, a as a3, c as c11, b, p, n, g as g11, j, f as f2, h, q, d as d2, e, i, m as m2, k, l, r, s } from "./dom-gfxqXJpK.js";
+import { o, a as a3, c as c12, b, p, n, g as g12, j, f as f2, h, q, d as d2, e, i, m as m2, k, l, r, s } from "./dom-gfxqXJpK.js";
 import { bindableDerived, bindableProp, createPatch, false$, findChangedProperties, idWithDefault, isStore, mergeConfigStores, normalizeConfigStores, stateStores, toReadableStore, toWritableStore, true$, writableWithDefault, writablesForProps, writablesWithDefault } from "./utils/stores.js";
-import { j as j2, t, i as i2, c as c12, d as d3, g as g12, h as h2, a as a4, b as b2, e as e2, f as f3 } from "./writables-CgpOQ4hA.js";
+import { j as j2, t, i as i2, c as c13, d as d3, g as g13, h as h2, a as a4, b as b2, e as e2, f as f3 } from "./writables-CgpOQ4hA.js";
 export {
   FACTORY_WIDGET_NAME,
   INVALID_VALUE,
@@ -33,7 +34,7 @@ export {
   activeElement$,
   o as attributesData,
   a3 as bindDirective,
-  c11 as bindDirectiveNoArg,
+  c12 as bindDirectiveNoArg,
   bindableDerived,
   bindableProp,
   b as browserDirective,
@@ -42,28 +43,29 @@ export {
   c as createAccordionItem,
   c2 as createAlert,
   n as createAttributesDirective,
-  g11 as createBrowserStoreArrayDirective,
+  g12 as createBrowserStoreArrayDirective,
   j as createBrowserStoreDirective,
   createCSSTransition,
+  c3 as createCollapse,
   createFloatingUI,
   createHasFocus,
   createIntersection,
   createMatchMedia,
-  c3 as createModal,
+  c4 as createModal,
   createNavManager,
-  c4 as createPagination,
+  c5 as createPagination,
   createPatch,
-  c5 as createProgressbar,
-  c6 as createRating,
+  c6 as createProgressbar,
+  c7 as createRating,
   createResizeObserver,
-  c7 as createSelect,
+  c8 as createSelect,
   createSimpleClassTransition,
-  c8 as createSlider,
+  c9 as createSlider,
   f2 as createStoreArrayDirective,
   h as createStoreDirective,
-  c9 as createToast,
+  c10 as createToast,
   createTransition,
-  c10 as createTree,
+  c11 as createTree,
   j2 as createTypeEnum,
   createWidgetsConfig,
   d as defaultToasterProps,
@@ -76,16 +78,17 @@ export {
   findChangedProperties,
   g as getAccordionDefaultConfig,
   g2 as getAlertDefaultConfig,
+  g3 as getCollapseDefaultConfig,
   getKeyName,
-  g3 as getModalDefaultConfig,
-  g4 as getPaginationDefaultConfig,
-  g5 as getProgressbarDefaultConfig,
-  g6 as getRatingDefaultConfig,
-  g7 as getSelectDefaultConfig,
-  g8 as getSliderDefaultConfig,
-  g9 as getToastDefaultConfig,
+  g4 as getModalDefaultConfig,
+  g5 as getPaginationDefaultConfig,
+  g6 as getProgressbarDefaultConfig,
+  g7 as getRatingDefaultConfig,
+  g8 as getSelectDefaultConfig,
+  g9 as getSliderDefaultConfig,
+  g10 as getToastDefaultConfig,
   getTransitionDurationMs,
-  g10 as getTreeDefaultConfig,
+  g11 as getTreeDefaultConfig,
   hasTransition,
   hash$,
   idWithDefault,
@@ -111,9 +114,9 @@ export {
   toWritableStore,
   true$,
   i2 as typeArray,
-  c12 as typeBoolean,
+  c13 as typeBoolean,
   d3 as typeBooleanOrNull,
-  g12 as typeFunction,
+  g13 as typeFunction,
   h2 as typeHTMLElementOrNull,
   a4 as typeNumber,
   b2 as typeNumberInRangeFactory,

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@agnos-ui/core",
 	"description": "Framework-agnostic headless component library.",
-	"version": "0.9.1",
+	"version": "0.9.3",
 	"type": "module",
 	"main": "./index.cjs",
 	"module": "./index.js",