@agnos-ui/react-bootstrap 0.3.1 → 0.4.0-next.0

package/components/pagination/pagination.gen.d.ts

@@ -0,0 +1,394 @@
+import type { WidgetSlotContext, SlotContent, Widget, Directive } from '@agnos-ui/react-headless/types';
+export type PaginationContext = WidgetSlotContext<PaginationWidget>;
+export type PaginationNumberContext = PaginationContext & {
+    /**
+     * Displayed page
+     */
+    displayedPage: number;
+};
+export interface PaginationState {
+    /**
+     * The number of pages.
+     */
+    pageCount: number;
+    /**
+     * The current pages, the number in the Array is the number of the page.
+     */
+    pages: number[];
+    /**
+     * true if the previous link need to be disabled
+     */
+    previousDisabled: boolean;
+    /**
+     * true if the next link need to be disabled
+     */
+    nextDisabled: boolean;
+    /**
+     * The label for each "Page" page link.
+     */
+    pagesLabel: string[];
+    /**
+     * The hrefs for each "Page" page link
+     */
+    pagesHrefs: string[];
+    /**
+     * The hrefs for the direction links
+     */
+    directionsHrefs: DirectionsHrefs;
+    /**
+     * The aria-live text
+     */
+    ariaLiveLabelText: string;
+    /**
+     * The current page.
+     *
+     * Page numbers start with `1`.
+     */
+    page: number;
+    /**
+     * The pagination display size.
+     *
+     * Bootstrap currently supports small and large sizes.
+     */
+    size: 'sm' | 'lg' | null;
+    /**
+     * The label for the nav element.
+     *
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    ariaLabel: string;
+    /**
+     * The label for the "active" page.
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    ariaLastLabel: string;
+    /**
+     * The label for the "Ellipsis" page.
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    ariaEllipsisLabel: string;
+    /**
+     * If `true`, pagination links will be disabled.
+     */
+    disabled: boolean;
+    /**
+     * If `true`, the "Next" and "Previous" page links are shown.
+     */
+    directionLinks: boolean;
+    /**
+     * If `true`, the "First" and "Last" page links are shown.
+     */
+    boundaryLinks: boolean;
+    /**
+     * CSS classes to be applied on the widget main container
+     */
+    className: string;
+    /**
+     * The template to use for the structure of the pagination component
+     * The default structure uses {@link PaginationCommonPropsAndState.slotEllipsis slotEllipsis}, {@link PaginationCommonPropsAndState.slotFirst slotFirst},
+     * {@link PaginationCommonPropsAndState.slotPrevious slotPrevious}, {@link PaginationCommonPropsAndState.slotNext slotNext},
+     * {@link PaginationCommonPropsAndState.slotLast slotLast}, {@link PaginationCommonPropsAndState.slotPages slotPages},
+     * {@link PaginationCommonPropsAndState.slotNumberLabel slotNumberLabel},
+     */
+    slotStructure: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the ellipsis slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotEllipsis: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the first slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotFirst: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the previous slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotPrevious: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the next slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotNext: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the last slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotLast: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the pages slot
+     * To use to customize the pages view
+     * override any configuration parameters provided for this
+     */
+    slotPages: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the number slot
+     * override any configuration parameters provided for this
+     * for I18n, we suggest to use the global configuration
+     */
+    slotNumberLabel: SlotContent<PaginationNumberContext>;
+}
+export interface PaginationProps {
+    /**
+     * The number of items in your paginated collection.
+     *
+     * Note, that this is not the number of pages. Page numbers are calculated dynamically based on
+     * `collectionSize` and `pageSize`.
+     *
+     * 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.
+     */
+    collectionSize: number;
+    /**
+     * The number of items per page.
+     */
+    pageSize: number;
+    /**
+     * An event fired when the page is changed.
+     *
+     * Event payload is the number of the newly selected page.
+     *
+     * Page numbers start with `1`.
+     */
+    onPageChange: (page: number) => void;
+    /**
+     * pagesFactory returns a function computing the array of pages to be displayed
+     * as number (-1 are treated as ellipsis).
+     * Use Page slot to customize the pages view and not this
+     */
+    pagesFactory: (page: number, pageCount: number) => number[];
+    /**
+     * Provide the label for each "Page" page button.
+     * This is used for accessibility purposes.
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    ariaPageLabel: (processPage: number, pageCount: number) => string;
+    /**
+     * Provide the label for the aria-live element
+     * This is used for accessibility purposes.
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    ariaLiveLabel: (currentPage: number, pageCount: number) => string;
+    /**
+     * Factory function providing the href for a "Page" page anchor,
+     * based on the current page number
+     */
+    pageLink: (pageNumber: number) => string;
+    /**
+     * The current page.
+     *
+     * Page numbers start with `1`.
+     */
+    page: number;
+    /**
+     * The pagination display size.
+     *
+     * Bootstrap currently supports small and large sizes.
+     */
+    size: 'sm' | 'lg' | null;
+    /**
+     * The label for the nav element.
+     *
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    ariaLabel: string;
+    /**
+     * The label for the "active" page.
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    ariaLastLabel: string;
+    /**
+     * The label for the "Ellipsis" page.
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    ariaEllipsisLabel: string;
+    /**
+     * If `true`, pagination links will be disabled.
+     */
+    disabled: boolean;
+    /**
+     * If `true`, the "Next" and "Previous" page links are shown.
+     */
+    directionLinks: boolean;
+    /**
+     * If `true`, the "First" and "Last" page links are shown.
+     */
+    boundaryLinks: boolean;
+    /**
+     * CSS classes to be applied on the widget main container
+     */
+    className: string;
+    /**
+     * The template to use for the structure of the pagination component
+     * The default structure uses {@link PaginationCommonPropsAndState.slotEllipsis slotEllipsis}, {@link PaginationCommonPropsAndState.slotFirst slotFirst},
+     * {@link PaginationCommonPropsAndState.slotPrevious slotPrevious}, {@link PaginationCommonPropsAndState.slotNext slotNext},
+     * {@link PaginationCommonPropsAndState.slotLast slotLast}, {@link PaginationCommonPropsAndState.slotPages slotPages},
+     * {@link PaginationCommonPropsAndState.slotNumberLabel slotNumberLabel},
+     */
+    slotStructure: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the ellipsis slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotEllipsis: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the first slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotFirst: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the previous slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotPrevious: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the next slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotNext: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the last slot
+     * for I18n, we suggest to use the global configuration
+     * override any configuration parameters provided for this
+     */
+    slotLast: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the pages slot
+     * To use to customize the pages view
+     * override any configuration parameters provided for this
+     */
+    slotPages: SlotContent<PaginationContext>;
+    /**
+     * The template to use for the number slot
+     * override any configuration parameters provided for this
+     * for I18n, we suggest to use the global configuration
+     */
+    slotNumberLabel: SlotContent<PaginationNumberContext>;
+}
+export type PaginationWidget = Widget<PaginationProps, PaginationState, PaginationApi, PaginationActions, PaginationDirectives>;
+export interface DirectionsHrefs {
+    /**
+     * The href for the 'Previous' navigation link
+     */
+    previous: string;
+    /**
+     * The href for the 'Next' direction link
+     */
+    next: string;
+}
+export interface PaginationActions {
+    /**
+     * To "go" to a specific page
+     */
+    select(page: number, event?: MouseEvent): void;
+    /**
+     * To "go" to the first page
+     */
+    first(event?: MouseEvent): void;
+    /**
+     * To "go" to the previous page
+     */
+    previous(event?: MouseEvent): void;
+    /**
+     * To "go" to the next page
+     */
+    next(event?: MouseEvent): void;
+    /**
+     * To "go" to the last page
+     */
+    last(event?: MouseEvent): void;
+}
+export interface PaginationDirectives {
+    /**
+     * A directive to be applied to each page link
+     * This will handle the click, tabindex and aria attributes
+     */
+    pageLink: Directive<{
+        page: number;
+    }>;
+    /**
+     * A directive to be applied on the previous link
+     */
+    pagePrev: Directive;
+    /**
+     * A directive to be applied on the first link
+     */
+    pageFirst: Directive;
+    /**
+     * A directive to be applied on the next link
+     */
+    pageNext: Directive;
+    /**
+     * A directive to be applied on the Last link
+     */
+    pageLast: Directive;
+}
+export interface PaginationApi {
+}

