@agnos-ui/core 0.4.0-next.1 → 0.4.0

package/components/pagination/pagination.d.ts

@@ -1,18 +1,20 @@
 import type { PropsConfig, Widget, Directive } from '../../types';
 import type { WidgetsCommonPropsAndState } from '../commonProps';
-export interface PaginationCommonPropsAndState extends WidgetsCommonPropsAndState {
+interface PaginationCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * The current page.
      *
      * Page numbers start with `1`.
-     * @defaultValue 1
+     *
+     * @defaultValue `1`
      */
     page: number;
     /**
      * The pagination display size.
      *
      * Bootstrap currently supports small and large sizes.
-     * @defaultValue null
+     *
+     * @defaultValue `null`
      */
     size: 'sm' | 'lg' | null;
     /**
@@ -20,64 +22,89 @@ export interface PaginationCommonPropsAndState extends WidgetsCommonPropsAndStat
      *
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue 'Page navigation'
+     *
+     * @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 '(current)'
+     *
+     * @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 'Action link for first page'
+     *
+     * @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 'Action link for previous page'
+     *
+     * @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 'Action link for next page'
+     *
+     * @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 'Action link for last page'
+     *
+     * @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'
+     *
+     * @defaultValue `'Ellipsis page element'`
      */
     ariaEllipsisLabel: string;
     /**
      * If `true`, pagination links will be disabled.
-     * @defaultValue false
+     *
+     * @defaultValue `false`
      */
     disabled: boolean;
     /**
      * If `true`, the "Next" and "Previous" page links are shown.
-     * @defaultValue true
+     *
+     * @defaultValue `true`
      */
     directionLinks: boolean;
     /**
      * If `true`, the "First" and "Last" page links are shown.
-     * @defaultValue false
+     *
+     * @defaultValue `false`
      */
     boundaryLinks: boolean;
 }
