@agnos-ui/svelte-bootstrap 0.4.0-next.0 → 0.4.0

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

@@ -1,7 +1,16 @@
-import type { WidgetSlotContext, SlotContent, Widget, Directive } from '@agnos-ui/svelte-headless/types';
+import type { WidgetSlotContext, SlotContent, Widget, PropsConfig, Directive } from '@agnos-ui/svelte-headless/types';
 import type { Placement } from '@floating-ui/dom';
 import type { HasFocus } from '@agnos-ui/svelte-headless/services/focustrack';
 import type { FloatingUI } from '@agnos-ui/svelte-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/select/select.gen.js

@@ -1 +1,14 @@
-export {};
+import { getSelectDefaultConfig, createSelect } from '@agnos-ui/core-bootstrap/components/select';
+/**
+ * Retrieve a shallow copy of the default Select config
+ * @returns the default Select config
+ */
+const export_getSelectDefaultConfig = getSelectDefaultConfig;
+export { export_getSelectDefaultConfig as getSelectDefaultConfig };
+/**
+ * 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
+ */
+const export_createSelect = createSelect;
+export { export_createSelect as createSelect };

package/components/select/select.js

@@ -1,3 +1 @@
-import { createSelect as coreCreateSelect, getSelectDefaultConfig as coreGetSelectDefaultConfig } from '@agnos-ui/core-bootstrap/components/select';
-export const createSelect = coreCreateSelect;
-export const getSelectDefaultConfig = coreGetSelectDefaultConfig;
+export * from './select.gen';

package/components/slider/Slider.svelte.d.ts

@@ -2,7 +2,7 @@ import { SvelteComponent } from "svelte";
 import type { SliderApi, SliderProps, SliderSlots } from './slider';
 declare const __propDef: {
     props: {
-        api?: SliderApi | undefined;
+        api?: SliderApi;
     } & Partial<SliderProps>;
     events: {
         [evt: string]: CustomEvent<any>;

package/components/slider/slider.d.ts

@@ -1,7 +1,5 @@
-import type { WidgetPropsSlots, WidgetFactory } from '@agnos-ui/svelte-headless/types';
-import type { SliderWidget, SliderProps } from './slider.gen';
-export type * from './slider.gen';
-export declare const createSlider: WidgetFactory<SliderWidget>;
-export declare const getSliderDefaultConfig: () => SliderProps;
+import type { WidgetPropsSlots } from '@agnos-ui/svelte-headless/types';
+import type { SliderProps } from './slider.gen';
+export * from './slider.gen';
 export interface SliderSlots extends WidgetPropsSlots<SliderProps> {
 }

package/components/slider/slider.gen.d.ts

@@ -1,4 +1,10 @@
-import type { WidgetSlotContext, SlotContent, Widget, Directive } from '@agnos-ui/svelte-headless/types';
+import type { WidgetSlotContext, SlotContent, Widget, WidgetFactory, Directive } from '@agnos-ui/svelte-headless/types';
+/**
+ * Retrieve a shallow copy of the default Slider config
+ * @returns the default Slider config
+ */
+declare const export_getSliderDefaultConfig: () => SliderProps;
+export { export_getSliderDefaultConfig as getSliderDefaultConfig };
 export type SliderContext = WidgetSlotContext<SliderWidget>;
 export type SliderSlotLabelContext = SliderContext & {
     value: number;
@@ -49,46 +55,68 @@ export interface SliderState {
     interactive: boolean;
     /**
      * 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;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -97,70 +125,118 @@ export interface SliderState {
     structure: SlotContent<SliderContext>;
     /**
      * Slot to change the default labels of the slider
+     *
+     * @defaultValue
+     * ```ts
+     * ({value}: SliderSlotLabelContext) => '' + value
+     * ```
      */
     label: SlotContent<SliderSlotLabelContext>;
     /**
-     * Slot to change the handlers
+     *  Slot to change the handlers
      */
     handle: SlotContent<SliderSlotHandleContext>;
 }
 export interface SliderProps {
     /**
      * 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;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -169,14 +245,26 @@ export interface SliderProps {
     structure: SlotContent<SliderContext>;
     /**
      * Slot to change the default labels of the slider
+     *
+     * @defaultValue
+     * ```ts
+     * ({value}: SliderSlotLabelContext) => '' + value
+     * ```
      */
     label: SlotContent<SliderSlotLabelContext>;
     /**
-     * Slot to change the handlers
+     *  Slot to change the handlers
      */
     handle: SlotContent<SliderSlotHandleContext>;
 }
 export type SliderWidget = Widget<SliderProps, SliderState, SliderApi, SliderActions, SliderDirectives>;
+/**
+ * Create a Slider with given config props
+ * @param config - an optional slider config
+ * @returns a SliderWidget
+ */
+declare const export_createSlider: WidgetFactory<SliderWidget>;
+export { export_createSlider as createSlider };
 export interface ProgressDisplayOptions {
     /**
      * Right offset of the progress in %
@@ -276,18 +364,25 @@ export interface SliderDirectives {
 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;
 }

package/components/slider/slider.gen.js

@@ -1 +1,14 @@
-export {};
+import { getSliderDefaultConfig, createSlider } from '@agnos-ui/core-bootstrap/components/slider';
+/**
+ * Retrieve a shallow copy of the default Slider config
+ * @returns the default Slider config
+ */
+const export_getSliderDefaultConfig = getSliderDefaultConfig;
+export { export_getSliderDefaultConfig as getSliderDefaultConfig };
+/**
+ * Create a Slider with given config props
+ * @param config - an optional slider config
+ * @returns a SliderWidget
+ */
+const export_createSlider = createSlider;
+export { export_createSlider as createSlider };

package/components/slider/slider.js

@@ -1,3 +1 @@
-import { createSlider as coreCreateSlider, getSliderDefaultConfig as coreGetSliderDefaultConfig } from '@agnos-ui/core-bootstrap/components/slider';
-export const createSlider = coreCreateSlider;
-export const getSliderDefaultConfig = coreGetSliderDefaultConfig;
+export * from './slider.gen';

package/components/toast/Toast.svelte.d.ts

@@ -2,7 +2,7 @@ import { SvelteComponent } from "svelte";
 import type { ToastApi, ToastProps, ToastSlots } from './toast';
 declare const __propDef: {
     props: {
-        api?: ToastApi | undefined;
+        api?: ToastApi;
     } & Partial<ToastProps>;
     events: {
         [evt: string]: CustomEvent<any>;

package/components/toast/toast.d.ts

@@ -1,7 +1,5 @@
-import type { WidgetPropsSlots, WidgetFactory } from '@agnos-ui/svelte-headless/types';
-import type { ToastWidget, ToastProps } from './toast.gen';
-export type * from './toast.gen';
-export declare const createToast: WidgetFactory<ToastWidget>;
-export declare const getToastDefaultConfig: () => ToastProps;
+import type { WidgetPropsSlots } from '@agnos-ui/svelte-headless/types';
+import type { ToastProps } from './toast.gen';
+export * from './toast.gen';
 export interface ToastSlots extends WidgetPropsSlots<ToastProps> {
 }