@agnos-ui/core 0.4.3 → 0.5.0-next.0

package/components/modal/modal.d.ts

@@ -193,24 +193,6 @@ export interface ModalApi {
      */
     patch: ModalWidget['patch'];
 }
-/**
- * Actions of the modal widget.
- */
-export interface ModalActions {
-    /**
-     * Action to be called when the user clicks on the close button. It closes the modal with the {@link modalCloseButtonClick} result.
-     * @param event - mouse event
-     */
-    closeButtonClick(event: Pick<MouseEvent, never>): void;
-    /**
-     * Action to be called when the user clicks on the modal DOM element (which is supposed to have the size of the full viewport).
-     * If the click is not done on a descendant of the modal DOM element, it is considered to be done outside the modal
-     * and, depending on the value of the {@link ModalProps.closeOnOutsideClick|closeOnOutsideClick} prop, the modal is or isn't closed
-     * (with the {@link modalOutsideClick} result).
-     * @param event - mouse event
-     */
-    modalClick(event: Pick<MouseEvent, 'target' | 'currentTarget'>): void;
-}
 /**
  * Directives of the modal widget.
  */
@@ -236,133 +218,19 @@ export interface ModalDirectives {
      */
     closeButtonDirective: Directive;
     /**
-     * Directive to apply to the dialog element when using the native [HTMLDialogElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement)
+     * Directive to apply to the dialog element when using the native {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement | HTMLDialogElement}
      */
     dialogDirective: Directive;
 }
 /**
  * Modal widget.
  */
-export type ModalWidget = Widget<ModalProps, ModalState, ModalApi, ModalActions, ModalDirectives>;
+export type ModalWidget = Widget<ModalProps, ModalState, ModalApi, ModalDirectives>;
 /**
  * Returns a copy of the default modal config.
  * @returns a copy of the default modal config
  */
-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;
-    /**
-     * Event to be triggered when the modal is about to be closed (i.e. the {@link ModalApi.close|close} method was called).
-     *
-     * @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;
-};
+export declare function getModalDefaultConfig(): ModalProps;
 /**
  * Creates a new modal widget instance.
  * @param config$ - config of the modal, either as a store or as an object containing values or stores.

package/components/pagination/index.cjs

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

package/components/pagination/index.js

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

package/components/pagination/pagination.d.ts

@@ -1,5 +1,8 @@
 import type { PropsConfig, Widget, Directive } from '../../types';
 import type { WidgetsCommonPropsAndState } from '../commonProps';
+/**
+ * Interface representing the common properties and state for a pagination component.
+ */
 interface PaginationCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * The current page.
@@ -9,14 +12,6 @@ interface PaginationCommonPropsAndState extends WidgetsCommonPropsAndState {
      * @defaultValue `1`
      */
     page: number;
-    /**
-     * The pagination display size.
-     *
-     * Bootstrap currently supports small and large sizes.
-     *
-     * @defaultValue `null`
-     */
-    size: 'sm' | 'lg' | null;
     /**
      * The label for the nav element.
      *
@@ -108,6 +103,9 @@ interface PaginationCommonPropsAndState extends WidgetsCommonPropsAndState {
      */
     boundaryLinks: boolean;
 }
