@agnos-ui/react-bootstrap 0.4.0-next.1 → 0.4.0

package/components/rating/index.js

@@ -1,6 +1,6 @@
-import { R, c, g } from "../../rating-DRAx20tg.js";
+import { R, a, e } from "../../rating-CWOEBPWs.js";
 export {
   R as Rating,
-  c as createRating,
-  g as getRatingDefaultConfig
+  a as createRating,
+  e as getRatingDefaultConfig
 };

package/components/rating/rating.d.ts

@@ -1,6 +1,2 @@
-import type { WidgetFactory } from '@agnos-ui/react-headless/types';
-import type { RatingWidget, RatingProps } from './rating.gen';
-export type * from './rating.gen';
-export declare const createRating: WidgetFactory<RatingWidget>;
-export declare const getRatingDefaultConfig: () => RatingProps;
+import type { RatingProps } from './rating.gen';
 export declare function Rating(props: Partial<RatingProps>): import("react/jsx-runtime").JSX.Element;

package/components/rating/rating.gen.d.ts

@@ -1,4 +1,10 @@
-import type { SlotContent, Widget, Directive } from '@agnos-ui/react-headless/types';
+import type { SlotContent, Widget, WidgetFactory, Directive } from '@agnos-ui/react-headless/types';
+/**
+ * Retrieve a shallow copy of the default Rating config
+ * @returns the default Rating config
+ */
+declare const export_getRatingDefaultConfig: () => RatingProps;
+export { export_getRatingDefaultConfig as getRatingDefaultConfig };
 export interface RatingState {
     /**
      * the aria value of the rating
@@ -18,116 +24,191 @@ export interface RatingState {
     stars: StarContext[];
     /**
      * 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;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
      * The template to override the way each star is displayed.
+     *
+     * @defaultValue
+     * ```ts
+     * ({fill}: StarContext) => String.fromCharCode(fill === 100 ? 9733 : 9734)
+     * ```
      */
     star: SlotContent<StarContext>;
 }
 export interface RatingProps {
     /**
      * 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;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
      * The template to override the way each star is displayed.
+     *
+     * @defaultValue
+     * ```ts
+     * ({fill}: StarContext) => String.fromCharCode(fill === 100 ? 9733 : 9734)
+     * ```
      */
     star: SlotContent<StarContext>;
 }
 export type RatingWidget = Widget<RatingProps, RatingState, object, RatingActions, RatingDirectives>;
