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

package/components/rating/rating.d.ts

@@ -1,5 +1,8 @@
 import type { Directive, PropsConfig, Widget } from '../../types';
 import type { WidgetsCommonPropsAndState } from '../commonProps';
+/**
+ * Represents the context for a star in a rating component.
+ */
 export interface StarContext {
     /**
      * indicates how much the current star is filled, from 0 to 100
@@ -63,6 +66,9 @@ interface RatingCommonPropsAndState extends WidgetsCommonPropsAndState {
      */
     ariaLabelledBy: string;
 }
+/**
+ * Interface representing the properties for the Rating widget.
+ */
 export interface RatingProps extends RatingCommonPropsAndState {
     /**
      * Return the value for the 'aria-valuetext' attribute.
@@ -109,6 +115,9 @@ export interface RatingProps extends RatingCommonPropsAndState {
      */
     onLeave: (rating: number) => void;
 }
+/**
+ * Interface representing directives for a rating component.
+ */
 export interface RatingDirectives {
     /**
      * A directive to be applied to the main container
@@ -122,6 +131,9 @@ export interface RatingDirectives {
         index: number;
     }>;
 }
+/**
+ * Represents the state of a rating component.
+ */
 export interface RatingState extends RatingCommonPropsAndState {
     /**
      * the aria value of the rating
@@ -140,137 +152,36 @@ export interface RatingState extends RatingCommonPropsAndState {
      */
     stars: StarContext[];
 }
-export interface RatingActions {
+/**
+ * Interface representing the API that can be performed on a rating component.
+ */
+export interface RatingApi {
     /**
-     * Method to be used when a star is clicked.
+     * Sets the rating value.
      *
-     * To be used in the onclick event of a star
      * @param index - Star index, starting from 1
      */
-    click(index: number): void;
+    setRating(index: number): void;
     /**
-     * Method to be used when the mouse enter in a star.
+     * Sets the hovered rating value.
      *
-     * To be used in the onmouseenter of a star
      * @param index - Star index, starting from 1
      */
-    hover(index: number): void;
+    setHoveredRating(index: number): void;
     /**
-     * Method to be used when the mouse leave the widget.
-     *
-     * To be used in the onmouseleave of the rating container
+     * Leave the rating, resetting the visible rating to the rating value and triggering the onLeave callback
      */
     leave(): void;
-    /**
-     * Method to be used to handle the keyboard.
-     *
-     * To be used in the onkeydown of the rating container
-     */
-    handleKey(event: KeyboardEvent): void;
 }
-export type RatingWidget = Widget<RatingProps, RatingState, object, RatingActions, RatingDirectives>;
+/**
+ * Represents a Rating widget.
+ */
+export type RatingWidget = Widget<RatingProps, RatingState, RatingApi, RatingDirectives>;
 /**
  * Returns a shallow copy of the default rating config.
  * @returns a copy of the default config
  */
-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;
-};
+export declare function getRatingDefaultConfig(): RatingProps;
 /**
  * Create a RatingWidget with given config props
  * @param config - an optional alert config

package/components/select/index.cjs

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

package/components/select/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../select-jUrt_lSn.js";
+import { c, g } from "../../select-CAEPqdz1.js";
 export {
   c as createSelect,
   g as getSelectDefaultConfig

package/components/select/select.d.ts

@@ -63,6 +63,9 @@ interface SelectCommonPropsAndState<Item> extends WidgetsCommonPropsAndState {
      */
     loading: boolean;
 }
+/**
+ * Props for the Select component.
+ */
 export interface SelectProps<Item> extends SelectCommonPropsAndState<Item> {
     /**
      * List of available items for the dropdown
@@ -148,6 +151,9 @@ export interface ItemContext<T> {
      */
     selected: boolean;
 }
+/**
+ * Represents the state of a Select component.
+ */
 export interface SelectState<Item> extends SelectCommonPropsAndState<Item> {
     /**
      * List of item contexts, to be displayed in the menu
@@ -167,6 +173,9 @@ export interface SelectState<Item> extends SelectCommonPropsAndState<Item> {
      */
     placement: Placement | undefined;
 }
+/**
+ * Interface representing the API for a Select component.
+ */
 export interface SelectApi<Item> {
     /**
      * Clear all the selected items
@@ -229,6 +238,9 @@ export interface SelectApi<Item> {
      */
     toggle(isOpen?: boolean): void;
 }
