@agnos-ui/angular-bootstrap 0.8.1 → 0.9.0-next.0

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

@@ -1,584 +0,0 @@
-import type { WidgetSlotContext, SlotContent, Widget, WidgetFactory, Directive } from '@agnos-ui/angular-headless';
-/**
- * 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 interface PaginationContext extends WidgetSlotContext<PaginationWidget> {
-}
-/**
- * A type for the slot context of the pagination widget when the slot is the number label
- */
-export interface PaginationNumberContext extends PaginationContext {
-    /**
-     * Displayed page
-     */
-    displayedPage: number;
-}
-/**
- * Represents the state of a pagination component.
- */
-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`.
-     *
-     * @defaultValue `1`
-     */
-    page: number;
-    /**
-     * The label for the nav element.
-     *
-     * 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 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * The template to use for the pages slot
-     * To use to customize the pages view
-     * override any configuration parameters provided for this
-     */
-    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}`
-     * ```
-     */
-    numberLabel: SlotContent<PaginationNumberContext>;
-    /**
-     * The pagination display size.
-     *
-     * Bootstrap currently supports small and large sizes.
-     *
-     * @defaultValue `null`
-     */
-    size: 'sm' | 'lg' | null;
-}
-/**
- * Represents the properties for the Pagination component.
- */
-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.
-     *
-     * @defaultValue `0`
-     */
-    collectionSize: number;
-    /**
-     * The number of items per page.
-     * @remarks min value is 1
-     *
-     * @defaultValue `10`
-     */
-    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`.
-     * @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[];
-    /**
-     * 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
-     * @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;
-    /**
-     * 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
-     * @param currentPage - The current page number
-     * @param pageCount - The total number of pages
-     *
-     * @defaultValue
-     * ```ts
-     * (currentPage: 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 label for the nav element.
-     *
-     * 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 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * The template to use for the pages slot
-     * To use to customize the pages view
-     * override any configuration parameters provided for this
-     */
-    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}`
-     * ```
-     */
-    numberLabel: SlotContent<PaginationNumberContext>;
-    /**
-     * The pagination display size.
-     *
-     * Bootstrap currently supports small and large sizes.
-     *
-     * @defaultValue `null`
-     */
-    size: 'sm' | 'lg' | null;
-}
-/**
- * Represents a pagination widget component.
- *
- * This type defines a widget that handles pagination functionality,
- * including properties, state, api and directives specific to pagination.
- */
-export type PaginationWidget = Widget<PaginationProps, PaginationState, PaginationApi, 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 };
-/**
- * Interface representing the hrefs for pagination navigation links.
- */
-export interface DirectionsHrefs {
-    /**
-     * The href for the 'Previous' navigation link
-     */
-    previous: string;
-    /**
-     * The href for the 'Next' direction link
-     */
-    next: string;
-}
-/**
- * Interface representing pagination API for navigating through pages.
- */
-export interface PaginationApi {
-    /**
-     * To "go" to a specific page
-     * @param page - The page number to select
-     */
-    select(page: number): void;
-    /**
-     * To "go" to the first page
-     */
-    first(): void;
-    /**
-     * To "go" to the previous page
-     */
-    previous(): void;
-    /**
-     * To "go" to the next page
-     */
-    next(): void;
-    /**
-     * To "go" to the last page
-     */
-    last(): void;
-}
-/**
- * Interface representing the directives for pagination components.
- */
-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;
-}

package/components/progressbar/index.d.ts

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

package/components/progressbar/progressbar.component.d.ts