+/**
+ * Create a RatingWidget with given config props
+ * @param config - an optional rating config
+ * @returns a RatingWidget
+ */
+declare const export_createRating: WidgetFactory<RatingWidget>;
+export { export_createRating as createRating };
 export interface StarContext {
     /**
      * indicates how much the current star is filled, from 0 to 100
@@ -156,12 +237,14 @@ export interface RatingActions {
      * Method to be used when a star is clicked.
      *
      * To be used in the onclick event of a star
+     * @param index - Star index, starting from 1
      */
     click(index: number): void;
     /**
      * Method to be used when the mouse enter in a star.
      *
      * To be used in the onmouseenter of a star
+     * @param index - Star index, starting from 1
      */
     hover(index: number): void;
     /**

package/components/select/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const select = require("../../select-CxX_TdVh.cjs");
+const select = require("../../select-C4STYCmG.cjs");
 exports.Select = select.Select;
-exports.createSelect = select.createSelect;
-exports.getSelectDefaultConfig = select.getSelectDefaultConfig;
+exports.createSelect = select.export_createSelect;
+exports.getSelectDefaultConfig = select.export_getSelectDefaultConfig;

package/components/select/index.d.ts

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

package/components/select/index.js

@@ -1,6 +1,6 @@
-import { S, c, g } from "../../select-CEXxOyRB.js";
+import { S, a, e } from "../../select-DmgOBdqs.js";
 export {
   S as Select,
-  c as createSelect,
-  g as getSelectDefaultConfig
+  a as createSelect,
+  e as getSelectDefaultConfig
 };

package/components/select/select.d.ts

@@ -1,6 +1,2 @@
-import type { PropsConfig } from '@agnos-ui/react-headless/types';
-import type { SelectProps, SelectWidget } from './select.gen';
-export type * from './select.gen';
-export declare const createSelect: <Item>(propsConfig?: PropsConfig<SelectProps<Item>>) => SelectWidget<Item>;
-export declare const getSelectDefaultConfig: () => SelectProps<any>;
+import type { SelectProps } from './select.gen';
 export declare function Select<Item>(props: Partial<SelectProps<Item>>): import("react/jsx-runtime").JSX.Element;

package/components/select/select.gen.d.ts

@@ -1,7 +1,16 @@
-import type { WidgetSlotContext, SlotContent, Widget, Directive } from '@agnos-ui/react-headless/types';
+import type { WidgetSlotContext, SlotContent, Widget, PropsConfig, Directive } from '@agnos-ui/react-headless/types';
 import type { Placement } from '@floating-ui/dom';
 import type { HasFocus } from '@agnos-ui/react-headless/services/focustrack';
 import type { FloatingUI } from '@agnos-ui/react-headless/services/floatingUI';
+/**
+ * Retrieve a shallow copy of the default Select config
+ * @returns the default Select config
+ */
+declare const export_getSelectDefaultConfig: () => SelectProps<any>;
+export { export_getSelectDefaultConfig as getSelectDefaultConfig };
+/**
+ * A type for the slot context of the pagination widget
+ */
 export type SelectContext<Item> = WidgetSlotContext<SelectWidget<Item>>;
 export type SelectItemContext<Item> = SelectContext<Item> & {
     /**
@@ -33,84 +42,150 @@ export interface SelectState<Item> {
     id: string | undefined;
     /**
      * aria-label used for the input inside the select
+     *
+     * @defaultValue `'Select'`
      */
     ariaLabel: string | undefined;
     /**
      * List of selected item ids
+     *
+     * @defaultValue `[]`
      */
     selected: Item[];
     /**
      * 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;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
      * The template to override the way each badge on the left of the input is displayed.
      * This define the content of the badge inside the badge container.
+     *
+     * @defaultValue
+     * ```ts
+     * ({itemContext}: SelectItemContext<any>) => itemContext.item
+     * ```
      */
     badgeLabel: SlotContent<SelectItemContext<Item>>;
     /**
      * The template to override the way each item is displayed in the list.
      * This define the content of the badge inside the badge container.
+     *
+     * @defaultValue
+     * ```ts
+     * ({itemContext}: SelectItemContext<any>) => itemContext.item
+     * ```
      */
     itemLabel: SlotContent<SelectItemContext<Item>>;
 }
 export interface SelectProps<Item> {
     /**
      * List of available items for the dropdown
+     *
+     * @defaultValue `[]`
      */
     items: Item[];
     /**
      * 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: Item): 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: Item[]): void;
     /**
@@ -119,56 +194,93 @@ export interface SelectProps<Item> {
     id: string | undefined;
     /**
      * aria-label used for the input inside the select
+     *
+     * @defaultValue `'Select'`
      */
     ariaLabel: string | undefined;
     /**
      * List of selected item ids
+     *
+     * @defaultValue `[]`
      */
     selected: Item[];
     /**
      * 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;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
      * The template to override the way each badge on the left of the input is displayed.
      * This define the content of the badge inside the badge container.
+     *
+     * @defaultValue
+     * ```ts
+     * ({itemContext}: SelectItemContext<any>) => itemContext.item
+     * ```
      */
     badgeLabel: SlotContent<SelectItemContext<Item>>;
     /**
      * The template to override the way each item is displayed in the list.
      * This define the content of the badge inside the badge container.
+     *
+     * @defaultValue
+     * ```ts
+     * ({itemContext}: SelectItemContext<any>) => itemContext.item
+     * ```
      */
     itemLabel: SlotContent<SelectItemContext<Item>>;
 }
 export type SelectWidget<Item> = Widget<SelectProps<Item>, SelectState<Item>, SelectApi<Item>, SelectActions<Item>, SelectDirectives<Item>>;
+/**
+ * Creates a new select widget instance.
+ * @param config - config of the modal, either as a store or as an object containing values or stores.
+ * @returns a new select widget instance
+ */
+declare const export_createSelect: <Item>(config?: PropsConfig<SelectProps<Item>>) => SelectWidget<Item>;
+export { export_createSelect as createSelect };
 export interface ItemContext<T> {
     /**
      * Original item given in the parameters
@@ -217,14 +329,18 @@ export interface SelectApi<Item> {
     /**
      * Select the provided item.
      * The selected list is used to
+     * @param item - the item to select
      */
     select(item: Item): void;
     /**
      * Unselect the provided item.
+     * @param item - the item to unselect
      */
     unselect(item: Item): void;
     /**
      * Toggle the selection of an item
+     * @param item - the item to toggle
+     * @param selected - an optional boolean to enforce the selected/unselected state instead of toggling
      */
     toggleItem(item: Item, selected?: boolean): void;
     /**
@@ -237,6 +353,7 @@ export interface SelectApi<Item> {
     close(): void;
     /**
      * Toggle the dropdown menu
+     * @param isOpen - If specified, set the menu in the defined state.
      */
     toggle(isOpen?: boolean): void;
 }
@@ -288,6 +405,9 @@ export interface SelectActions<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;
 }

package/components/slider/index.cjs

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const slider = require("../../slider-Du37lWVJ.cjs");
+const slider = require("../../slider-MNZTN_vu.cjs");
 exports.DefaultSlotHandle = slider.DefaultSlotHandle;
 exports.DefaultSlotStructure = slider.DefaultSlotStructure;
 exports.Slider = slider.Slider;
-exports.createSlider = slider.createSlider;
-exports.getSliderDefaultConfig = slider.getSliderDefaultConfig;
+exports.createSlider = slider.export_createSlider;
+exports.getSliderDefaultConfig = slider.export_getSliderDefaultConfig;

package/components/slider/index.d.ts

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

package/components/slider/index.js

@@ -1,8 +1,8 @@
-import { D, a, S, c, g } from "../../slider-CnK847iw.js";
+import { D, a, S, b, e } from "../../slider-CxodlRoZ.js";
 export {
   D as DefaultSlotHandle,
   a as DefaultSlotStructure,
   S as Slider,
-  c as createSlider,
-  g as getSliderDefaultConfig
+  b as createSlider,
+  e as getSliderDefaultConfig
 };

package/components/slider/slider.d.ts

@@ -1,9 +1,5 @@
-import type { WidgetFactory } from '@agnos-ui/react-headless/types';
 import type { PropsWithChildren } from 'react';
-import type { SliderWidget, SliderSlotHandleContext, SliderContext, SliderProps } from './slider.gen';
-export type * from './slider.gen';
-export declare const createSlider: WidgetFactory<SliderWidget>;
-export declare const getSliderDefaultConfig: () => SliderProps;
+import type { SliderContext, SliderProps, SliderSlotHandleContext } from './slider.gen';
 export declare const DefaultSlotHandle: (slotContext: SliderSlotHandleContext) => import("react/jsx-runtime").JSX.Element;
 export declare const DefaultSlotStructure: (slotContext: SliderContext) => import("react/jsx-runtime").JSX.Element;
 export declare function Slider(props: PropsWithChildren<Partial<SliderProps>>): import("react/jsx-runtime").JSX.Element;