package/components/progressbar/index.cjs

@@ -1,13 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const progressbar = require("../../progressbar-D-yo9AHH.cjs");
-const progressbar$1 = require("@agnos-ui/core-bootstrap/components/progressbar");
+const progressbar = require("../../progressbar-Bi9aS9jg.cjs");
 exports.Progressbar = progressbar.Progressbar;
 exports.createProgressbar = progressbar.createProgressbar;
-Object.keys(progressbar$1).forEach((k) => {
-  if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k))
-    Object.defineProperty(exports, k, {
-      enumerable: true,
-      get: () => progressbar$1[k]
-    });
-});
+exports.getProgressbarDefaultConfig = progressbar.getProgressbarDefaultConfig;

package/components/progressbar/index.js

@@ -1,6 +1,6 @@
-import { P, c } from "../../progressbar-D1-6Dzrf.js";
-export * from "@agnos-ui/core-bootstrap/components/progressbar";
+import { P, c, g } from "../../progressbar-D8_F2wYh.js";
 export {
   P as Progressbar,
-  c as createProgressbar
+  c as createProgressbar,
+  g as getProgressbarDefaultConfig
 };

package/components/progressbar/progressbar.d.ts

@@ -1,9 +1,6 @@
-import { type PropsWithChildren } from 'react';
-export * from '@agnos-ui/core-bootstrap/components/progressbar';
-import type { AdaptSlotContentProps, AdaptWidgetSlots, WidgetFactory, WidgetProps, WidgetState } from '@agnos-ui/react-headless/types';
-export type ProgressbarWidget = AdaptWidgetSlots<import('@agnos-ui/core-bootstrap/components/progressbar').ProgressbarWidget>;
-export type ProgressbarProps = WidgetProps<ProgressbarWidget>;
-export type ProgressbarState = WidgetState<ProgressbarWidget>;
-export type ProgressbarContext = AdaptSlotContentProps<import('@agnos-ui/core-bootstrap/components/progressbar').ProgressbarContext>;
+import type { WidgetFactory } from '@agnos-ui/react-headless/types';
+import type { ProgressbarProps, ProgressbarWidget } from './progressbar.gen';
+export type * from './progressbar.gen';
 export declare const createProgressbar: WidgetFactory<ProgressbarWidget>;