+/**
+ * Interface representing the directives used in the Select component.
+ */
 export interface SelectDirectives<Item> {
     /**
      * Directive to be used in the input group and the menu containers
@@ -258,163 +270,24 @@ export interface SelectDirectives<Item> {
      * A directive that applies all the necessary attributes to the dropdown item
      */
     itemAttributesDirective: Directive<ItemContext<Item>>;
-}
-export interface SelectActions<Item> {
     /**
-     * Method to be plugged to on the 'input' event. The input text will be used as the filter text.
+     * A directive to be applied to the input
      */
-    onInput: (e: {
-        target: any;
-    }) => void;
+    inputDirective: Directive;
     /**
-     * Method to be attached to the node element to close a badge on click.
+     * A directive to be applied to a button that closes a badge
      */
-    onRemoveBadgeClick: (event: MouseEvent, item: Item) => void;
-    /**
-     * Method to be plugged to on an keydown event of the main input, in order to control the keyboard interactions with the highlighted item.
-     * It manages arrow keys to move the highlighted item, or enter to toggle the item.
-     */
-    onInputKeydown: (event: KeyboardEvent) => void;
-    /**
-     * Method to be plugged to on an keydown event of a badge container, in order to manage main actions on badges.
-     *
-     * @param event - keyboard event
-     * @param item - corresponding item
-     */
-    onBadgeKeydown: (event: KeyboardEvent, item: Item) => void;
+    badgeCloseButtonDirective: Directive<ItemContext<Item>>;
 }
-export type SelectWidget<Item> = Widget<SelectProps<Item>, SelectState<Item>, SelectApi<Item>, SelectActions<Item>, SelectDirectives<Item>>;
+/**
+ * Represents a Select widget component.
+ */
+export type SelectWidget<Item> = Widget<SelectProps<Item>, SelectState<Item>, SelectApi<Item>, SelectDirectives<Item>>;
 /**
  * Returns a shallow copy of the default select config.
  * @returns a copy of the default config
  */
-export declare function getSelectDefaultConfig(): {
-    /**
-     * List of available items for the dropdown
-     *
-     * @defaultValue `[]`
-     */
-    items: any[];
-    /**
-     * List of allowed placements for the dropdown.
-     * This refers to the [allowedPlacements from floating UI](https://floating-ui.com/docs/autoPlacement#allowedplacements), given the different [Placement possibilities](https://floating-ui.com/docs/computePosition#placement).
-     *
-     * @defaultValue
-     * ```ts
-     * ['bottom-start', 'top-start', 'bottom-end', 'top-end']
-     * ```
-     */
-    allowedPlacements: Placement[];
-    /**
-     * Custom function to get the id of an item
-     * By default, the item is returned
-     *
-     * @defaultValue
-     * ```ts
-     * (item: any) => '' + item
-     * ```
-     */
-    itemIdFn(item: any): string;
-    /**
-     * Retrieves navigable elements within an HTML element containing badges and the input.
-     *
-     * @param node - HTMLElement that contains the badges and the input
-     *
-     * @defaultValue
-     * ```ts
-     * (node: HTMLElement) => node.querySelectorAll('.au-select-badge,input')
-     * ```
-     */
-    navSelector(node: HTMLElement): NodeListOf<HTMLSpanElement | HTMLInputElement>;
-    /**
-     * Callback called dropdown open state change
-     * @param isOpen - updated open state
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onOpenChange(isOpen: boolean): void;
-    /**
-     * Callback called when the text filter change
-     * @param text - Filtered text
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onFilterTextChange(text: string): void;
-    /**
-     * Callback called when the selection change
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onSelectedChange(selected: any[]): void;
-    /**
-     * id used for the input inside the select
-     */
-    id: string | undefined;
-    /**
-     * aria-label used for the input inside the select
-     *
-     * @defaultValue `'Select'`
-     */
-    ariaLabel: string | undefined;
-    /**
-     * List of selected item ids
-     *
-     * @defaultValue `[]`
-     */
-    selected: any[];
-    /**
-     * Filtered text to be display in the filter input
-     *
-     * @defaultValue `''`
-     */
-    filterText: string;
-    /**
-     * true if the select is disabled
-     *
-     * @defaultValue `false`
-     */
-    disabled: boolean;
-    /**
-     * true if the select is open
-     *
-     * @defaultValue `false`
-     */
-    open: boolean;
-    /**
-     * Class to be added on the dropdown menu container
-     *
-     * @defaultValue `''`
-     */
-    menuClassName: string;
-    /**
-     * Class to be added on menu items
-     *
-     * @defaultValue `''`
-     */
-    menuItemClassName: string;
-    /**
-     * Class to be added on selected items (displayed in the input zone)
-     *
-     * @defaultValue `''`
-     */
-    badgeClassName: string;
-    /**
-     * true if a loading process is being done
-     *
-     * @defaultValue `false`
-     */
-    loading: boolean;
-    className: string;
-};
+export declare function getSelectDefaultConfig(): SelectProps<any>;
 /**
  * Create a SelectWidget with given config props
  * @param config - an optional alert config

package/components/slider/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const slider = require("../../slider-BdsZpxJr.cjs");
+const slider = require("../../slider-DlOAawbZ.cjs");
 exports.createSlider = slider.createSlider;
 exports.getSliderDefaultConfig = slider.getSliderDefaultConfig;

package/components/slider/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../slider-ByDkbyr1.js";
+import { c, g } from "../../slider-DYrwS7Mv.js";
 export {
   c as createSlider,
   g as getSliderDefaultConfig

package/components/slider/slider.d.ts

@@ -1,5 +1,8 @@
 import type { WidgetsCommonPropsAndState } from '../commonProps';
 import type { Directive, PropsConfig, Widget } from '../../types';
+/**
+ * Options for displaying progress in a slider component.
+ */
 export interface ProgressDisplayOptions {
     /**
      * Right offset of the progress in %
@@ -26,6 +29,9 @@ export interface ProgressDisplayOptions {
      */
     height: number;
 }
