@agnos-ui/core 0.0.1-alpha.0 → 0.0.1-alpha.1

package/README.md

@@ -2,11 +2,11 @@
 
 [![npm](https://img.shields.io/npm/v/@agnos-ui/core)](https://www.npmjs.com/package/@agnos-ui/core)
 
-[AgnosUI](https://amadeusitgroup.github.io/AgnosUI/latest/) is a framework-agnostic widget library with adapters for multiple frameworks:
+[AgnosUI](https://amadeusitgroup.github.io/AgnosUI/latest/) is a framework-agnostic widget library with adapters for multiple frameworks, either [Bootstrap](https://getbootstrap.com/)-based or headless:
 
-- [Angular](https://www.npmjs.com/package/@agnos-ui/angular)
-- [React](https://www.npmjs.com/package/@agnos-ui/react)
-- [Svelte](https://www.npmjs.com/package/@agnos-ui/svelte)
+- [Angular](https://www.npmjs.com/package/@agnos-ui/angular), [Angular headless](https://www.npmjs.com/package/@agnos-ui/angular-headless)
+- [React](https://www.npmjs.com/package/@agnos-ui/react), [React headless](https://www.npmjs.com/package/@agnos-ui/react-headless)
+- [Svelte](https://www.npmjs.com/package/@agnos-ui/svelte), [Svelte headless](https://www.npmjs.com/package/@agnos-ui/svelte-headless)
 
 This `@agnos-ui/core` package contains the framework-agnostic common code used by the above framework adapters.
 

package/{dist/lib/accordion.d.ts → accordion.d.ts}

@@ -1,13 +1,8 @@
 import type { PropsConfig } from './services';
 import type { TransitionFn } from './transitions';
 import type { Directive, SlotContent, Widget, WidgetSlotContext } from './types';
-export interface AccordionCommonPropsAndState {
-    /**
-     * Classes to add on the accordion DOM element.
-     */
-    accordionClass: string;
-}
-export interface AccordionProps extends AccordionCommonPropsAndState {
+import type { WidgetsCommonPropsAndState } from './commonProps';
+export interface AccordionProps extends WidgetsCommonPropsAndState {
     /**
      * If `true`, only one item at the time can stay open.
      */
@@ -132,7 +127,7 @@ export interface AccordionProps extends AccordionCommonPropsAndState {
      */
     itemBodyClass: string;
 }
-export interface AccordionState extends AccordionCommonPropsAndState {
+export interface AccordionState extends WidgetsCommonPropsAndState {
     /**
      * Array containing all the accordion-items contained in the accordion.
      */

package/{dist/lib/accordion.js → accordion.js}

@@ -35,7 +35,7 @@ const defaultAccordionConfig = {
     closeOthers: false,
     onShown: noop,
     onHidden: noop,
-    accordionClass: '',
+    className: '',
     itemId: '',
     itemDestroyOnHide: false,
     itemDisabled: false,

package/{dist/lib/alert.d.ts → alert.d.ts}

@@ -1,8 +1,9 @@
+import type { WidgetsCommonPropsAndState } from './commonProps';
 import type { PropsConfig } from './services';
 import type { TransitionFn } from './transitions';
 import type { Directive, SlotContent, Widget, WidgetSlotContext } from './types';
 export type AlertContext = WidgetSlotContext<AlertWidget>;
-export interface AlertCommonPropsAndState {
+export interface AlertCommonPropsAndState 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.

package/{dist/lib/alert.js → alert.js}

@@ -15,6 +15,7 @@ const defaultConfig = {
     animation: true,
     animationOnInit: false,
     transition: fadeTransition,
+    className: '',
 };
 /**
  * Retrieve a shallow copy of the default alert config

package/commonProps.d.ts

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

package/commonProps.js

@@ -0,0 +1 @@
+export {};

package/{dist/lib/index.d.ts → index.d.ts}

@@ -9,3 +9,4 @@ export * from './config';
 export * from './modal/modal';
 export * from './alert';
 export * from './accordion';
+export * from './commonProps';

package/{dist/lib/index.js → index.js}

@@ -9,3 +9,4 @@ export * from './config';
 export * from './modal/modal';
 export * from './alert';
 export * from './accordion';
+export * from './commonProps';

package/{dist/lib/modal → modal}/modal.d.ts

@@ -1,6 +1,7 @@
 import type { PropsConfig } from '../services';
 import type { TransitionFn } from '../transitions';
 import type { Widget, Directive, SlotContent, WidgetSlotContext } from '../types';
+import type { WidgetsCommonPropsAndState } from '../commonProps';
 /**
  * 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 a click inside the viewport but outside the modal.
@@ -18,7 +19,7 @@ export type ModalContext = WidgetSlotContext<ModalWidget>;
 /**
  * Properties of the modal widget that are also in the state of the modal.
  */
-export interface ModalCommonPropsAndState {
+export interface ModalCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * Value of the aria-label attribute to put on the close button.
      */
@@ -37,10 +38,6 @@ export interface ModalCommonPropsAndState {
      * Otherwise, they stay where the widget is located.
      */
     container: HTMLElement | null;
-    /**
-     * Classes to add on the modal DOM element.
-     */
-    modalClass: string;
     /**
      * Body of the modal.
      */
@@ -280,10 +277,6 @@ export declare function getModalDefaultConfig(): {
      * Otherwise, they stay where the widget is located.
      */
     container: HTMLElement | null;
-    /**
-     * Classes to add on the modal DOM element.
-     */
-    modalClass: string;
     /**
      * Body of the modal.
      */
@@ -309,6 +302,7 @@ export declare function getModalDefaultConfig(): {
      * Whether the modal should be visible when the transition is completed.
      */
     visible: boolean;
+    className: string;
 };
 /**
  * Creates a new modal widget instance.

package/{dist/lib/modal → modal}/modal.js

@@ -24,7 +24,7 @@ const defaultConfig = {
     closeButton: true,
     closeOnOutsideClick: true,
     container: typeof window !== 'undefined' ? document.body : null,
-    modalClass: '',
+    className: '',
     modalTransition: fadeTransition,
     onBeforeClose: noop,
     onVisibleChange: noop,

package/package.json

@@ -1,52 +1,38 @@
 {
 	"name": "@agnos-ui/core",
 	"description": "Framework-agnostic headless widget library.",
-	"homepage": "https://amadeusitgroup.github.io/AgnosUI/latest/",
 	"keywords": [
 		"headless",
 		"agnostic",
 		"components",
 		"widgets",
+		"accordion",
 		"alert",
 		"modal",
 		"pagination",
 		"rating"
 	],
 	"type": "module",
-	"main": "./dist/lib/index.js",
-	"module": "./dist/lib/index.js",
-	"types": "./dist/lib/index.d.ts",
+	"main": "./index.js",
+	"module": "./index.js",
+	"types": "./index.d.ts",
 	"exports": {
 		".": {
-			"types": "./dist/lib/index.d.ts",
-			"default": "./dist/lib/index.js"
+			"types": "./index.d.ts",
+			"default": "./index.js"
 		}
 	},
-	"scripts": {
-		"build": "npm run build:lib && npm run build:tsc && npm run build:api-extractor",
-		"build:lib": "node ../scripts/rm.js dist/lib && tsc -p tsconfig.lib.json",
-		"build:tsc": "tsc",
-		"build:api-extractor": "api-extractor run",
-		"test": "vitest run",
-		"tdd": "vitest",
-		"tdd:ui": "vitest --ui",
-		"test:coverage": "vitest run --coverage"
-	},
 	"dependencies": {
 		"@amadeus-it-group/tansu": "0.0.22"
 	},
-	"files": [
-		"dist/lib"
-	],
-	"license": "MIT",
+	"sideEffects": false,
+	"version": "0.0.1-alpha.1",
+	"homepage": "https://amadeusitgroup.github.io/AgnosUI/latest/",
 	"bugs": "https://github.com/AmadeusITGroup/AgnosUI/issues",
+	"license": "MIT",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/AmadeusITGroup/AgnosUI.git",
-		"directory": "core"
-	},
-	"devDependencies": {
-		"eslint-plugin-jsdoc": "^46.4.6"
-	},
-	"version": "0.0.1-alpha.0"
-}
+		"directory": "core/lib"
+	}
+}

package/{dist/lib/pagination.d.ts → pagination.d.ts}

@@ -1,5 +1,6 @@
 import type { PropsConfig } from './services';
 import type { Widget, SlotContent, WidgetSlotContext } from './types';
+import type { WidgetsCommonPropsAndState } from './commonProps';
 /**
  * A type for the slot context of the pagination widget
  */
@@ -13,7 +14,7 @@ export interface PaginationNumberContext extends PaginationContext {
      */
     displayedPage: number;
 }
-export interface PaginationCommonPropsAndState {
+export interface PaginationCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * The current page.
      *
@@ -86,11 +87,6 @@ export interface PaginationCommonPropsAndState {
      * @defaultValue false
      */
     boundaryLinks: boolean;
-    /**
-     * An input to add a custom class to the UL
-     * @defaultValue ''
-     */
-    className: string;
     /**
      * The template to use for the ellipsis slot
      * for I18n, we suggest to use the global configuration
@@ -398,11 +394,6 @@ export declare function getPaginationDefaultConfig(): {
      * @defaultValue false
      */
     boundaryLinks: boolean;
-    /**
-     * An input to add a custom class to the UL
-     * @defaultValue ''
-     */
-    className: string;
     /**
      * The template to use for the ellipsis slot
      * for I18n, we suggest to use the global configuration
@@ -455,10 +446,11 @@ export declare function getPaginationDefaultConfig(): {
      * @param displayedPage - The current page number
      */
     slotNumberLabel: SlotContent<PaginationNumberContext>;
+    className: string;
 };
 /**
  * Create a PaginationWidget with given config props
- * @param config - an optional alert config
+ * @param config - an optional pagination config
  * @returns a PaginationWidget
  */
 export declare function createPagination(config?: PropsConfig<PaginationProps>): PaginationWidget;

package/{dist/lib/pagination.js → pagination.js}

@@ -64,7 +64,7 @@ const configValidator = {
 };
 /**
  * Create a PaginationWidget with given config props
- * @param config - an optional alert config
+ * @param config - an optional pagination config
  * @returns a PaginationWidget
  */
 export function createPagination(config) {

package/{dist/lib/rating.d.ts → rating.d.ts}

@@ -1,5 +1,6 @@
 import type { PropsConfig } from './services';
 import type { SlotContent, Widget } from './types';
+import type { WidgetsCommonPropsAndState } from './commonProps';
 export interface StarContext {
     /**
      * indicates how much the current star is filled, from 0 to 100
@@ -10,7 +11,7 @@ export interface StarContext {
      */
     index: number;
 }
-export interface RatingCommonPropsAndState {
+export interface RatingCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * The current rating. Could be a decimal value like `3.75`.
      */
@@ -38,10 +39,6 @@ export interface RatingCommonPropsAndState {
      * If the component is disabled, `tabindex` will still be set to `-1`.
      */
     tabindex: number;
-    /**
-     * Classname to be applied on the rating container
-     */
-    className: string;
     /**
      * The template to override the way each star is displayed.
      */
@@ -184,10 +181,6 @@ export declare function getRatingDefaultConfig(): {
      * If the component is disabled, `tabindex` will still be set to `-1`.
      */
     tabindex: number;
-    /**
-     * Classname to be applied on the rating container
-     */
-    className: string;
     /**
      * The template to override the way each star is displayed.
      */
@@ -200,6 +193,7 @@ export declare function getRatingDefaultConfig(): {
      * The aria labelled by
      */
     ariaLabelledBy: string;
+    className: string;
 };
 /**
  * Create a RatingWidget with given config props

package/{dist/lib/select.d.ts → select.d.ts}

@@ -1,11 +1,8 @@
 import type { HasFocus } from './services/focustrack';
 import type { PropsConfig } from './services/stores';
 import type { Widget } from './types';
-export interface SelectCommonPropsAndState<Item> {
-    /**
-     * the class to attach to the select DOM element
-     */
-    className: string;
+import type { WidgetsCommonPropsAndState } from './commonProps';
+export interface SelectCommonPropsAndState<Item> extends WidgetsCommonPropsAndState {
     /**
      * List of selected items
      */

package/{dist/lib/services → services}/index.d.ts

@@ -1,6 +1,7 @@
 export * from './siblingsInert';
 export * from './directiveUtils';
 export * from './focustrack';
+export * from './intersection';
 export * from './portal';
 export * from './stores';
 export * from './writables';

package/{dist/lib/services → services}/index.js

@@ -1,6 +1,7 @@
 export * from './siblingsInert';
 export * from './directiveUtils';
 export * from './focustrack';
+export * from './intersection';
 export * from './portal';
 export * from './stores';
 export * from './writables';

package/services/intersection.d.ts

@@ -0,0 +1,26 @@
+import type { PropsConfig } from './stores';
+export interface IntersectionProps {
+    /**
+     * elements to observe
+     */
+    elements: HTMLElement[];
+    /**
+     * IntersectionObserverInit used in the IntersectionObserver
+     *
+     * See the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/IntersectionObserver#options)
+     */
+    options: Partial<IntersectionObserverInit> | undefined;
+}
+export declare const createIntersection: (config?: PropsConfig<IntersectionProps>) => {
+    /**
+     * Readable of observed elements
+     */
+    elements$: import("@amadeus-it-group/tansu").ReadableSignal<HTMLElement[]>;
+    /**
+     * Store of map that contains the visible elements (for the key) and the corresponding entries
+     *
+     * See the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserverEntry)
+     */
+    visibleElements$: import("@amadeus-it-group/tansu").ReadableSignal<Map<Element, IntersectionObserverEntry>>;
+    patch: <U extends Partial<IntersectionProps>>(storesValues?: void | U | undefined) => void;
+};

package/services/intersection.js

@@ -0,0 +1,47 @@
+import { asReadable, derived } from '@amadeus-it-group/tansu';
+import { noop } from '../utils';
+import { writablesForProps } from './stores';
+const defaultValues = {
+    elements: [],
+    options: undefined,
+};
+export const createIntersection = (config) => {
+    const [{ elements$, options$ }, patch] = writablesForProps(defaultValues, config);
+    const visibleElements$ = derived([elements$, options$], ([elements, options], set) => {
+        if (elements.length) {
+            const visibleElements = new Map();
+            const observer = new IntersectionObserver((entries) => {
+                for (const entry of entries) {
+                    const { target, isIntersecting } = entry;
+                    if (isIntersecting) {
+                        visibleElements.set(target, entry);
+                    }
+                    else {
+                        visibleElements.delete(target);
+                    }
+                }
+                set(visibleElements);
+            }, options);
+            for (const element of elements) {
+                observer.observe(element);
+            }
+            return () => {
+                observer.disconnect();
+            };
+        }
+        return noop;
+    }, new Map());
+    return {
+        /**
+         * Readable of observed elements
+         */
+        elements$: asReadable(elements$),
+        /**
+         * Store of map that contains the visible elements (for the key) and the corresponding entries
+         *
+         * See the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserverEntry)
+         */
+        visibleElements$: asReadable(visibleElements$),
+        patch,
+    };
+};

package/dist/lib/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.36.4"
-    }
-  ]
-}