@agnos-ui/react-headless 0.0.1-alpha.6 → 0.0.1-alpha.7

package/components/accordion/index.d.ts

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

package/components/accordion/index.js

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

package/components/alert/index.d.ts

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

package/components/alert/index.js

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

package/components/modal/index.d.ts

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

package/components/modal/index.js

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

package/components/pagination/index.d.ts

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

package/components/pagination/index.js

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

package/components/progressbar/index.d.ts

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

package/components/progressbar/index.js

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

package/components/rating/index.d.ts

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

package/components/rating/index.js

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

package/components/select/index.d.ts

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

package/components/select/index.js

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

package/components/slider/index.d.ts

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

package/components/slider/index.js

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

package/config.d.ts

@@ -10,6 +10,14 @@ type DefaultConfigInput<Config> = Partial2Levels<Config> & {
     adaptParentConfig?: (config: Partial2Levels<Config>) => Partial2Levels<Config>;
     children?: ReactNode | undefined;
 };
+/**
+ * A factory to create the use functions and react component to allow widgets to be context-aware.
+ *
+ * It can be used when extending the core and creating new widgets.
+ *
+ * @param widgetsConfigContext - the widgets config context
+ * @returns the use functions and react component
+ */
 export declare const widgetsConfigFactory: <Config extends {
     [widgetName: string]: object;
 } = WidgetsConfig>(widgetsConfigContext?: import("react").Context<WidgetsConfigStore<Config> | undefined>) => {

package/config.js

@@ -5,6 +5,14 @@ import { createContext, useContext, useEffect, useMemo } from 'react';
 import { useWidget } from './utils/widget';
 import { usePropsAsStore } from './utils/stores';
 export * from '@agnos-ui/core/config';
+/**
+ * A factory to create the use functions and react component to allow widgets to be context-aware.
+ *
+ * It can be used when extending the core and creating new widgets.
+ *
+ * @param widgetsConfigContext - the widgets config context
+ * @returns the use functions and react component
+ */
 export const widgetsConfigFactory = (widgetsConfigContext = createContext(undefined)) => {
     const useWidgetContext = (widgetName, defaultConfig) => {
         const widgetsConfig = useContext(widgetsConfigContext);
@@ -23,7 +31,9 @@ export const widgetsConfigFactory = (widgetsConfigContext = createContext(undefi
      * If adaptParentConfig is not specified, this step is skipped.
      * - second step: the configuration from step 1 is merged (2-levels deep) with the properties of the component.
      *
-     * @param adaptParentConfig - optional function that receives a 2-levels copy of the widgets default configuration
+     * @param componentInputs - the react component inputs
+     * @param componentInputs.children - the react component children
+     * @param componentInputs.adaptParentConfig - optional function that receives a 2-levels copy of the widgets default configuration
      * defined at an upper level in the Svelte context hierarchy (or an empty object if there is none) and returns the widgets
      * default configuration to be used.
      * It is called only if the configuration is needed, and was not yet computed for the current value of the parent configuration.

package/index.d.ts

@@ -1,9 +1,9 @@
-export * from './components/accordion/accordion';
-export * from './components/alert/alert';
-export * from './components/modal/modal';
-export * from './components/pagination/pagination';
-export * from './components/progressbar/progressbar';
-export * from './components/rating/rating';
-export * from './components/select/select';
-export * from './components/slider/slider';
+export * from './components/accordion';
+export * from './components/alert';
+export * from './components/modal';
+export * from './components/pagination';
+export * from './components/progressbar';
+export * from './components/rating';
+export * from './components/select';
+export * from './components/slider';
 export * from './generated';

package/index.js

@@ -1,9 +1,9 @@
-export * from './components/accordion/accordion';
-export * from './components/alert/alert';
-export * from './components/modal/modal';
-export * from './components/pagination/pagination';
-export * from './components/progressbar/progressbar';
-export * from './components/rating/rating';
-export * from './components/select/select';
-export * from './components/slider/slider';
+export * from './components/accordion';
+export * from './components/alert';
+export * from './components/modal';
+export * from './components/pagination';
+export * from './components/progressbar';
+export * from './components/rating';
+export * from './components/select';
+export * from './components/slider';
 export * from './generated';

package/package.json

@@ -39,8 +39,8 @@
 		}
 	},
 	"dependencies": {
-		"@agnos-ui/core": "0.0.1-alpha.6",
-		"@amadeus-it-group/tansu": "0.0.24",
+		"@agnos-ui/core": "0.0.1-alpha.7",
+		"@amadeus-it-group/tansu": "1.0.0",
 		"classnames": "^2.5.1"
 	},
 	"peerDependencies": {
@@ -48,7 +48,7 @@
 		"react-dom": "*"
 	},
 	"sideEffects": false,
-	"version": "0.0.1-alpha.6",
+	"version": "0.0.1-alpha.7",
 	"homepage": "https://amadeusitgroup.github.io/AgnosUI/latest/",
 	"bugs": "https://github.com/AmadeusITGroup/AgnosUI/issues",
 	"license": "MIT",

package/slot.d.ts

@@ -1,4 +1,14 @@
 import type { SlotContent } from './types';
+/**
+ * The React Slot component, allowing to extensively customize widgets.
+ *
+ * The input slotContent can be a react component, a function or jsx.
+ *
+ * @param parameter - the react component parameter
+ * @param parameter.slotContent - the slot content
+ * @param parameter.props - the react component props
+ * @returns the slot component
+ */
 export declare const Slot: <Props extends object>({ slotContent, props }: {
     slotContent: SlotContent<Props>;
     props: Props;

package/slot.js

@@ -15,6 +15,16 @@ const slotWrapper = (slotContent) => {
 };
 /* eslint-disable-next-line @typescript-eslint/ban-types */
 const isReactComponent = (item) => item.prototype instanceof Component;
+/**
+ * The React Slot component, allowing to extensively customize widgets.
+ *
+ * The input slotContent can be a react component, a function or jsx.
+ *
+ * @param parameter - the react component parameter
+ * @param parameter.slotContent - the slot content
+ * @param parameter.props - the react component props
+ * @returns the slot component
+ */
 export const Slot = ({ slotContent, props }) => {
     const isFunction = typeof slotContent === 'function';
     if (isFunction) {

package/utils/directive.js

@@ -1,6 +1,15 @@
 import { mergeDirectives } from '@agnos-ui/core/utils/directive';
 import { useCallback, useMemo, useRef } from 'react';
 export * from '@agnos-ui/core/utils/directive';
+/**
+ * The useDirective function.
+ *
+ * Allows to attach a provided directive to the current react component.
+ *
+ * @param directive - the directive
+ * @param args - the args to pass to the directive
+ * @returns the ref callback
+ */
 export function useDirective(directive, args) {
     const instance = useRef();
     const propsRef = useRef();
@@ -15,6 +24,15 @@ export function useDirective(directive, args) {
     instance.current?.update?.(args);
     return ref;
 }
+/**
+ * The useDirectives function.
+ *
+ * Allows to attach multiple directives to the current react component.
+ *
+ * @param directives - directives
+ * @param args - the args to pass to the directives
+ * @returns the ref callback
+ */
 export function useDirectives(directives, args) {
     const mergedDirectives = useMemo(() => mergeDirectives(...directives), directives);
     return useDirective(mergedDirectives, args);

package/utils/portal.d.ts

@@ -1,4 +1,12 @@
 import type { PropsWithChildren } from 'react';
+/**
+ * A Portal component, allowing to attach content to an external container.
+ *
+ * @param param - the react component inputs
+ * @param param.children - the react component children
+ * @param param.container - the container to attach the portal to
+ * @returns the portal component
+ */
 export declare const Portal: ({ children, container }: PropsWithChildren<{
     container: Element | DocumentFragment | null | undefined;
 }>) => import("react/jsx-runtime").JSX.Element;

package/utils/portal.js

@@ -1,3 +1,11 @@
 import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
 import { createPortal } from 'react-dom';
+/**
+ * A Portal component, allowing to attach content to an external container.
+ *
+ * @param param - the react component inputs
+ * @param param.children - the react component children
+ * @param param.container - the container to attach the portal to
+ * @returns the portal component
+ */
 export const Portal = ({ children, container }) => container ? createPortal(children, container) : _jsx(_Fragment, { children: children });

package/utils/stores.d.ts

@@ -1,4 +1,16 @@
 import type { ReadableSignal } from '@amadeus-it-group/tansu';
 export * from '@agnos-ui/core/utils/stores';
+/**
+ * Observe a readable store inside of a react component.
+ *
+ * @param store$ - the readable store
+ * @returns the observed value of the store
+ */
 export declare function useObservable<T>(store$: ReadableSignal<T>): T;
+/**
+ * Turn react props into readable stores.
+ *
+ * @param props - the props
+ * @returns the readable stores
+ */
 export declare const usePropsAsStore: <T extends object>(props?: Partial<T> | undefined) => ReadableSignal<Partial<T>>;

package/utils/stores.js

@@ -2,6 +2,12 @@ import { findChangedProperties } from '@agnos-ui/core/utils/stores';
 import { asReadable, writable } from '@amadeus-it-group/tansu';
 import { useEffect, useMemo, useRef, useState } from 'react';
 export * from '@agnos-ui/core/utils/stores';
+/**
+ * Observe a readable store inside of a react component.
+ *
+ * @param store$ - the readable store
+ * @returns the observed value of the store
+ */
 export function useObservable(store$) {
     const [value, setValue] = useState(() => store$());
     useEffect(() => {
@@ -14,6 +20,12 @@ export function useObservable(store$) {
     return value;
 }
 const propsEqual = (a, b) => !findChangedProperties(a, b);
+/**
+ * Turn react props into readable stores.
+ *
+ * @param props - the props
+ * @returns the readable stores
+ */
 export const usePropsAsStore = (props) => {
     const storeRef = useRef();
     if (!storeRef.current) {

package/utils/widget.d.ts

@@ -1,2 +1,12 @@
 import type { PropsConfig, Widget, WidgetFactory, WidgetProps, WidgetState } from '@agnos-ui/core/types';
+/**
+ * The useWidget function.
+ *
+ * Allows to create and attach an agnos-ui/core widget to the current react component.
+ *
+ * @param createWidget - the widget factory
+ * @param props - the props
+ * @param propsConfig - the props config
+ * @returns the state and api to track and interact with the widget
+ */
 export declare function useWidget<W extends Widget>(createWidget: WidgetFactory<W>, props?: Partial<WidgetProps<W>>, propsConfig?: PropsConfig<WidgetProps<W>>): [WidgetState<W>, W];

package/utils/widget.js

@@ -1,6 +1,16 @@
 import { findChangedProperties } from '@agnos-ui/core/utils/stores';
 import { useEffect, useMemo, useRef } from 'react';
 import { useObservable } from './stores';
+/**
+ * The useWidget function.
+ *
+ * Allows to create and attach an agnos-ui/core widget to the current react component.
+ *
+ * @param createWidget - the widget factory
+ * @param props - the props
+ * @param propsConfig - the props config
+ * @returns the state and api to track and interact with the widget
+ */
 export function useWidget(createWidget, props = {}, propsConfig) {
     const api = useMemo(() => createWidget({ ...propsConfig, props: { ...propsConfig?.props, ...props } }), []);
     const previousProps = useRef(props);