+/**
+ * Options for displaying a handle in a slider component.
+ */
 export interface HandleDisplayOptions {
     /**
      * Left offset of the handle in %
@@ -36,6 +42,9 @@ export interface HandleDisplayOptions {
      */
     top: number | null;
 }
+/**
+ * Represents a handle in a slider component.
+ */
 export interface SliderHandle {
     /**
      * Value of the handle
@@ -116,6 +125,9 @@ interface SliderCommonPropsAndState extends WidgetsCommonPropsAndState {
      */
     rtl: boolean;
 }
+/**
+ * Represents the state of a slider component.
+ */
 export interface SliderState extends SliderCommonPropsAndState {
     /**
      * Sorted slider values
@@ -158,6 +170,9 @@ export interface SliderState extends SliderCommonPropsAndState {
      */
     interactive: boolean;
 }
+/**
+ * Interface representing the properties for the Slider component.
+ */
 export interface SliderProps extends SliderCommonPropsAndState {
     /**
      * Return the value for the 'aria-label' attribute for the handle
@@ -195,8 +210,9 @@ export interface SliderProps extends SliderCommonPropsAndState {
      */
     onValuesChange: (values: number[]) => void;
 }
-export interface SliderApi {
-}
+/**
+ * Interface representing various directives used in the slider component.
+ */
 export interface SliderDirectives {
     /**
      * Directive to get the slider component elementRef
@@ -212,6 +228,14 @@ export interface SliderDirectives {
      * Directive to apply to the slider clickable area, to directly move the handle to a given specific position
      */
     clickableAreaDirective: Directive;
+    /**
+     * Directive to apply handle events handlers
+     */
+    handleEventsDirective: Directive<{
+        item: {
+            id: number;
+        };
+    }>;
     /**
      * Directive to apply to the slider handle if any
      */
@@ -237,134 +261,15 @@ export interface SliderDirectives {
         index: number;
     }>;
 }
-export interface SliderActions {
-    /**
-     * Method to handle click on the slider
-     * @param event - mouse event
-     */
-    click(event: MouseEvent): void;
-    /**
-     * Method to process the keyboard event
-     * @param event - keyboard event object
-     * @param handleNumber - id of the modified handle
-     */
-    keydown(event: KeyboardEvent, handleNumber: number): void;
-    /**
-     * Method describing the behavior of the slider handle on mouse down event
-     * @param event - mouse event
-     * @param handleId - numeric id of the handle
-     */
-    mouseDown(event: MouseEvent, handleId: number): void;
-    /**
-     * Method describing the behavior of the slider handle on touch start event
-     * @param event - touch event
-     * @param handleId - number id of the handle
-     */
-    touchStart(event: TouchEvent, handleId: number): void;
-}
-export type SliderWidget = Widget<SliderProps, SliderState, SliderApi, SliderActions, SliderDirectives>;
+/**
+ * Represents a slider widget component.
+ */
+export type SliderWidget = Widget<SliderProps, SliderState, object, SliderDirectives>;
 /**
  * Returns a shallow copy of the default slider config.
  * @returns a copy of the default config
  */
