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

package/components/progressbar/progressbar.gen.d.ts

@@ -1,5 +1,11 @@
-import type { WidgetSlotContext, SlotContent, Widget, Directive } from '@agnos-ui/angular-headless';
+import type { WidgetSlotContext, SlotContent, Widget, WidgetFactory, Directive } from '@agnos-ui/angular-headless';
 import type { BSContextualClass } from '@agnos-ui/core-bootstrap/types';
+/**
+ * Retrieve a shallow copy of the default Progressbar config
+ * @returns the default Progressbar config
+ */
+declare const export_getProgressbarDefaultConfig: () => ProgressbarProps;
+export { export_getProgressbarDefaultConfig as getProgressbarDefaultConfig };
 export type ProgressbarContext = WidgetSlotContext<ProgressbarWidget>;
 export interface ProgressbarState {
     /**
@@ -20,22 +26,32 @@ export interface ProgressbarState {
     ariaValueText: string | undefined;
     /**
      * The minimum value.
+     *
+     * @defaultValue `0`
      */
     min: number;
     /**
      * The maximum value.
+     *
+     * @defaultValue `100`
      */
     max: number;
     /**
      * The current value.
+     *
+     * @defaultValue `0`
      */
     value: number;
     /**
      * The aria label.
+     *
+     * @defaultValue `'Progressbar'`
      */
     ariaLabel: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -48,15 +64,21 @@ export interface ProgressbarState {
     children: SlotContent<ProgressbarContext>;
     /**
      * Height of the progressbar, can be any valid css height value.
+     *
+     * @defaultValue `''`
      */
     height: string;
     /**
      * If `true`, shows a striped progressbar.
+     *
+     * @defaultValue `false`
      */
     striped: boolean;
     /**
      * If `true`, animates a striped progressbar.
      * Takes effect only for browsers supporting CSS3 animations, and if `striped` is `true`.
+     *
+     * @defaultValue `false`
      */
     animated: boolean;
     /**
@@ -67,26 +89,44 @@ export interface ProgressbarState {
 export interface ProgressbarProps {
     /**
      * Return the value for the 'aria-valuetext' attribute.
+     * @param value - current value
+     * @param minimum - minimum value
+     * @param maximum - maximum value
+     *
+     * @defaultValue
+     * ```ts
+     * () => undefined
+     * ```
      */
     ariaValueTextFn: (value: number, minimum: number, maximum: number) => string | undefined;
     /**
      * The minimum value.
+     *
+     * @defaultValue `0`
      */
     min: number;
     /**
      * The maximum value.
+     *
+     * @defaultValue `100`
      */
     max: number;
     /**
      * The current value.
+     *
+     * @defaultValue `0`
      */
     value: number;
     /**
      * The aria label.
+     *
+     * @defaultValue `'Progressbar'`
      */
     ariaLabel: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -99,15 +139,21 @@ export interface ProgressbarProps {
     children: SlotContent<ProgressbarContext>;
     /**
      * Height of the progressbar, can be any valid css height value.
+     *
+     * @defaultValue `''`
      */
     height: string;
     /**
      * If `true`, shows a striped progressbar.
+     *
+     * @defaultValue `false`
      */
     striped: boolean;
     /**
      * If `true`, animates a striped progressbar.
      * Takes effect only for browsers supporting CSS3 animations, and if `striped` is `true`.
+     *
+     * @defaultValue `false`
      */
     animated: boolean;
     /**
@@ -116,6 +162,13 @@ export interface ProgressbarProps {
     type: BSContextualClass | undefined;
 }
 export type ProgressbarWidget = Widget<ProgressbarProps, ProgressbarState, ProgressbarApi, object, ProgressbarDirectives>;
+/**
+ * Create a Progressbar with given config props
+ * @param config - an optional progressbar config
+ * @returns a ProgressbarWidget
+ */
+declare const export_createProgressbar: WidgetFactory<ProgressbarWidget>;
+export { export_createProgressbar as createProgressbar };
 export interface ProgressbarDirectives {
     /**
      * A directive to be applied to the main container that handles aria attributes.

package/components/rating/index.d.ts

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

package/components/rating/rating.component.d.ts

@@ -3,7 +3,7 @@ import { BaseWidgetDirective } from '@agnos-ui/angular-headless';
 import type { AfterContentChecked } from '@angular/core';
 import { EventEmitter, TemplateRef } from '@angular/core';
 import type { ControlValueAccessor } from '@angular/forms';
-import type { RatingWidget, StarContext } from './rating';
+import type { RatingWidget, StarContext } from './rating.gen';
 import * as i0 from "@angular/core";
 export declare class RatingStarDirective {
     templateRef: TemplateRef<any>;
@@ -17,68 +17,113 @@ export declare class RatingComponent extends BaseWidgetDirective<RatingWidget> i
     onTouched: () => void;
     /**
      * 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) | undefined;
     /**
      * If `true`, the rating is disabled.
+     *
+     * @defaultValue `false`
      */
     disabled: boolean | undefined;
     /**
      * The maximum rating that can be given.
+     *
+     * @defaultValue `10`
      */
     maxRating: number | undefined;
     /**
      * The current rating. Could be a decimal value like `3.75`.
+     *
+     * @defaultValue `0`
      */
     rating: number | undefined;
     /**
      * If `true`, the rating can't be changed.
+     *
+     * @defaultValue `false`
      */
     readonly: boolean | undefined;
     /**
      * 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 | undefined;
     /**
      * The template to override the way each star is displayed.
+     *
+     * @defaultValue
+     * ```ts
+     * ({fill}: StarContext) => String.fromCharCode(fill === 100 ? 9733 : 9734)
+     * ```
      */
     star: SlotContent<StarContext>;
     slotStarFromContent: RatingStarDirective | undefined;
     /**
      * Allows setting a custom rating tabindex.
      * If the component is disabled, `tabindex` will still be set to `-1`.
+     *
+     * @defaultValue `0`
      */
     tabindex: number | undefined;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string | undefined;
     /**
      * The aria label
+     *
+     * @defaultValue `'Rating'`
      */
     ariaLabel: string | undefined;
     /**
      * The aria labelled by
+     *
+     * @defaultValue `''`
      */
     ariaLabelledBy: string | undefined;
     /**
      * An event emitted when the user is hovering over a given rating.
      *
      * Event payload is equal to the rating being hovered over.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     hover: EventEmitter<number>;
     /**
      * 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
+     * () => {}
+     * ```
      */
     leave: EventEmitter<number>;
     /**
      * An event emitted when the rating is changed.
      *
      * Event payload is equal to the newly selected rating.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     ratingChange: EventEmitter<number>;
     writeValue(value: any): void;

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

@@ -1,4 +1,10 @@
-import type { SlotContent, Widget, Directive } from '@agnos-ui/angular-headless';
+import type { SlotContent, Widget, WidgetFactory, Directive } from '@agnos-ui/angular-headless';
+/**
+ * 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.d.ts

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

package/components/select/select.component.d.ts

@@ -3,7 +3,7 @@ import { BaseWidgetDirective } from '@agnos-ui/angular-headless';
 import type { AfterContentChecked } from '@angular/core';
 import { EventEmitter, TemplateRef } from '@angular/core';
 import type { Placement } from '@floating-ui/dom';
-import type { ItemContext, SelectItemContext, SelectWidget } from './select';
+import type { ItemContext, SelectItemContext, SelectWidget } from './select.gen';
 import * as i0 from "@angular/core";
 export declare class SelectBadgeLabelDirective<Item> {
     templateRef: TemplateRef<any>;
@@ -20,6 +20,8 @@ export declare class SelectItemLabelDirective<Item> {
 export declare class SelectComponent<Item> extends BaseWidgetDirective<SelectWidget<Item>> implements AfterContentChecked {
     /**
      * aria-label used for the input inside the select
+     *
+     * @defaultValue `'Select'`
      */
     ariaLabel: string | undefined;
     /**
@@ -28,80 +30,144 @@ export declare class SelectComponent<Item> extends BaseWidgetDirective<SelectWid
     id: string | undefined;
     /**
      * List of available items for the dropdown
+     *
+     * @defaultValue `[]`
      */
     items: Item[] | undefined;
     /**
      * 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[] | undefined;
     /**
      * true if the select is open
+     *
+     * @defaultValue `false`
      */
     open: boolean | undefined;
     /**
      * Filtered text to be display in the filter input
+     *
+     * @defaultValue `''`
      */
     filterText: string | undefined;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string | undefined;
     /**
      * true if the select is disabled
+     *
+     * @defaultValue `false`
      */
     disabled: boolean | undefined;
     /**
      * List of selected item ids
+     *
+     * @defaultValue `[]`
      */
     selected: Item[] | undefined;
     /**
      * true if a loading process is being done
+     *
+     * @defaultValue `false`
      */
     loading: boolean | undefined;
     /**
      * Custom function to get the id of an item
      * By default, the item is returned
+     *
+     * @defaultValue
+     * ```ts
+     * (item: any) => '' + item
+     * ```
      */
     itemIdFn: ((item: Item) => string) | undefined;
     /**
      * Class to be added on the dropdown menu container
+     *
+     * @defaultValue `''`
      */
     menuClassName: string | undefined;
     /**
      * 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>>;
     slotSelectBadgeLabelFromContent: SelectBadgeLabelDirective<Item> | undefined;
     /**
      * 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>>;
     slotSelectItemLabelFromContent: SelectItemLabelDirective<Item> | undefined;
     /**
      * Callback called when the text filter change
+     * @param text - Filtered text
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     filterTextChange: EventEmitter<string>;
     /**
      * Callback called when the selection change
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     selectedChange: EventEmitter<Item[]>;
     /**
      * Callback called dropdown open state change
+     * @param isOpen - updated open state
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     openChange: EventEmitter<boolean>;
     /**
      * Class to be added on menu items
+     *
+     * @defaultValue `''`
      */
     menuItemClassName: string | undefined;
     /**
      * Class to be added on selected items (displayed in the input zone)
+     *
+     * @defaultValue `''`
      */
     badgeClassName: string | undefined;
     /**
      * 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>) | undefined;
     readonly _widget: import("@agnos-ui/angular-headless").AngularWidget<SelectWidget<Item>>;