@@ -1,118 +0,0 @@
-import { BaseWidgetDirective } from '@agnos-ui/angular-headless';
-import type { SlotContent } from '@agnos-ui/angular-headless';
-import { TemplateRef } from '@angular/core';
-import type { ProgressbarContext, ProgressbarWidget } from './progressbar.gen';
-import type { BSContextualClass } from '@agnos-ui/core-bootstrap/types';
-import * as i0 from "@angular/core";
-/**
- * Directive that provides a template reference for the progress bar context.
- * This directive provides a template reference for the {@link ProgressbarContext}.
- */
-export declare class ProgressbarBodyDirective {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard(_dir: ProgressbarStructureDirective, context: unknown): context is ProgressbarContext;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ProgressbarBodyDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ProgressbarBodyDirective, "ng-template[auProgressbarBody]", never, {}, {}, never, never, true, never>;
-}
-/**
- * Directive to define the structure of a progress bar.
- *
- * This directive provides a template reference for the {@link ProgressbarContext}.
- */
-export declare class ProgressbarStructureDirective {
-    templateRef: TemplateRef<any>;
-    static ngTemplateContextGuard(_dir: ProgressbarStructureDirective, context: unknown): context is ProgressbarContext;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ProgressbarStructureDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ProgressbarStructureDirective, "ng-template[auProgressbarStructure]", never, {}, {}, never, never, true, never>;
-}
-/**
- * Represents the default slot structure for the progress bar component.
- */
-export declare const progressbarDefaultSlotStructure: SlotContent<ProgressbarContext>;
-/**
- * ProgressbarComponent is a UI component that extends the BaseWidgetDirective
- * to create a customizable progress bar widget. It provides various inputs
- * to configure the appearance and behavior of the progress bar.
- *
- */
-export declare class ProgressbarComponent extends BaseWidgetDirective<ProgressbarWidget> {
-    /**
-     * The aria label.
-     *
-     * @defaultValue `'Progressbar'`
-     */
-    readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * The minimum value.
-     *
-     * @defaultValue `0`
-     */
-    readonly min: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * The maximum value.
-     *
-     * @defaultValue `100`
-     */
-    readonly max: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * The current value.
-     *
-     * @defaultValue `0`
-     */
-    readonly value: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * CSS classes to be applied on the widget main container
-     *
-     * @defaultValue `''`
-     */
-    readonly className: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * Label of the progress.
-     */
-    readonly children: import("@angular/core").InputSignal<SlotContent<ProgressbarContext>>;
-    readonly slotDefaultFromContent: import("@angular/core").Signal<ProgressbarBodyDirective | undefined>;
-    /**
-     * Global template for the Progressbar.
-     */
-    readonly structure: import("@angular/core").InputSignal<SlotContent<ProgressbarContext>>;
-    readonly slotStructureFromContent: import("@angular/core").Signal<ProgressbarStructureDirective | undefined>;
-    /**
-     * Height of the progressbar, can be any valid css height value.
-     *
-     * @defaultValue `''`
-     */
-    readonly height: import("@angular/core").InputSignal<string | undefined>;
-    /**
-     * If `true`, animates a striped progressbar.
-     * Takes effect only for browsers supporting CSS3 animations, and if `striped` is `true`.
-     *
-     * @defaultValue `false`
-     */
-    readonly animated: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * If `true`, shows a striped progressbar.
-     *
-     * @defaultValue `false`
-     */
-    readonly striped: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * Return the value for the 'aria-valuetext' attribute.
-     * @param value - current value
-     * @param minimum - minimum value
-     * @param maximum - maximum value
-     *
-     * @defaultValue
-     * ```ts
-     * () => undefined
-     * ```
-     */
-    readonly ariaValueTextFn: import("@angular/core").InputSignal<((value: number, minimum: number, maximum: number) => string | undefined) | undefined>;
-    /**
-     * Type of the progressbar, following bootstrap types.
-     */
-    readonly type: import("@angular/core").InputSignal<BSContextualClass | undefined>;
-    readonly slotChildren: import("@angular/core").Signal<TemplateRef<void> | undefined>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<ProgressbarComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ProgressbarComponent, "[auProgressbar]", never, { "ariaLabel": { "alias": "auAriaLabel"; "required": false; "isSignal": true; }; "min": { "alias": "auMin"; "required": false; "isSignal": true; }; "max": { "alias": "auMax"; "required": false; "isSignal": true; }; "value": { "alias": "auValue"; "required": false; "isSignal": true; }; "className": { "alias": "auClassName"; "required": false; "isSignal": true; }; "children": { "alias": "auChildren"; "required": false; "isSignal": true; }; "structure": { "alias": "auStructure"; "required": false; "isSignal": true; }; "height": { "alias": "auHeight"; "required": false; "isSignal": true; }; "animated": { "alias": "auAnimated"; "required": false; "isSignal": true; }; "striped": { "alias": "auStriped"; "required": false; "isSignal": true; }; "ariaValueTextFn": { "alias": "auAriaValueTextFn"; "required": false; "isSignal": true; }; "type": { "alias": "auType"; "required": false; "isSignal": true; }; }, {}, ["slotDefaultFromContent", "slotStructureFromContent"], ["*"], true, never>;
-}