-export declare const Progressbar: (props: PropsWithChildren<Partial<ProgressbarProps>>) => import("react/jsx-runtime").JSX.Element;
+export declare const getProgressbarDefaultConfig: () => ProgressbarProps;
+export declare const Progressbar: (props: Partial<ProgressbarProps>) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,126 @@
+import type { WidgetSlotContext, SlotContent, Widget, Directive } from '@agnos-ui/react-headless/types';
+import type { BSContextualClass } from '@agnos-ui/core-bootstrap/types';
+export type ProgressbarContext = WidgetSlotContext<ProgressbarWidget>;
+export interface ProgressbarState {
+    /**
+     * Percentage of completion.
+     */
+    percentage: number;
+    /**
+     * `true` if the value is above its minimum value.
+     */
+    started: boolean;
+    /**
+     * `true` if the value has reached its maximum value.
+     */
+    finished: boolean;
+    /**
+     * The aria value text.
+     */
+    ariaValueText: string | undefined;
+    /**
+     * The minimum value.
+     */
+    min: number;
+    /**
+     * The maximum value.
+     */
+    max: number;
+    /**
+     * The current value.
+     */
+    value: number;
+    /**
+     * The aria label.
+     */
+    ariaLabel: string;
+    /**
+     * CSS classes to be applied on the widget main container
+     */
+    className: string;
+    /**
+     * Global template for the Progressbar.
+     */
+    slotStructure: SlotContent<ProgressbarContext>;
+    /**
+     * Label of the progress.
+     */
+    children: SlotContent<ProgressbarContext>;
+    /**
+     * Height of the progressbar, can be any valid css height value.
+     */
+    height: string;
+    /**
+     * If `true`, shows a striped progressbar.
+     */
+    striped: boolean;
+    /**
+     * If `true`, animates a striped progressbar.
+     * Takes effect only for browsers supporting CSS3 animations, and if `striped` is `true`.
+     */
+    animated: boolean;
+    /**
+     * Type of the progressbar, following bootstrap types.
+     */
+    type: BSContextualClass | undefined;
+}
+export interface ProgressbarProps {
+    /**
+     * Return the value for the 'aria-valuetext' attribute.
+     */
+    ariaValueTextFn: (value: number, minimum: number, maximum: number) => string | undefined;
+    /**
+     * The minimum value.
+     */
+    min: number;
+    /**
+     * The maximum value.
+     */
+    max: number;
+    /**
+     * The current value.
+     */
+    value: number;
+    /**
+     * The aria label.
+     */
+    ariaLabel: string;
+    /**
+     * CSS classes to be applied on the widget main container
+     */
+    className: string;
+    /**
+     * Global template for the Progressbar.
+     */
+    slotStructure: SlotContent<ProgressbarContext>;
+    /**
+     * Label of the progress.
+     */
+    children: SlotContent<ProgressbarContext>;
+    /**
+     * Height of the progressbar, can be any valid css height value.
+     */
+    height: string;
+    /**
+     * If `true`, shows a striped progressbar.
+     */
+    striped: boolean;
+    /**
+     * If `true`, animates a striped progressbar.
+     * Takes effect only for browsers supporting CSS3 animations, and if `striped` is `true`.
+     */
+    animated: boolean;
+    /**
+     * Type of the progressbar, following bootstrap types.
+     */
+    type: BSContextualClass | undefined;
+}
+export type ProgressbarWidget = Widget<ProgressbarProps, ProgressbarState, ProgressbarApi, object, ProgressbarDirectives>;
+export interface ProgressbarDirectives {
+    /**
+     * A directive to be applied to the main container that handles aria attributes.
+     */
+    ariaDirective: Directive;
+}
+export interface ProgressbarApi {
+}

