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

package/components/pagination/pagination.component.d.ts

@@ -2,7 +2,7 @@ import type { SlotContent } from '@agnos-ui/angular-headless';
 import { BaseWidgetDirective, ComponentTemplate } from '@agnos-ui/angular-headless';
 import type { AfterContentChecked } from '@angular/core';
 import { EventEmitter, TemplateRef } from '@angular/core';
-import type { PaginationContext, PaginationNumberContext, PaginationWidget } from './pagination';
+import type { PaginationContext, PaginationNumberContext, PaginationWidget } from './pagination.gen';
 import * as i0 from "@angular/core";
 /**
  * A directive to use to give the 'ellipsis' link template to the pagination component
@@ -98,6 +98,11 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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) | undefined;
     /**
@@ -105,6 +110,13 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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) | undefined;
     /**
@@ -112,49 +124,71 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      *
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue 'Page navigation'
+     *
+     * @defaultValue `'Page navigation'`
      */
     ariaLabel: string | undefined;
     /**
      * The label for the "active" page.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue '(current)'
+     *
+     * @defaultValue
+     * ```ts
+     * '(current)'
+     * ```
      */
     activeLabel: string | undefined;
     /**
      * The label for the "First" page button.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue 'Action link for first page'
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for first page'
+     * ```
      */
     ariaFirstLabel: string | undefined;
     /**
      * The label for the "Previous" page button.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue 'Action link for previous page'
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for previous page'
+     * ```
      */
     ariaPreviousLabel: string | undefined;
     /**
      * The label for the "Next" page button.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue 'Action link for next page'
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for next page'
+     * ```
      */
     ariaNextLabel: string | undefined;
     /**
      * The label for the "Last" page button.
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue 'Action link for last page'
+     *
+     * @defaultValue
+     * ```ts
+     * 'Action link for last page'
+     * ```
      */
     ariaLastLabel: string | undefined;
     /**
      * 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'
+     *
+     * @defaultValue `'Ellipsis page element'`
      */
     ariaEllipsisLabel: string | undefined;
     /**
@@ -162,6 +196,10 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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) | undefined;
     readonly _widget: import("@agnos-ui/angular-headless").AngularWidget<PaginationWidget>;
@@ -169,6 +207,8 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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 `'…'`
      */
     ellipsisLabel: SlotContent<PaginationContext>;
     slotEllipsisFromContent: PaginationEllipsisDirective | undefined;
@@ -176,6 +216,8 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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 `'«'`
      */
     firstPageLabel: SlotContent<PaginationContext>;
     slotFirstFromContent: PaginationFirstDirective | undefined;
@@ -183,6 +225,8 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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 `'‹'`
      */
     previousPageLabel: SlotContent<PaginationContext>;
     slotPreviousFromContent: PaginationPreviousDirective | undefined;
@@ -190,6 +234,8 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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 `'›'`
      */
     nextPageLabel: SlotContent<PaginationContext>;
     slotNextFromContent: PaginationNextDirective | undefined;
@@ -197,6 +243,8 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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 `'»'`
      */
     lastPageLabel: SlotContent<PaginationContext>;
     slotLastFromContent: PaginationLastDirective | undefined;
@@ -211,63 +259,95 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * 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}`
+     * ```
      */
     numberLabel: SlotContent<PaginationNumberContext>;
     slotNumberLabelFromContent: PaginationNumberDirective | undefined;
     /**
      * The template to use for the structure of the pagination component
-     * The default structure uses PaginationProps.ellipsisLabelellipsisLabel , PaginationProps.firstPageLabelfirstPageLabel ,
-     * PaginationProps.previousPageLabelpreviousPageLabel , PaginationProps.nextPageLabelnextPageLabel ,
-     * PaginationProps.lastPageLabellastPageLabel , PaginationProps.pagesDisplaypagesDisplay ,
-     * PaginationProps.numberLabelnumberLabel ,
+     * 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},
      */
     structure: SlotContent<PaginationContext>;
     slotStructureFromContent: PaginationStructureDirective | undefined;
     /**
      * If `true`, pagination links will be disabled.
+     *
+     * @defaultValue `false`
      */
     disabled: boolean | undefined;
     /**
      * If `true`, the "First" and "Last" page links are shown.
+     *
+     * @defaultValue `false`
      */
     boundaryLinks: boolean | undefined;
     /**
      * If `true`, the "Next" and "Previous" page links are shown.
+     *
+     * @defaultValue `true`
      */
     directionLinks: boolean | undefined;
     /**
      * 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.
+     * `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.
-     * @defaultValue 0
+     *
+     * @defaultValue `0`
      */
     collectionSize: number | undefined;
     /**
      * The current page.
      *
      * Page numbers start with `1`.
-     * @defaultValue 1
+     *
+     * @defaultValue `1`
      */
     page: number | undefined;
     /**
      * The number of items per page.
-     * @defaultValue 10
+     * @remarks min value is 1
+     *
+     * @defaultValue `10`
      */
     pageSize: number | undefined;
     /**
      * The pagination display size.
      *
      * Bootstrap currently supports small and large sizes.
-     * @defaultValue null
+     *
+     * @defaultValue `null`
      */
     size: 'sm' | 'lg' | null | undefined;
     /**
      * 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[]) | undefined;
     /**
@@ -276,10 +356,16 @@ export declare class PaginationComponent extends BaseWidgetDirective<PaginationW
      * Event payload is the number of the newly selected page.
      *
      * Page numbers start with `1`.
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     pageChange: EventEmitter<number>;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string | undefined;
     ngAfterContentChecked(): void;