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

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

@@ -1,5 +1,17 @@
-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 Pagination config
+ * @returns the default Pagination config
+ */
+declare const export_getPaginationDefaultConfig: () => PaginationProps;
+export { export_getPaginationDefaultConfig as getPaginationDefaultConfig };
+/**
+ * A type for the slot context of the pagination widget
+ */
 export type PaginationContext = WidgetSlotContext<PaginationWidget>;
+/**
+ * A type for the slot context of the pagination widget when the slot is the number label
+ */
 export type PaginationNumberContext = PaginationContext & {
     /**
      * Displayed page
@@ -27,28 +39,26 @@ export interface PaginationState {
      * The label for each "Page" page link.
      */
     pagesLabel: string[];
-    /**
-     * The hrefs for each "Page" page link
-     */
+    /** The hrefs for each "Page" page link */
     pagesHrefs: string[];
-    /**
-     * The hrefs for the direction links
-     */
+    /** The hrefs for the direction links  */
     directionsHrefs: DirectionsHrefs;
-    /**
-     * The aria-live text
-     */
+    /** The aria-live text */
     ariaLiveLabelText: string;
     /**
      * The current page.
      *
      * Page numbers start with `1`.
+     *
+     * @defaultValue `1`
      */
     page: number;
     /**
      * The pagination display size.
      *
      * Bootstrap currently supports small and large sizes.
+     *
+     * @defaultValue `null`
      */
     size: 'sm' | 'lg' | null;
     /**
@@ -56,110 +66,163 @@ export interface PaginationState {
      *
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     *
+     * @defaultValue `'Page navigation'`
      */
     ariaLabel: string;
     /**
      * The label for the "active" page.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     *
+     * @defaultValue
+     * ```ts
+     * '(current)'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for first page'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for previous page'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for next page'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for last page'
+     * ```
      */
     ariaLastLabel: string;
     /**
      * The label for the "Ellipsis" page.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     *
+     * @defaultValue `'Ellipsis page element'`
      */
     ariaEllipsisLabel: string;
     /**
      * If `true`, pagination links will be disabled.
+     *
+     * @defaultValue `false`
      */
     disabled: boolean;
     /**
      * If `true`, the "Next" and "Previous" page links are shown.
+     *
+     * @defaultValue `true`
      */
     directionLinks: boolean;
     /**
      * If `true`, the "First" and "Last" page links are shown.
+     *
+     * @defaultValue `false`
      */
     boundaryLinks: boolean;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     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},
+     * The default structure uses {@link PaginationProps.ellipsisLabel|ellipsisLabel}, {@link PaginationProps.firstPageLabel|firstPageLabel},
+     * {@link PaginationProps.previousPageLabel|previousPageLabel}, {@link PaginationProps.nextPageLabel|nextPageLabel},
+     * {@link PaginationProps.lastPageLabel|lastPageLabel}, {@link PaginationProps.pagesDisplay|pagesDisplay},
+     * {@link PaginationProps.numberLabel|numberLabel},
      */
-    slotStructure: SlotContent<PaginationContext>;
+    structure: 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
+     *
+     * @defaultValue `'…'`
      */
-    slotEllipsis: SlotContent<PaginationContext>;
+    ellipsisLabel: 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
+     *
+     * @defaultValue `'«'`
      */
-    slotFirst: SlotContent<PaginationContext>;
+    firstPageLabel: 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
+     *
+     * @defaultValue `'‹'`
      */
-    slotPrevious: SlotContent<PaginationContext>;
+    previousPageLabel: 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
+     *
+     * @defaultValue `'›'`
      */
-    slotNext: SlotContent<PaginationContext>;
+    nextPageLabel: 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
+     *
+     * @defaultValue `'»'`
      */
-    slotLast: SlotContent<PaginationContext>;
+    lastPageLabel: 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>;
+    pagesDisplay: 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
+     * @param displayedPage - The current page number
+     *
+     * @defaultValue
+     * ```ts
+     * ({displayedPage}: PaginationNumberContext) => `${displayedPage}`
+     * ```
      */
