ng-primitives 0.88.0 → 0.90.0

package/pagination/index.d.ts

@@ -1,7 +1,211 @@
-export { NgpPaginationButton } from './pagination-button/pagination-button';
-export { NgpPaginationFirst } from './pagination-first/pagination-first';
-export { NgpPaginationLast } from './pagination-last/pagination-last';
-export { NgpPaginationNext } from './pagination-next/pagination-next';
-export { NgpPaginationPrevious } from './pagination-previous/pagination-previous';
-export { NgpPagination } from './pagination/pagination';
-export { injectPaginationState, providePaginationState } from './pagination/pagination-state';
+import * as _angular_core from '@angular/core';
+import * as ng_primitives_state from 'ng-primitives/state';
+import * as ng_primitives_pagination from 'ng-primitives/pagination';
+import { NumberInput, BooleanInput } from '@angular/cdk/coercion';
+
+/**
+ * The `NgpPaginationButton` directive is used to create a pagination button.
+ */
+declare class NgpPaginationButton {
+    /**
+     * Access the pagination state.
+     */
+    protected readonly paginationState: _angular_core.Signal<ng_primitives_state.State<ng_primitives_pagination.NgpPagination>>;
+    /**
+     * Define the page this button represents.
+     */
+    readonly page: _angular_core.InputSignalWithTransform<number, NumberInput>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly buttonDisabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.Signal<boolean>;
+    /**
+     * Whether this page is the currently selected page.
+     */
+    protected readonly selected: _angular_core.Signal<boolean>;
+    constructor();
+    /**
+     * Go to the page this button represents.
+     */
+    goToPage(): void;
+    /**
+     * A click event may not be fired if this is on an anchor tag and the href is empty.
+     * This is a workaround to ensure the click event is fired.
+     */
+    protected onEnter(event: KeyboardEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationButton, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationButton, "[ngpPaginationButton]", ["ngpPaginationButton"], { "page": { "alias": "ngpPaginationButtonPage"; "required": true; "isSignal": true; }; "buttonDisabled": { "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 {
+    /**
+     * Access the pagination state.
+     */
+    protected readonly paginationState: _angular_core.Signal<ng_primitives_state.State<ng_primitives_pagination.NgpPagination>>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly buttonDisabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    readonly disabled: _angular_core.Signal<boolean>;
+    constructor();
+    /**
+     * Go to the first page.
+     */
+    goToFirstPage(): void;
+    /**
+     * A click event may not be fired if this is on an anchor tag and the href is empty.
+     * This is a workaround to ensure the click event is fired.
+     */
+    protected onEnter(event: KeyboardEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationFirst, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationFirst, "[ngpPaginationFirst]", ["ngpPaginationFirst"], { "buttonDisabled": { "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 {
+    /**
+     * Access the pagination state.
+     */
+    private readonly paginationState;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly buttonDisabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    readonly disabled: _angular_core.Signal<boolean>;
+    constructor();
+    /**
+     * Go to the last page.
+     */
+    goToLastPage(): void;
+    /**
+     * A click event may not be fired if this is on an anchor tag and the href is empty.
+     * This is a workaround to ensure the click event is fired.
+     */
+    protected onEnter(event: KeyboardEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationLast, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationLast, "[ngpPaginationLast]", ["ngpPaginationLast"], { "buttonDisabled": { "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 {
+    /**
+     * Access the pagination state.
+     */
+    protected readonly paginationState: _angular_core.Signal<ng_primitives_state.State<ng_primitives_pagination.NgpPagination>>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly buttonDisabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.Signal<boolean>;
+    constructor();
+    /**
+     * Go to the next page.
+     */
+    goToNextPage(): void;
+    /**
+     * A click event may not be fired if this is on an anchor tag and the href is empty.
+     * This is a workaround to ensure the click event is fired.
+     */
+    protected onEnter(event: KeyboardEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationNext, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationNext, "[ngpPaginationNext]", ["ngpPaginationNext"], { "buttonDisabled": { "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 {
+    /**
+     * Access the pagination state.
+     */
+    protected readonly paginationState: _angular_core.Signal<ng_primitives_state.State<ng_primitives_pagination.NgpPagination>>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly buttonDisabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * Whether the button is disabled.
+     */
+    readonly disabled: _angular_core.Signal<boolean>;
+    constructor();
+    /**
+     * Go to the previous page.
+     */
+    goToPreviousPage(): void;
+    /**
+     * A click event may not be fired if this is on an anchor tag and the href is empty.
+     * This is a workaround to ensure the click event is fired.
+     */
+    protected onEnter(event: KeyboardEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPaginationPrevious, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPaginationPrevious, "[ngpPaginationPrevious]", ["ngpPaginationPrevious"], { "buttonDisabled": { "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.
+     */
+    readonly page: _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>;
+    /**
+     * Determine if we are on the first page.
+     * @internal
+     */
+    readonly firstPage: _angular_core.Signal<boolean>;
+    /**
+     * Determine if we are on the last page.
+     * @internal
+     */
+    readonly lastPage: _angular_core.Signal<boolean>;
+    /**
+     * The control state for the pagination.
+     * @internal
+     */
+    private readonly state;
+    /**
+     * 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; }; "pageCount": { "alias": "ngpPaginationPageCount"; "required": false; "isSignal": true; }; "disabled": { "alias": "ngpPaginationDisabled"; "required": false; "isSignal": true; }; }, { "pageChange": "ngpPaginationPageChange"; }, never, never, true, never>;
+}
+
+/**
+ * Provides the Pagination state.
+ */
+declare const providePaginationState: (options?: ng_primitives_state.CreateStateProviderOptions) => _angular_core.FactoryProvider;
+/**
+ * Injects the Pagination state.
+ */
+declare const injectPaginationState: <U = NgpPagination>(injectOptions?: _angular_core.InjectOptions) => _angular_core.Signal<ng_primitives_state.State<U>>;
+
+export { NgpPagination, NgpPaginationButton, NgpPaginationFirst, NgpPaginationLast, NgpPaginationNext, NgpPaginationPrevious, injectPaginationState, providePaginationState };

package/popover/index.d.ts

@@ -1,6 +1,225 @@
+import * as ng_primitives_portal from 'ng-primitives/portal';
+import { NgpOffset, NgpOverlayContent, NgpOffsetInput, NgpOverlay } from 'ng-primitives/portal';
 export { injectOverlayContext as injectPopoverContext } from 'ng-primitives/portal';
-export { NgpPopoverConfig, providePopoverConfig } from './config/popover-config';
-export { NgpPopoverArrow } from './popover-arrow/popover-arrow';
-export { NgpPopoverTrigger, type NgpPopoverPlacement } from './popover-trigger/popover-trigger';
-export { injectPopoverTriggerState, providePopoverTriggerState, } from './popover-trigger/popover-trigger-state';
-export { NgpPopover } from './popover/popover';
+import * as _angular_core from '@angular/core';
+import { Provider, OnDestroy, InjectOptions, Signal } from '@angular/core';
+import { Placement } from '@floating-ui/dom';
+import * as ng_primitives_state from 'ng-primitives/state';
+import { State } from 'ng-primitives/state';
+import { FocusOrigin } from '@angular/cdk/a11y';
+import { BooleanInput, NumberInput } from '@angular/cdk/coercion';
+import * as i1 from 'ng-primitives/focus-trap';
+
+interface NgpPopoverConfig {
+    /**
+     * Define the offset of the popover relative to the trigger.
+     * Can be a number (applies to mainAxis) or an object with mainAxis, crossAxis, and alignmentAxis.
+     * @default 4
+     */
+    offset: NgpOffset;
+    /**
+     * Define the placement of the popover relative to the trigger.
+     * @default 'bottom'
+     */
+    placement: Placement;
+    /**
+     * Define the delay before the popover is shown.
+     * @default 0
+     */
+    showDelay: number;
+    /**
+     * Define the delay before the popover is hidden.
+     * @default 0
+     */
+    hideDelay: number;
+    /**
+     * Define whether the popover should flip when there is not enough space for the popover.
+     * @default true
+     */
+    flip: boolean;
+    /**
+     * Define the container element or selector in to which the popover should be attached.
+     * @default 'body'
+     */
+    container: HTMLElement | string | null;
+    /**
+     * Define whether the popover should close when clicking outside of it.
+     * @default true
+     */
+    closeOnOutsideClick: boolean;
+    /**
+     * Define whether the popover should close when the escape key is pressed.
+     * @default true
+     */
+    closeOnEscape: boolean;
+    /**
+     * Defines how the popover behaves when the window is scrolled.
+     * @default scroll
+     */
+    scrollBehavior: 'reposition' | 'block';
+}
+/**
+ * Provide the default Popover configuration
+ * @param config The Popover configuration
+ * @returns The provider
+ */
+declare function providePopoverConfig(config: Partial<NgpPopoverConfig>): Provider[];
+
+declare class NgpPopoverArrow {
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPopoverArrow, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPopoverArrow, "[ngpPopoverArrow]", ["ngpPopoverArrow"], {}, {}, never, never, true, never>;
+}
+
+/**
+ * Apply the `ngpPopoverTrigger` directive to an element that triggers the popover to show.
+ */
+declare class NgpPopoverTrigger<T = null> implements OnDestroy {
+    /**
+     * Access the trigger element
+     */
+    private readonly trigger;
+    /**
+     * Access the injector.
+     */
+    private readonly injector;
+    /**
+     * Access the view container reference.
+     */
+    private readonly viewContainerRef;
+    /**
+     * Access the global popover configuration.
+     */
+    private readonly config;
+    /**
+     * Access the popover template ref.
+     */
+    readonly popover: _angular_core.InputSignal<NgpOverlayContent<T> | undefined>;
+    /**
+     * Define if the trigger should be disabled.
+     * @default false
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * Define the placement of the popover relative to the trigger.
+     * @default 'top'
+     */
+    readonly placement: _angular_core.InputSignal<NgpPopoverPlacement>;
+    /**
+     * Define the offset of the popover relative to the trigger.
+     * Can be a number (applies to mainAxis) or an object with mainAxis, crossAxis, and alignmentAxis.
+     * @default 0
+     */
+    readonly offset: _angular_core.InputSignalWithTransform<NgpOffset, NgpOffsetInput>;
+    /**
+     * Define the delay before the popover is displayed.
+     * @default 0
+     */
+    readonly showDelay: _angular_core.InputSignalWithTransform<number, NumberInput>;
+    /**
+     * Define the delay before the popover is hidden.
+     * @default 0
+     */
+    readonly hideDelay: _angular_core.InputSignalWithTransform<number, NumberInput>;
+    /**
+     * Define whether the popover should flip when there is not enough space for the popover.
+     * @default true
+     */
+    readonly flip: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * Define the container in which the popover should be attached.
+     * @default document.body
+     */
+    readonly container: _angular_core.InputSignal<string | HTMLElement | null>;
+    /**
+     * Define whether the popover should close when clicking outside of it.
+     * @default true
+     */
+    readonly closeOnOutsideClick: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * Define whether the popover should close when the escape key is pressed.
+     * @default true
+     */
+    readonly closeOnEscape: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    /**
+     * Defines how the popover behaves when the window is scrolled.
+     * @default 'reposition'
+     */
+    readonly scrollBehavior: _angular_core.InputSignal<"reposition" | "block">;
+    /**
+     * Provide context to the popover. This can be used to pass data to the popover content.
+     */
+    readonly context: _angular_core.InputSignal<T | undefined>;
+    /**
+     * Define an anchor element for positioning the popover.
+     * If provided, the popover will be positioned relative to this element instead of the trigger.
+     */
+    readonly anchor: _angular_core.InputSignal<HTMLElement | null>;
+    /**
+     * The overlay that manages the popover
+     * @internal
+     */
+    readonly overlay: _angular_core.WritableSignal<NgpOverlay<T> | null>;
+    /**
+     * The open state of the popover.
+     * @internal
+     */
+    readonly open: _angular_core.Signal<boolean>;
+    /**
+     * Event emitted when the popover open state changes.
+     */
+    readonly openChange: _angular_core.OutputEmitterRef<boolean>;
+    /**
+     * The popover trigger state.
+     */
+    readonly state: ng_primitives_state.CreatedState<NgpPopoverTrigger<T>>;
+    ngOnDestroy(): void;
+    protected toggle(event: MouseEvent): void;
+    /**
+     * Show the popover.
+     * @returns A promise that resolves when the popover has been shown
+     */
+    show(): Promise<void>;
+    /**
+     * @internal
+     * Hide the popover.
+     * @returns A promise that resolves when the popover has been hidden
+     */
+    hide(origin?: FocusOrigin): Promise<void>;
+    /**
+     * Create the overlay that will contain the popover
+     */
+    private createOverlay;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPopoverTrigger<any>, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPopoverTrigger<any>, "[ngpPopoverTrigger]", ["ngpPopoverTrigger"], { "popover": { "alias": "ngpPopoverTrigger"; "required": false; "isSignal": true; }; "disabled": { "alias": "ngpPopoverTriggerDisabled"; "required": false; "isSignal": true; }; "placement": { "alias": "ngpPopoverTriggerPlacement"; "required": false; "isSignal": true; }; "offset": { "alias": "ngpPopoverTriggerOffset"; "required": false; "isSignal": true; }; "showDelay": { "alias": "ngpPopoverTriggerShowDelay"; "required": false; "isSignal": true; }; "hideDelay": { "alias": "ngpPopoverTriggerHideDelay"; "required": false; "isSignal": true; }; "flip": { "alias": "ngpPopoverTriggerFlip"; "required": false; "isSignal": true; }; "container": { "alias": "ngpPopoverTriggerContainer"; "required": false; "isSignal": true; }; "closeOnOutsideClick": { "alias": "ngpPopoverTriggerCloseOnOutsideClick"; "required": false; "isSignal": true; }; "closeOnEscape": { "alias": "ngpPopoverTriggerCloseOnEscape"; "required": false; "isSignal": true; }; "scrollBehavior": { "alias": "ngpPopoverTriggerScrollBehavior"; "required": false; "isSignal": true; }; "context": { "alias": "ngpPopoverTriggerContext"; "required": false; "isSignal": true; }; "anchor": { "alias": "ngpPopoverTriggerAnchor"; "required": false; "isSignal": true; }; }, { "openChange": "ngpPopoverTriggerOpenChange"; }, never, never, true, never>;
+}
+type NgpPopoverPlacement = 'top' | 'right' | 'bottom' | 'left' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end';
+
+/**
+ * Provides the PopoverTrigger state.
+ */
+declare const providePopoverTriggerState: (options?: ng_primitives_state.CreateStateProviderOptions) => _angular_core.FactoryProvider;
+/**
+ * Injects the PopoverTrigger state.
+ */
+declare const injectPopoverTriggerState: <T>(options?: InjectOptions) => Signal<State<NgpPopoverTrigger<T>>>;
+
+/**
+ * Apply the `ngpPopover` directive to an element that represents the popover. This typically would be a `div` inside an `ng-template`.
+ */
+declare class NgpPopover {
+    /**
+     * Access the overlay.
+     */
+    protected readonly overlay: ng_primitives_portal.NgpOverlay<unknown>;
+    /**
+     * The unique id of the tooltip.
+     */
+    readonly id: _angular_core.InputSignal<string>;
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpPopover, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpPopover, "[ngpPopover]", ["ngpPopover"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; }, {}, never, never, true, [{ directive: typeof i1.NgpFocusTrap; inputs: {}; outputs: {}; }]>;
+}
+
+export { NgpPopover, NgpPopoverArrow, NgpPopoverTrigger, injectPopoverTriggerState, providePopoverConfig, providePopoverTriggerState };
+export type { NgpPopoverConfig, NgpPopoverPlacement };