package/components/rating/index.cjs

@@ -1,13 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const rating = require("../../rating-D2Ajh4vg.cjs");
-const rating$1 = require("@agnos-ui/react-headless/components/rating");
+const rating = require("../../rating-DB4Ze-r4.cjs");
 exports.Rating = rating.Rating;
 exports.createRating = rating.createRating;
-Object.keys(rating$1).forEach((k) => {
-  if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k))
-    Object.defineProperty(exports, k, {
-      enumerable: true,
-      get: () => rating$1[k]
-    });
-});
+exports.getRatingDefaultConfig = rating.getRatingDefaultConfig;

package/components/rating/index.js

@@ -1,6 +1,6 @@
-import { R, c } from "../../rating-Cvad2Z2H.js";
-export * from "@agnos-ui/react-headless/components/rating";
+import { R, c, g } from "../../rating-DRAx20tg.js";
 export {
   R as Rating,
-  c as createRating
+  c as createRating,
+  g as getRatingDefaultConfig
 };

package/components/rating/rating.d.ts

@@ -1,7 +1,6 @@
-import type { AdaptWidgetSlots, WidgetFactory, WidgetProps, WidgetState } from '@agnos-ui/react-headless/types';
-export * from '@agnos-ui/react-headless/components/rating';
-export type RatingWidget = AdaptWidgetSlots<import('@agnos-ui/core-bootstrap/components/rating').RatingWidget>;
-export type RatingProps = WidgetProps<RatingWidget>;
-export type RatingState = WidgetState<RatingWidget>;
+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;
 export declare function Rating(props: Partial<RatingProps>): import("react/jsx-runtime").JSX.Element;