-export declare function getSliderDefaultConfig(): {
-    /**
-     * Return the value for the 'aria-label' attribute for the handle
-     * @param value - value of the handle
-     * @param sortedIndex - index of the handle in the sorted list
-     * @param index - index of the handle in the original list
-     *
-     * @defaultValue
-     * ```ts
-     * (value: number) => '' + value
-     * ```
-     */
-    ariaLabelHandle: (value: number, sortedIndex: number, index: number) => string;
-    /**
-     * Return the value for the 'aria-valuetext' attribute for the handle
-     * @param value - value of the handle
-     * @param sortedIndex - index of the handle in the sorted list
-     * @param index - index of the handle in the original list
-     *
-     * @defaultValue
-     * ```ts
-     * (value: number) => '' + value
-     * ```
-     */
-    ariaValueText: (value: number, sortedIndex: number, index: number) => string;
-    /**
-     * An event emitted when slider values are changed
-     *
-     * Event payload equals to the updated slider values
-     *
-     * @defaultValue
-     * ```ts
-     * () => {}
-     * ```
-     */
-    onValuesChange: (values: number[]) => void;
-    /**
-     * Minimum value that can be assigned to the slider
-     *
-     * @defaultValue `0`
-     */
-    min: number;
-    /**
-     * Maximum value that can be assigned to the slider
-     *
-     * @defaultValue `100`
-     */
-    max: number;
-    /**
-     * Unit value between slider steps
-     *
-     * @defaultValue `1`
-     */
-    stepSize: number;
-    /**
-     * If `true` slider value cannot be changed but the slider is still focusable
-     *
-     * @defaultValue `false`
-     */
-    readonly: boolean;
-    /**
-     * If `true` slider value cannot be changed and the slider cannot be focused
-     *
-     * @defaultValue `false`
-     */
-    disabled: boolean;
-    /**
-     * If `true` is vertically positioned otherwise it is horizontal
-     *
-     * @defaultValue `false`
-     */
-    vertical: boolean;
-    /**
-     * Current slider values
-     *
-     * @defaultValue `[0]`
-     */
-    values: number[];
-    /**
-     * If `true` the value labels are displayed on the slider
-     *
-     * @defaultValue `true`
-     */
-    showValueLabels: boolean;
-    /**
-     * If `true` the min and max labels are displayed on the slider
-     *
-     * @defaultValue `true`
-     */
-    showMinMaxLabels: boolean;
-    /**
-     * It `true` slider display is inversed
-     *
-     * @defaultValue `false`
-     */
-    rtl: boolean;
-    className: string;
-};
+export declare function getSliderDefaultConfig(): SliderProps;
 /**
  * Create a slider widget with given config props
  * @param config - an optional slider config

package/components/toast/index.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const toast = require("../../toast-Dy3ck2cM.cjs");
+const toast = require("../../toast-D_uSrRZL.cjs");
 exports.createToast = toast.createToast;
 exports.getToastDefaultConfig = toast.getToastDefaultConfig;

package/components/toast/index.js

@@ -1,4 +1,4 @@
-import { c, g } from "../../toast-BzxextBQ.js";
+import { c, g } from "../../toast-CpvsibAI.js";
 export {
   c as createToast,
   g as getToastDefaultConfig

package/components/toast/toast.d.ts

@@ -28,15 +28,30 @@ interface ExtraDirectives {
      */
     closeButtonDirective: Directive;
 }
+/**
+ * Represents the state of a toast component.
+ */
 export interface ToastState extends CommonAlertState, ToastExtraProps {
 }
+/**
+ * Represents the properties for the toast component.
+ */
 export interface ToastProps extends CommonAlertProps, ToastExtraProps {
 }
+/**
+ * Represents the API for the toast component.
+ */
 export interface ToastApi extends CommonAlertApi {
 }
+/**
+ * Interface representing the directives for a toast component.
+ */
 export interface ToastDirectives extends CommonAlertDirectives, ExtraDirectives {
 }
-export type ToastWidget = Widget<ToastProps, ToastState, ToastApi, object, ToastDirectives>;
+/**
+ * Represents a toast widget with specific properties, state, API, and directives.
+ */
+export type ToastWidget = Widget<ToastProps, ToastState, ToastApi, ToastDirectives>;
 /**
  * Retrieve a shallow copy of the default toast config
  * @returns the default toast config