ng-primitives 0.120.4 → 0.121.0

package/types/ng-primitives-pagination.d.ts

@@ -0,0 +1,502 @@
+import * as _angular_core from '@angular/core';
+import { WritableSignal, Signal } from '@angular/core';
+import { NumberInput, BooleanInput } from '@angular/cdk/coercion';
+import * as rxjs from 'rxjs';
+import { Observable } from 'rxjs';
+import * as ng_primitives_state from 'ng-primitives/state';
+
+/**
+ * The `NgpPaginationButton` directive is used to create a pagination button.
+ */
+declare class NgpPaginationButton {
+    /**
+     * Define the page this button represents.
+     */
+    readonly page: _angular_core.InputSignalWithTransform<number, NumberInput>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    protected readonly state: {
+        page: _angular_core.Signal<number>;
+        disabled: _angular_core.Signal<boolean>;
+        goToPage: () => void;
+    };
+    /**
+     * Go to the page this button represents.
+     */
+    goToPage(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationButton, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationButton, "[ngpPaginationButton]", ["ngpPaginationButton"], { "page": { "alias": "ngpPaginationButtonPage"; "required": true; "isSignal": true; }; "disabled": { "alias": "ngpPaginationButtonDisabled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * The `NgpPaginationFirst` directive is used to create a pagination button that navigates to the first page.
+ */
+declare class NgpPaginationFirst {
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    protected readonly state: {
+        disabled: _angular_core.Signal<boolean>;
+        goToFirstPage: () => void;
+    };
+    /**
+     * Go to the first page.
+     */
+    goToFirstPage(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationFirst, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationFirst, "[ngpPaginationFirst]", ["ngpPaginationFirst"], { "disabled": { "alias": "ngpPaginationFirstDisabled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * The `NgpPaginationLast` directive is used to create a pagination button that navigates to the last page.
+ */
+declare class NgpPaginationLast {
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    protected readonly state: {
+        disabled: _angular_core.Signal<boolean>;
+        goToLastPage: () => void;
+    };
+    /**
+     * Go to the last page.
+     */
+    goToLastPage(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationLast, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationLast, "[ngpPaginationLast]", ["ngpPaginationLast"], { "disabled": { "alias": "ngpPaginationLastDisabled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * The `NgpPaginationNext` directive is used to create a pagination button that navigates to the next page.
+ */
+declare class NgpPaginationNext {
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    protected readonly state: {
+        disabled: _angular_core.Signal<boolean>;
+        goToNextPage: () => void;
+    };
+    /**
+     * Go to the next page.
+     */
+    goToNextPage(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationNext, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationNext, "[ngpPaginationNext]", ["ngpPaginationNext"], { "disabled": { "alias": "ngpPaginationNextDisabled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * The `NgpPaginationPrevious` directive is used to create a pagination button that navigates to the previous page.
+ */
+declare class NgpPaginationPrevious {
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    protected readonly state: {
+        disabled: _angular_core.Signal<boolean>;
+        goToPreviousPage: () => void;
+    };
+    /**
+     * Go to the previous page.
+     */
+    goToPreviousPage(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationPrevious, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationPrevious, "[ngpPaginationPrevious]", ["ngpPaginationPrevious"], { "disabled": { "alias": "ngpPaginationPreviousDisabled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * The `NgpPagination` directive is used to create a pagination control.
+ */
+declare class NgpPagination {
+    /**
+     * The currently selected page. Leave unset for uncontrolled usage, where the
+     * internal state is seeded from `defaultPage`.
+     */
+    readonly page: _angular_core.InputSignalWithTransform<number | undefined, NumberInput>;
+    /**
+     * The default page for uncontrolled usage.
+     * @default 1
+     */
+    readonly defaultPage: _angular_core.InputSignalWithTransform<number, NumberInput>;
+    /**
+     * The event that is fired when the page changes.
+     */
+    readonly pageChange: _angular_core.OutputEmitterRef<number>;
+    /**
+     * The total number of pages.
+     */
+    readonly pageCount: _angular_core.InputSignalWithTransform<number, NumberInput>;
+    /**
+     * Whether the pagination is disabled.
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * The control state for the pagination.
+     * @internal
+     */
+    protected readonly state: {
+        page: _angular_core.WritableSignal<number>;
+        pageCount: _angular_core.Signal<number>;
+        pageChange: rxjs.Observable<number>;
+        disabled: _angular_core.Signal<boolean>;
+        firstPage: _angular_core.Signal<boolean>;
+        lastPage: _angular_core.Signal<boolean>;
+        goToPage: (page: number) => void;
+    };
+    /**
+     * Go to the specified page.
+     * @param page The page to go to.
+     */
+    goToPage(page: number): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPagination, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPagination, "[ngpPagination]", ["ngpPagination"], { "page": { "alias": "ngpPaginationPage"; "required": false; "isSignal": true; }; "defaultPage": { "alias": "ngpPaginationDefaultPage"; "required": false; "isSignal": true; }; "pageCount": { "alias": "ngpPaginationPageCount"; "required": false; "isSignal": true; }; "disabled": { "alias": "ngpPaginationDisabled"; "required": false; "isSignal": true; }; }, { "pageChange": "ngpPaginationPageChange"; }, never, never, true, never>;
+}
+
+interface NgpPaginationState {
+    /**
+     * The currently selected page.
+     */
+    readonly page: WritableSignal<number>;
+    /**
+     * The total number of pages.
+     */
+    readonly pageCount: Signal<number>;
+    /**
+     * Whether the pagination is disabled.
+     */
+    readonly disabled: Signal<boolean>;
+    /**
+     * Determine if we are on the first page.
+     * @internal
+     */
+    readonly firstPage: Signal<boolean>;
+    /**
+     * Determine if we are on the last page.
+     * @internal
+     */
+    readonly lastPage: Signal<boolean>;
+    /**
+     * The event that is fired when the page changes.
+     */
+    readonly pageChange: Observable<number>;
+    /**
+     * Go to the specified page.
+     * @param page The page to go to.
+     */
+    goToPage: (page: number) => void;
+}
+interface NgpPaginationProps {
+    /**
+     * The currently selected page. When `undefined`, the pagination is uncontrolled
+     * and seeds from `defaultPage`.
+     */
+    readonly page?: Signal<number | undefined>;
+    /**
+     * The default page for uncontrolled usage.
+     */
+    readonly defaultPage?: Signal<number>;
+    /**
+     * The total number of pages.
+     */
+    readonly pageCount?: Signal<number>;
+    /**
+     * Whether the pagination is disabled.
+     */
+    readonly disabled?: Signal<boolean>;
+    /** Callback fired when the page state changes. */
+    onPageChange: (page: number) => void;
+}
+declare const NgpPaginationStateToken: _angular_core.InjectionToken<WritableSignal<{
+    page: WritableSignal<number>;
+    pageCount: Signal<number>;
+    pageChange: Observable<number>;
+    disabled: Signal<boolean>;
+    firstPage: Signal<boolean>;
+    lastPage: Signal<boolean>;
+    goToPage: (page: number) => void;
+}>>;
+declare const ngpPagination: ({ page: _page, defaultPage: _defaultPage, pageCount: _pageCount, disabled: _disabled, onPageChange, }: NgpPaginationProps) => {
+    page: WritableSignal<number>;
+    pageCount: Signal<number>;
+    pageChange: Observable<number>;
+    disabled: Signal<boolean>;
+    firstPage: Signal<boolean>;
+    lastPage: Signal<boolean>;
+    goToPage: (page: number) => void;
+};
+declare const injectPaginationState: {
+    (): Signal<{
+        page: WritableSignal<number>;
+        pageCount: Signal<number>;
+        pageChange: Observable<number>;
+        disabled: Signal<boolean>;
+        firstPage: Signal<boolean>;
+        lastPage: Signal<boolean>;
+        goToPage: (page: number) => void;
+    }>;
+    (options: ng_primitives_state.StateInjectionOptions): Signal<{
+        page: WritableSignal<number>;
+        pageCount: Signal<number>;
+        pageChange: Observable<number>;
+        disabled: Signal<boolean>;
+        firstPage: Signal<boolean>;
+        lastPage: Signal<boolean>;
+        goToPage: (page: number) => void;
+    } | null>;
+    (options?: ng_primitives_state.StateInjectionOptions): Signal<{
+        page: WritableSignal<number>;
+        pageCount: Signal<number>;
+        pageChange: Observable<number>;
+        disabled: Signal<boolean>;
+        firstPage: Signal<boolean>;
+        lastPage: Signal<boolean>;
+        goToPage: (page: number) => void;
+    }> | Signal<{
+        page: WritableSignal<number>;
+        pageCount: Signal<number>;
+        pageChange: Observable<number>;
+        disabled: Signal<boolean>;
+        firstPage: Signal<boolean>;
+        lastPage: Signal<boolean>;
+        goToPage: (page: number) => void;
+    } | null>;
+};
+declare const providePaginationState: (opts?: {
+    inherit?: boolean;
+}) => _angular_core.FactoryProvider;
+
+interface NgpPaginationButtonState {
+    /**
+     * Define the page this button represents.
+     */
+    readonly page: Signal<number>;
+    /**
+     * Whether the button is disabled, accounting for the parent pagination state.
+     */
+    readonly disabled: Signal<boolean>;
+    /**
+     * Go to the page this button represents.
+     */
+    goToPage(): void;
+}
+interface NgpPaginationButtonProps {
+    /**
+     * Define the page this button represents.
+     */
+    readonly page?: Signal<number>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled?: Signal<boolean>;
+}
+declare const NgpPaginationButtonStateToken: _angular_core.InjectionToken<_angular_core.WritableSignal<{
+    page: Signal<number>;
+    disabled: Signal<boolean>;
+    goToPage: () => void;
+}>>;
+declare const ngpPaginationButton: ({ page, disabled: _disabled, }: NgpPaginationButtonProps) => {
+    page: Signal<number>;
+    disabled: Signal<boolean>;
+    goToPage: () => void;
+};
+declare const injectPaginationButtonState: {
+    (): Signal<{
+        page: Signal<number>;
+        disabled: Signal<boolean>;
+        goToPage: () => void;
+    }>;
+    (options: ng_primitives_state.StateInjectionOptions): Signal<{
+        page: Signal<number>;
+        disabled: Signal<boolean>;
+        goToPage: () => void;
+    } | null>;
+    (options?: ng_primitives_state.StateInjectionOptions): Signal<{
+        page: Signal<number>;
+        disabled: Signal<boolean>;
+        goToPage: () => void;
+    }> | Signal<{
+        page: Signal<number>;
+        disabled: Signal<boolean>;
+        goToPage: () => void;
+    } | null>;
+};
+declare const providePaginationButtonState: (opts?: {
+    inherit?: boolean;
+}) => _angular_core.FactoryProvider;
+
+interface NgpPaginationFirstState {
+    /**
+     * Whether the button is disabled, accounting for the parent pagination state.
+     */
+    readonly disabled: Signal<boolean>;
+    /**
+     * Go to the first page.
+     */
+    goToFirstPage(): void;
+}
+interface NgpPaginationFirstProps {
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled?: Signal<boolean>;
+}
+declare const NgpPaginationFirstStateToken: _angular_core.InjectionToken<_angular_core.WritableSignal<{
+    disabled: Signal<boolean>;
+    goToFirstPage: () => void;
+}>>;
+declare const ngpPaginationFirst: ({ disabled: _disabled }: NgpPaginationFirstProps) => {
+    disabled: Signal<boolean>;
+    goToFirstPage: () => void;
+};
+declare const injectPaginationFirstState: {
+    (): Signal<{
+        disabled: Signal<boolean>;
+        goToFirstPage: () => void;
+    }>;
+    (options: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToFirstPage: () => void;
+    } | null>;
+    (options?: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToFirstPage: () => void;
+    }> | Signal<{
+        disabled: Signal<boolean>;
+        goToFirstPage: () => void;
+    } | null>;
+};
+declare const providePaginationFirstState: (opts?: {
+    inherit?: boolean;
+}) => _angular_core.FactoryProvider;
+
+interface NgpPaginationLastState {
+    /** Whether the button is disabled, accounting for the parent pagination state. */
+    readonly disabled: Signal<boolean>;
+    /** Go to the last page. */
+    goToLastPage(): void;
+}
+interface NgpPaginationLastProps {
+    /** Whether the button is disabled. */
+    readonly disabled?: Signal<boolean>;
+}
+declare const NgpPaginationLastStateToken: _angular_core.InjectionToken<_angular_core.WritableSignal<{
+    disabled: Signal<boolean>;
+    goToLastPage: () => void;
+}>>;
+declare const ngpPaginationLast: ({ disabled: _disabled }: NgpPaginationLastProps) => {
+    disabled: Signal<boolean>;
+    goToLastPage: () => void;
+};
+declare const injectPaginationLastState: {
+    (): Signal<{
+        disabled: Signal<boolean>;
+        goToLastPage: () => void;
+    }>;
+    (options: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToLastPage: () => void;
+    } | null>;
+    (options?: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToLastPage: () => void;
+    }> | Signal<{
+        disabled: Signal<boolean>;
+        goToLastPage: () => void;
+    } | null>;
+};
+declare const providePaginationLastState: (opts?: {
+    inherit?: boolean;
+}) => _angular_core.FactoryProvider;
+
+interface NgpPaginationNextState {
+    /** Whether the button is disabled, accounting for the parent pagination state. */
+    readonly disabled: Signal<boolean>;
+    /** Go to the next page. */
+    goToNextPage(): void;
+}
+interface NgpPaginationNextProps {
+    /** Whether the button is disabled */
+    readonly disabled?: Signal<boolean>;
+}
+declare const NgpPaginationNextStateToken: _angular_core.InjectionToken<_angular_core.WritableSignal<{
+    disabled: Signal<boolean>;
+    goToNextPage: () => void;
+}>>;
+declare const ngpPaginationNext: ({ disabled: _disabled }: NgpPaginationNextProps) => {
+    disabled: Signal<boolean>;
+    goToNextPage: () => void;
+};
+declare const injectPaginationNextState: {
+    (): Signal<{
+        disabled: Signal<boolean>;
+        goToNextPage: () => void;
+    }>;
+    (options: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToNextPage: () => void;
+    } | null>;
+    (options?: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToNextPage: () => void;
+    }> | Signal<{
+        disabled: Signal<boolean>;
+        goToNextPage: () => void;
+    } | null>;
+};
+declare const providePaginationNextState: (opts?: {
+    inherit?: boolean;
+}) => _angular_core.FactoryProvider;
+
+interface NgpPaginationPreviousState {
+    /**
+     * Whether the button is disabled, accounting for the parent pagination state.
+     */
+    readonly disabled: Signal<boolean>;
+    /**
+     * Go to the previous page.
+     */
+    goToPreviousPage(): void;
+}
+interface NgpPaginationPreviousProps {
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled?: Signal<boolean>;
+}
+declare const NgpPaginationPreviousStateToken: _angular_core.InjectionToken<_angular_core.WritableSignal<{
+    disabled: Signal<boolean>;
+    goToPreviousPage: () => void;
+}>>;
+declare const ngpPaginationPrevious: ({ disabled: _disabled }: NgpPaginationPreviousProps) => {
+    disabled: Signal<boolean>;
+    goToPreviousPage: () => void;
+};
+declare const injectPaginationPreviousState: {
+    (): Signal<{
+        disabled: Signal<boolean>;
+        goToPreviousPage: () => void;
+    }>;
+    (options: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToPreviousPage: () => void;
+    } | null>;
+    (options?: ng_primitives_state.StateInjectionOptions): Signal<{
+        disabled: Signal<boolean>;
+        goToPreviousPage: () => void;
+    }> | Signal<{
+        disabled: Signal<boolean>;
+        goToPreviousPage: () => void;
+    } | null>;
+};
+declare const providePaginationPreviousState: (opts?: {
+    inherit?: boolean;
+}) => _angular_core.FactoryProvider;
+
+export { NgpPagination, NgpPaginationButton, NgpPaginationButtonStateToken, NgpPaginationFirst, NgpPaginationFirstStateToken, NgpPaginationLast, NgpPaginationLastStateToken, NgpPaginationNext, NgpPaginationNextStateToken, NgpPaginationPrevious, NgpPaginationPreviousStateToken, NgpPaginationStateToken, injectPaginationButtonState, injectPaginationFirstState, injectPaginationLastState, injectPaginationNextState, injectPaginationPreviousState, injectPaginationState, ngpPagination, ngpPaginationButton, ngpPaginationFirst, ngpPaginationLast, ngpPaginationNext, ngpPaginationPrevious, providePaginationButtonState, providePaginationFirstState, providePaginationLastState, providePaginationNextState, providePaginationPreviousState, providePaginationState };
+export type { NgpPaginationButtonProps, NgpPaginationButtonState, NgpPaginationFirstProps, NgpPaginationFirstState, NgpPaginationLastProps, NgpPaginationLastState, NgpPaginationNextProps, NgpPaginationNextState, NgpPaginationPreviousProps, NgpPaginationPreviousState, NgpPaginationProps, NgpPaginationState };