+/**
+ * Interface representing the properties for the Pagination component.
+ */
 export interface PaginationProps extends PaginationCommonPropsAndState {
     /**
      * The number of items in your paginated collection.
@@ -184,7 +182,7 @@ export interface PaginationProps extends PaginationCommonPropsAndState {
      *
      * @defaultValue
      * ```ts
-     * (currentPage: number, pageCount: number) => `Current page is ${currentPage}`
+     * (currentPage: number) => `Current page is ${currentPage}`
      * ```
      */
     ariaLiveLabel: (currentPage: number, pageCount: number) => string;
@@ -200,6 +198,9 @@ export interface PaginationProps extends PaginationCommonPropsAndState {
      */
     pageLink: (pageNumber: number) => string;
 }
+/**
+ * Interface representing the hrefs for pagination navigation links.
+ */
 export interface DirectionsHrefs {
     /**
      * The href for the 'Previous' navigation link
@@ -210,6 +211,9 @@ export interface DirectionsHrefs {
      */
     next: string;
 }
+/**
+ * Represents the state of the pagination component.
+ */
 export interface PaginationState extends PaginationCommonPropsAndState {
     /**
      * The number of pages.
@@ -238,29 +242,35 @@ export interface PaginationState extends PaginationCommonPropsAndState {
     /** The aria-live text */
     ariaLiveLabelText: string;
 }
-export interface PaginationActions {
+/**
+ * Interface representing pagination API for navigating through pages.
+ */
+export interface PaginationApi {
     /**
      * To "go" to a specific page
      * @param page - The page number to select
      */
-    select(page: number, event?: MouseEvent): void;
+    select(page: number): void;
     /**
      * To "go" to the first page
      */
-    first(event?: MouseEvent): void;
+    first(): void;
     /**
      * To "go" to the previous page
      */
-    previous(event?: MouseEvent): void;
+    previous(): void;
     /**
      * To "go" to the next page
      */
-    next(event?: MouseEvent): void;
+    next(): void;
     /**
      * To "go" to the last page
      */
-    last(event?: MouseEvent): void;
+    last(): void;
 }
+/**
+ * Interface representing the directives for pagination components.
+ */
 export interface PaginationDirectives {
     /**
      * A directive to be applied to each page link
@@ -286,212 +296,15 @@ export interface PaginationDirectives {
      */
     pageLast: Directive;
 }
-export interface PaginationApi {
-}
-export type PaginationWidget = Widget<PaginationProps, PaginationState, PaginationApi, PaginationActions, PaginationDirectives>;
+/**
+ * Represents a pagination widget with specific properties, state, API, actions, and directives.
+ */
+export type PaginationWidget = Widget<PaginationProps, PaginationState, PaginationApi, PaginationDirectives>;
 /**
  * Returns a shallow copy of the default pagination config
  * @returns a copy of the default config
  */
-export declare function getPaginationDefaultConfig(): {
-    /**
-     * The number of items in your paginated collection.
-     *
-     * Note, that this is not the number of pages. Page numbers are calculated dynamically based on
-     * `collectionSize` and `pageSize`.
-     *
-     * Ex. if you have 100 items in your collection and displaying 20 items per page, you'll end up with 5 pages.
-     *
-     * Whatever the collectionSize the page number is of minimum 1.
-     *
-     * @defaultValue `0`
-     */
-    collectionSize: number;
-    /**
-     * The number of items per page.
-     * @remarks min value is 1
-     *
-     * @defaultValue `10`
-     */
-    pageSize: number;
-    /**
-     * An event fired when the page is changed.
-     *
-     * Event payload is the number of the newly selected page.
-     *
-     * Page numbers start with `1`.
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onPageChange: (page: number) => void;
-    /**
-     * pagesFactory returns a function computing the array of pages to be displayed
-     * as number (-1 are treated as ellipsis).
-     * Use Page slot to customize the pages view and not this
-     * @param page - The current page number
-     * @param pageCount - The total number of pages
-     *
-     * @defaultValue
-     * ```ts
-     * (_page: number, pageCount: number) => {
-     * 		const pages: number[] = [];
-     * 		for (let i = 1; i <= pageCount; i++) {
-     * 			pages.push(i);
-     * 		}
-     * 		return pages;
-     * 	}
-     * ```
-     */
-    pagesFactory: (page: number, pageCount: number) => number[];
-    /**
-     * Provide the label for each "Page" page button.
-     * This is used for accessibility purposes.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     * @param processPage - The current page number
-     * @param pageCount - The total number of pages
-     *
-     * @defaultValue
-     * ```ts
-     * (processPage: number, pageCount: number) => `Page ${processPage} of ${pageCount}`
-     * ```
-     */
-    ariaPageLabel: (processPage: number, pageCount: number) => string;
-    /**
-     * Provide the label for the aria-live element
-     * This is used for accessibility purposes.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     * @param currentPage - The current page number
-     * @param pageCount - The total number of pages
-     *
-     * @defaultValue
-     * ```ts
-     * (currentPage: number, pageCount: number) => `Current page is ${currentPage}`
-     * ```
-     */
-    ariaLiveLabel: (currentPage: number, pageCount: number) => string;
-    /**
-     * Factory function providing the href for a "Page" page anchor,
-     * based on the current page number
-     * @param pageNumber - The index to use in the link
-     *
-     * @defaultValue
-     * ```ts
-     * (_page: number) => PAGE_LINK_DEFAULT
-     * ```
-     */
-    pageLink: (pageNumber: number) => string;
-    /**
-     * The current page.
-     *
-     * Page numbers start with `1`.
-     *
-     * @defaultValue `1`
-     */
-    page: number;
-    /**
-     * The pagination display size.
-     *
-     * Bootstrap currently supports small and large sizes.
-     *
-     * @defaultValue `null`
-     */
-    size: "sm" | "lg" | null;
-    /**
-     * The label for the nav element.
-     *
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     *
-     * @defaultValue `'Page navigation'`
-     */
-    ariaLabel: string;
-    /**
-     * The label for the "active" page.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     *
-     * @defaultValue
-     * ```ts
-     * '(current)'
-     * ```
-     */
-    activeLabel: string;
-    /**
-     * The label for the "First" page button.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     *
-     * @defaultValue
-     * ```ts
-     * 'Action link for first page'
-     * ```
-     */
-    ariaFirstLabel: string;
-    /**
-     * The label for the "Previous" page button.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     *
-     * @defaultValue
-     * ```ts
-     * 'Action link for previous page'
-     * ```
-     */
-    ariaPreviousLabel: string;
-    /**
-     * The label for the "Next" page button.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     *
-     * @defaultValue
-     * ```ts
-     * 'Action link for next page'
-     * ```
-     */
-    ariaNextLabel: string;
-    /**
-     * The label for the "Last" page button.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     *
-     * @defaultValue
-     * ```ts
-     * 'Action link for last page'
-     * ```
-     */
-    ariaLastLabel: string;
-    /**
-     * The label for the "Ellipsis" page.
-     * for I18n, we suggest to use the global configuration
-     * override any configuration parameters provided for this
-     *
-     * @defaultValue `'Ellipsis page element'`
-     */
-    ariaEllipsisLabel: string;
-    /**
-     * If `true`, pagination links will be disabled.
-     *
-     * @defaultValue `false`
-     */
-    disabled: boolean;
-    /**
-     * If `true`, the "Next" and "Previous" page links are shown.
-     *
-     * @defaultValue `true`
-     */
-    directionLinks: boolean;
-    /**
-     * If `true`, the "First" and "Last" page links are shown.
-     *
-     * @defaultValue `false`
-     */
-    boundaryLinks: boolean;
-    className: string;
-};
+export declare function getPaginationDefaultConfig(): PaginationProps;
 /**
  * Create a PaginationWidget with given config props
  * @param config - an optional pagination config

package/components/progressbar/index.cjs

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

package/components/progressbar/index.js

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

package/components/progressbar/progressbar.d.ts

@@ -26,12 +26,18 @@ interface ProgressbarCommonPropsAndState extends WidgetsCommonPropsAndState {
      */
     ariaLabel: string;
 }
+/**
+ * Interface representing directives for a progress bar component.
+ */
 export interface ProgressbarDirectives {
     /**
      * A directive to be applied to the main container that handles aria attributes.
      */
     ariaDirective: Directive;
 }
+/**
+ * Represents the state of a progress bar component.
+ */
 export interface ProgressbarState extends ProgressbarCommonPropsAndState {
     /**
      * Percentage of completion.
@@ -50,6 +56,9 @@ export interface ProgressbarState extends ProgressbarCommonPropsAndState {
      */
     ariaValueText: string | undefined;
 }
+/**
+ * Interface representing the properties for the Progressbar component.
+ */
 export interface ProgressbarProps extends ProgressbarCommonPropsAndState {
     /**
      * Return the value for the 'aria-valuetext' attribute.
@@ -64,9 +73,10 @@ export interface ProgressbarProps extends ProgressbarCommonPropsAndState {
      */
     ariaValueTextFn: (value: number, minimum: number, maximum: number) => string | undefined;
 }
-export interface ProgressbarApi {
-}
-export type ProgressbarWidget = Widget<ProgressbarProps, ProgressbarState, ProgressbarApi, object, ProgressbarDirectives>;
+/**
+ * Represents a Progressbar widget with specific properties, state, API, and directives.
+ */
+export type ProgressbarWidget = Widget<ProgressbarProps, ProgressbarState, object, ProgressbarDirectives>;
 /**
  * Retrieve a shallow copy of the default Progressbar config
  * @returns the default Progressbar config

package/components/rating/index.cjs

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

package/components/rating/index.js

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