@@ -91,13 +118,15 @@ export interface PaginationProps extends PaginationCommonPropsAndState {
      * 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
+     *
+     * @defaultValue `0`
      */
     collectionSize: number;
     /**
      * The number of items per page.
-     * @defaultValue 10
      * @remarks min value is 1
+     *
+     * @defaultValue `10`
      */
     pageSize: number;
     /**
@@ -118,15 +147,16 @@ export interface PaginationProps extends PaginationCommonPropsAndState {
      * 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, pageCount}) => {
-     *  const pages: number[] = [];
-     *	for (let i = 1; i <= pageCount; i++) {
-     *		pages.push(i);
+     * (_page: number, pageCount: number) => {
+     * 		const pages: number[] = [];
+     * 		for (let i = 1; i <= pageCount; i++) {
+     * 			pages.push(i);
+     * 		}
+     * 		return pages;
      * 	}
-     * 	return pages;
-     * }
      * ```
      */
     pagesFactory: (page: number, pageCount: number) => number[];
@@ -137,9 +167,10 @@ export interface PaginationProps extends PaginationCommonPropsAndState {
      * override any configuration parameters provided for this
      * @param processPage - The current page number
      * @param pageCount - The total number of pages
+     *
      * @defaultValue
      * ```ts
-     * ({processPage, pageCount}) => `Page ${processPage} of ${pageCount}`
+     * (processPage: number, pageCount: number) => `Page ${processPage} of ${pageCount}`
      * ```
      */
     ariaPageLabel: (processPage: number, pageCount: number) => string;
@@ -150,9 +181,10 @@ export interface PaginationProps extends PaginationCommonPropsAndState {
      * override any configuration parameters provided for this
      * @param currentPage - The current page number
      * @param pageCount - The total number of pages
+     *
      * @defaultValue
      * ```ts
-     * ({currentPage, pageCount}) => `Current page is ${currentPage}`
+     * (currentPage: number, pageCount: number) => `Current page is ${currentPage}`
      * ```
      */
     ariaLiveLabel: (currentPage: number, pageCount: number) => string;
@@ -160,9 +192,10 @@ export interface PaginationProps extends PaginationCommonPropsAndState {
      * 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
-     * (_pageNumber) => '#'
+     * (_page: number) => PAGE_LINK_DEFAULT
      * ```
      */
     pageLink: (pageNumber: number) => string;
@@ -270,13 +303,15 @@ export declare function getPaginationDefaultConfig(): {
      * 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
+     *
+     * @defaultValue `0`
      */
     collectionSize: number;
     /**
      * The number of items per page.
-     * @defaultValue 10
      * @remarks min value is 1
+     *
+     * @defaultValue `10`
      */
     pageSize: number;
     /**
@@ -297,15 +332,16 @@ export declare function getPaginationDefaultConfig(): {
      * 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, pageCount}) => {
-     *  const pages: number[] = [];
-     *	for (let i = 1; i <= pageCount; i++) {
-     *		pages.push(i);
+     * (_page: number, pageCount: number) => {
+     * 		const pages: number[] = [];
+     * 		for (let i = 1; i <= pageCount; i++) {
+     * 			pages.push(i);
+     * 		}
+     * 		return pages;
      * 	}
-     * 	return pages;
-     * }
      * ```
      */
     pagesFactory: (page: number, pageCount: number) => number[];
@@ -316,9 +352,10 @@ export declare function getPaginationDefaultConfig(): {
      * override any configuration parameters provided for this
      * @param processPage - The current page number
      * @param pageCount - The total number of pages
+     *
      * @defaultValue
      * ```ts
-     * ({processPage, pageCount}) => `Page ${processPage} of ${pageCount}`
+     * (processPage: number, pageCount: number) => `Page ${processPage} of ${pageCount}`
      * ```
      */
     ariaPageLabel: (processPage: number, pageCount: number) => string;
@@ -329,9 +366,10 @@ export declare function getPaginationDefaultConfig(): {
      * override any configuration parameters provided for this
      * @param currentPage - The current page number
      * @param pageCount - The total number of pages
+     *
      * @defaultValue
      * ```ts
-     * ({currentPage, pageCount}) => `Current page is ${currentPage}`
+     * (currentPage: number, pageCount: number) => `Current page is ${currentPage}`
      * ```
      */
     ariaLiveLabel: (currentPage: number, pageCount: number) => string;
@@ -339,9 +377,10 @@ export declare function getPaginationDefaultConfig(): {
      * 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
-     * (_pageNumber) => '#'
+     * (_page: number) => PAGE_LINK_DEFAULT
      * ```
      */
     pageLink: (pageNumber: number) => string;
@@ -349,14 +388,16 @@ export declare function getPaginationDefaultConfig(): {
      * The current page.
      *
      * Page numbers start with `1`.
-     * @defaultValue 1
+     *
+     * @defaultValue `1`
      */
     page: number;
     /**
      * The pagination display size.
      *
      * Bootstrap currently supports small and large sizes.
-     * @defaultValue null
+     *
+     * @defaultValue `null`
      */
     size: "sm" | "lg" | null;
     /**
@@ -364,64 +405,89 @@ export declare function getPaginationDefaultConfig(): {
      *
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue 'Page navigation'
+     *
+     * @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 '(current)'
+     *
+     * @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 'Action link for first page'
+     *
+     * @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 'Action link for previous page'
+     *
+     * @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 'Action link for next page'
+     *
+     * @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 'Action link for last page'
+     *
+     * @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'
+     *
+     * @defaultValue `'Ellipsis page element'`
      */
     ariaEllipsisLabel: string;
     /**
      * If `true`, pagination links will be disabled.
-     * @defaultValue false
+     *
+     * @defaultValue `false`
      */
     disabled: boolean;
     /**
      * If `true`, the "Next" and "Previous" page links are shown.
-     * @defaultValue true
+     *
+     * @defaultValue `true`
      */
     directionLinks: boolean;
     /**
      * If `true`, the "First" and "Last" page links are shown.
-     * @defaultValue false
+     *
+     * @defaultValue `false`
      */
     boundaryLinks: boolean;
     className: string;
@@ -432,3 +498,4 @@ export declare function getPaginationDefaultConfig(): {
  * @returns a PaginationWidget
  */
 export declare function createPagination(config?: PropsConfig<PaginationProps>): PaginationWidget;
+export {};

package/components/progressbar/progressbar.d.ts

@@ -1,23 +1,28 @@
 import type { Directive, PropsConfig, Widget } from '../../types';
 import type { WidgetsCommonPropsAndState } from '../commonProps';
-export interface ProgressbarCommonPropsAndState extends WidgetsCommonPropsAndState {
+interface ProgressbarCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * The minimum value.
-     * @defaultValue 0
+     *
+     * @defaultValue `0`
      */
     min: number;
     /**
      * The maximum value.
-     * @defaultValue 100
+     *
+     * @defaultValue `100`
      */
     max: number;
     /**
      * The current value.
-     * @defaultValue 0
+     *
+     * @defaultValue `0`
      */
     value: number;
     /**
      * The aria label.
+     *
+     * @defaultValue `'Progressbar'`
      */
     ariaLabel: string;
 }
@@ -51,6 +56,11 @@ export interface ProgressbarProps extends ProgressbarCommonPropsAndState {
      * @param value - current value
      * @param minimum - minimum value
      * @param maximum - maximum value
+     *
+     * @defaultValue
+     * ```ts
+     * () => undefined
+     * ```
      */
     ariaValueTextFn: (value: number, minimum: number, maximum: number) => string | undefined;
 }
@@ -68,3 +78,4 @@ export declare function getProgressbarDefaultConfig(): ProgressbarProps;
  * @returns an ProgressbarWidget
  */
 export declare function createProgressbar(config?: PropsConfig<ProgressbarProps>): ProgressbarWidget;
+export {};

package/components/rating/rating.d.ts

@@ -10,40 +10,56 @@ export interface StarContext {
      */
     index: number;
 }
-export interface RatingCommonPropsAndState extends WidgetsCommonPropsAndState {
+interface RatingCommonPropsAndState extends WidgetsCommonPropsAndState {
     /**
      * The current rating. Could be a decimal value like `3.75`.
+     *
+     * @defaultValue `0`
      */
     rating: number;
     /**
      * The maximum rating that can be given.
+     *
+     * @defaultValue `10`
      */
     maxRating: number;
     /**
      * If `true`, the rating is disabled.
+     *
+     * @defaultValue `false`
      */
     disabled: boolean;
     /**
      * If `true`, the rating can't be changed.
+     *
+     * @defaultValue `false`
      */
     readonly: boolean;
     /**
      * Define if the rating can be reset.
      *
      * If set to true, the user can 'unset' the rating value by cliking on the current rating value.
+     *
+     * @defaultValue `true`
      */
     resettable: boolean;
     /**
      * Allows setting a custom rating tabindex.
      * If the component is disabled, `tabindex` will still be set to `-1`.
+     *
+     * @defaultValue `0`
      */
     tabindex: number;
     /**
      * The aria label
+     *
+     * @defaultValue `'Rating'`
      */
     ariaLabel: string;
     /**
      * The aria labelled by
+     *
+     * @defaultValue `''`
      */
     ariaLabelledBy: string;
 }
@@ -52,24 +68,44 @@ export interface RatingProps extends RatingCommonPropsAndState {
      * Return the value for the 'aria-valuetext' attribute.
      * @param rating - Current rating value.
      * @param maxRating - maxRating value.
+     *
+     * @defaultValue
+     * ```ts
+     * (rating: number, maxRating: number) => `${rating} out of ${maxRating}`
+     * ```
      */
     ariaValueTextFn: (rating: number, maxRating: number) => string;
     /**
      * An event emitted when the rating is changed.
      *
      * Event payload is equal to the newly selected rating.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onRatingChange: (rating: number) => void;
     /**
      * An event emitted when the user is hovering over a given rating.
      *
      * Event payload is equal to the rating being hovered over.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onHover: (rating: number) => void;
     /**
      * An event emitted when the user stops hovering over a given rating.
      *
      * Event payload is equal to the rating of the last item being hovered over.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onLeave: (rating: number) => void;
 }
@@ -142,59 +178,95 @@ export declare function getRatingDefaultConfig(): {
      * Return the value for the 'aria-valuetext' attribute.
      * @param rating - Current rating value.
      * @param maxRating - maxRating value.
+     *
+     * @defaultValue
+     * ```ts
+     * (rating: number, maxRating: number) => `${rating} out of ${maxRating}`
+     * ```
      */
     ariaValueTextFn: (rating: number, maxRating: number) => string;
     /**
      * An event emitted when the rating is changed.
      *
      * Event payload is equal to the newly selected rating.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onRatingChange: (rating: number) => void;
     /**
      * An event emitted when the user is hovering over a given rating.
      *
      * Event payload is equal to the rating being hovered over.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onHover: (rating: number) => void;
     /**
      * An event emitted when the user stops hovering over a given rating.
      *
      * Event payload is equal to the rating of the last item being hovered over.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onLeave: (rating: number) => void;
     /**
      * The current rating. Could be a decimal value like `3.75`.
+     *
+     * @defaultValue `0`
      */
     rating: number;
     /**
      * The maximum rating that can be given.
+     *
+     * @defaultValue `10`
      */
     maxRating: number;
     /**
      * If `true`, the rating is disabled.
+     *
+     * @defaultValue `false`
      */
     disabled: boolean;
     /**
      * If `true`, the rating can't be changed.
+     *
+     * @defaultValue `false`
      */
     readonly: boolean;
     /**
      * Define if the rating can be reset.
      *
      * If set to true, the user can 'unset' the rating value by cliking on the current rating value.
+     *
+     * @defaultValue `true`
      */
     resettable: boolean;
     /**
      * Allows setting a custom rating tabindex.
      * If the component is disabled, `tabindex` will still be set to `-1`.
+     *
+     * @defaultValue `0`
      */
     tabindex: number;
     /**
      * The aria label
+     *
+     * @defaultValue `'Rating'`
      */
     ariaLabel: string;
     /**
      * The aria labelled by
+     *
+     * @defaultValue `''`
      */
     ariaLabelledBy: string;
     className: string;
@@ -205,3 +277,4 @@ export declare function getRatingDefaultConfig(): {
  * @returns a RatingWidget
  */
 export declare function createRating(config?: PropsConfig<RatingProps>): RatingWidget;
+export {};

package/components/select/index.cjs

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

package/components/select/index.js

@@ -1,6 +1,5 @@
-import { c, d, g } from "../../select-BS0mh7Qk.js";
+import { c, g } from "../../select-jUrt_lSn.js";
 export {
   c as createSelect,
-  d as defaultConfig,
   g as getSelectDefaultConfig
 };