-    slotNumberLabel: SlotContent<PaginationNumberContext>;
+    numberLabel: SlotContent<PaginationNumberContext>;
 }
 export interface PaginationProps {
     /**
@@ -171,10 +234,15 @@ export interface PaginationProps {
      * 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.
+     *
+     * @defaultValue `0`
      */
     collectionSize: number;
     /**
      * The number of items per page.
+     * @remarks min value is 1
+     *
+     * @defaultValue `10`
      */
     pageSize: number;
     /**
@@ -183,12 +251,29 @@ export interface PaginationProps {
      * Event payload is the number of the newly selected page.
      *
      * Page numbers start with `1`.
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     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
+     * @param page - The current page number
+     * @param pageCount - The total number of pages
+     *
+     * @defaultValue
+     * ```ts
+     * (_page: number, pageCount: number) => {
+     * 		const pages: number[] = [];
+     * 		for (let i = 1; i <= pageCount; i++) {
+     * 			pages.push(i);
+     * 		}
+     * 		return pages;
+     * 	}
+     * ```
      */
     pagesFactory: (page: number, pageCount: number) => number[];
     /**
@@ -196,6 +281,13 @@ export interface PaginationProps {
      * This is used for accessibility purposes.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     * @param processPage - The current page number
+     * @param pageCount - The total number of pages
+     *
+     * @defaultValue
+     * ```ts
+     * (processPage: number, pageCount: number) => `Page ${processPage} of ${pageCount}`
+     * ```
      */
     ariaPageLabel: (processPage: number, pageCount: number) => string;
     /**
@@ -203,23 +295,40 @@ export interface PaginationProps {
      * This is used for accessibility purposes.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     * @param currentPage - The current page number
+     * @param pageCount - The total number of pages
+     *
+     * @defaultValue
+     * ```ts
+     * (currentPage: number, pageCount: number) => `Current page is ${currentPage}`
+     * ```
      */
     ariaLiveLabel: (currentPage: number, pageCount: number) => string;
     /**
      * Factory function providing the href for a "Page" page anchor,
      * based on the current page number
+     * @param pageNumber - The index to use in the link
+     *
+     * @defaultValue
+     * ```ts
+     * (_page: number) => PAGE_LINK_DEFAULT
+     * ```
      */
     pageLink: (pageNumber: number) => string;
     /**
      * The current page.
      *
      * Page numbers start with `1`.
+     *
+     * @defaultValue `1`
      */
     page: number;
     /**
      * The pagination display size.
      *
      * Bootstrap currently supports small and large sizes.
+     *
+     * @defaultValue `null`
      */
     size: 'sm' | 'lg' | null;
     /**
@@ -227,112 +336,172 @@ export interface PaginationProps {
      *
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     *
+     * @defaultValue `'Page navigation'`
      */
     ariaLabel: string;
     /**
      * The label for the "active" page.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     *
+     * @defaultValue
+     * ```ts
+     * '(current)'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for first page'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for previous page'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for next page'
+     * ```
      */
     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
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for last page'
+     * ```
      */
     ariaLastLabel: string;
     /**
      * The label for the "Ellipsis" page.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
+     *
+     * @defaultValue `'Ellipsis page element'`
      */
     ariaEllipsisLabel: string;
     /**
      * If `true`, pagination links will be disabled.
+     *
+     * @defaultValue `false`
      */
     disabled: boolean;
     /**
      * If `true`, the "Next" and "Previous" page links are shown.
+     *
+     * @defaultValue `true`
      */
     directionLinks: boolean;
     /**
      * If `true`, the "First" and "Last" page links are shown.
+     *
+     * @defaultValue `false`
      */
     boundaryLinks: boolean;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     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},
+     * The default structure uses {@link PaginationProps.ellipsisLabel|ellipsisLabel}, {@link PaginationProps.firstPageLabel|firstPageLabel},
+     * {@link PaginationProps.previousPageLabel|previousPageLabel}, {@link PaginationProps.nextPageLabel|nextPageLabel},
+     * {@link PaginationProps.lastPageLabel|lastPageLabel}, {@link PaginationProps.pagesDisplay|pagesDisplay},
+     * {@link PaginationProps.numberLabel|numberLabel},
      */
-    slotStructure: SlotContent<PaginationContext>;
+    structure: 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
+     *
+     * @defaultValue `'…'`
      */
-    slotEllipsis: SlotContent<PaginationContext>;
+    ellipsisLabel: 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
+     *
+     * @defaultValue `'«'`
      */
-    slotFirst: SlotContent<PaginationContext>;
+    firstPageLabel: 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
+     *
+     * @defaultValue `'‹'`
      */
-    slotPrevious: SlotContent<PaginationContext>;
+    previousPageLabel: 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
+     *
+     * @defaultValue `'›'`
      */
-    slotNext: SlotContent<PaginationContext>;
+    nextPageLabel: 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
+     *
+     * @defaultValue `'»'`
      */
-    slotLast: SlotContent<PaginationContext>;
+    lastPageLabel: 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>;
+    pagesDisplay: 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
+     * @param displayedPage - The current page number
+     *
+     * @defaultValue
+     * ```ts
+     * ({displayedPage}: PaginationNumberContext) => `${displayedPage}`
+     * ```
      */
-    slotNumberLabel: SlotContent<PaginationNumberContext>;
+    numberLabel: SlotContent<PaginationNumberContext>;
 }
 export type PaginationWidget = Widget<PaginationProps, PaginationState, PaginationApi, PaginationActions, PaginationDirectives>;
+/**
+ * Create a PaginationWidget with given config props
+ * @param config - an optional alert config
+ * @returns a PaginationWidget
+ */
+declare const export_createPagination: WidgetFactory<PaginationWidget>;
+export { export_createPagination as createPagination };
 export interface DirectionsHrefs {
     /**
      * The href for the 'Previous' navigation link
@@ -346,6 +515,7 @@ export interface DirectionsHrefs {
 export interface PaginationActions {
     /**
      * To "go" to a specific page
+     * @param page - The page number to select
      */
     select(page: number, event?: MouseEvent): void;
     /**

package/components/pagination/pagination.gen.js

@@ -1 +1,14 @@
-export {};
+import { getPaginationDefaultConfig, createPagination } from '@agnos-ui/core-bootstrap/components/pagination';
+/**
+ * Retrieve a shallow copy of the default Pagination config
+ * @returns the default Pagination config
+ */
+const export_getPaginationDefaultConfig = getPaginationDefaultConfig;
+export { export_getPaginationDefaultConfig as getPaginationDefaultConfig };
+/**
+ * Create a PaginationWidget with given config props
+ * @param config - an optional alert config
+ * @returns a PaginationWidget
+ */
+const export_createPagination = createPagination;
+export { export_createPagination as createPagination };

package/components/pagination/pagination.js

@@ -1,3 +1 @@
-import { createPagination as coreCreatePagination, getPaginationDefaultConfig as coreGetPaginationDefaultConfig, } from '@agnos-ui/core-bootstrap/components/pagination';
-export const createPagination = coreCreatePagination;
-export const getPaginationDefaultConfig = coreGetPaginationDefaultConfig;
+export * from './pagination.gen';

package/components/progressbar/Progressbar.svelte

@@ -11,12 +11,12 @@ const widget = callWidgetFactory({
   $$slots,
   $$props,
   defaultConfig: {
-    slotStructure: ProgressbarDefaultStructure
+    structure: ProgressbarDefaultStructure
   },
   events: {}
 });
 const {
-  stores: { slotStructure$, className$ },
+  stores: { structure$, className$ },
   state$,
   directives: { ariaDirective }
 } = widget;
@@ -26,7 +26,7 @@ $: slotContext = { widget, state: $state$ };
 </script>
 
 <div use:ariaDirective use:__AgnosUISveltePreprocess__classDirective={($className$ || undefined)} {...__AgnosUISveltePreprocess__BROWSER ? {} : __AgnosUISveltePreprocess__ssrAttributes(ariaDirective, [__AgnosUISveltePreprocess__classDirective, ($className$ || undefined)])}>
-	<Slot slotContent={$slotStructure$} props={slotContext} let:component let:props>
+	<Slot slotContent={$structure$} props={slotContext} let:component let:props>
 		<svelte:fragment slot="slot" let:props><slot name="structure" {...props} /></svelte:fragment>
 		<svelte:component this={component} {...props}>
 			<svelte:fragment let:state let:widget><slot {state} {widget} /></svelte:fragment>

package/components/progressbar/Progressbar.svelte.d.ts

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

package/components/progressbar/progressbar.d.ts

@@ -1,7 +1,5 @@
-import type { WidgetPropsSlots, WidgetFactory } from '@agnos-ui/svelte-headless/types';
-import type { ProgressbarProps, ProgressbarWidget } from './progressbar.gen';
-export type * from './progressbar.gen';
-export declare const createProgressbar: WidgetFactory<ProgressbarWidget>;
-export declare const getProgressbarDefaultConfig: () => ProgressbarProps;
+import type { WidgetPropsSlots } from '@agnos-ui/svelte-headless/types';
+import type { ProgressbarProps } from './progressbar.gen';
+export * from './progressbar.gen';
 export interface ProgressbarSlots extends WidgetPropsSlots<ProgressbarProps> {
 }