govbr-ds-angular/lib/components/paginator/paginator.component.d.ts

Implementação em Angular do Design System GovBR.

import { EventEmitter, OnChanges } from '@angular/core';
import * as i0 from "@angular/core";
/**
 * Representa um evento de página.
 */
export type PageEvent = {
    /** Comprimento total dos itens. */
    length: number;
    /** Índice da página atual. */
    pageIndex: number;
    /** Tamanho da página. */
    pageSize: number;
    /** Índice da página anterior. */
    previousPageIndex: number;
};
/**
 * Componente PaginatorComponent é responsável por exibir um paginador com várias opções de configuração.
 * Implementa a interface OnChanges para detectar mudanças nas entradas.
 * @example
 * <app-paginator [length]="100" [pageSize]="10" (page)="onPageChange($event)"></app-paginator>
 *
 * @public
 * {@link https://www.gov.br/ds/components/pagination?tab=desenvolvedor|Documentação oficial}
 */
export declare class PaginatorComponent implements OnChanges {
    /**
     * Comprimento total dos itens.
     * @type {number}
     * @required
     */
    length: number;
    /**
     * Tamanho da página.
     * @type {number}
     */
    pageSize: number;
    private _pageIndex;
    /**
     * Obtém o índice da página atual.
     * @type {number}
     */
    get pageIndex(): number;
    /**
     * Define o índice da página atual.
     * @type {number}
     */
    set pageIndex(value: number);
    /**
     * Opções de tamanho da página.
     * @type {number[]}
     */
    pageSizeOptions: number[];
    /**
     * Indica se os botões de primeira e última página devem ser exibidos.
     * @type {boolean}
     */
    showFirstLastButtons: boolean;
    /**
     * Evento emitido quando a página muda.
     * @type {EventEmitter<PageEvent>}
     */
    page: EventEmitter<PageEvent>;
    expandedOptions: boolean;
    totalPages: number;
    pageIndexOptions: number[];
    previousPageIndex: number;
    readonly uuid: string;
    private brPaginator;
    /**
     * Método do ciclo de vida do Angular chamado quando as entradas mudam.
     * Calcula o número total de páginas.
     * @internal
     */
    ngOnChanges(): void;
    /**
     * Navega para a página anterior.
     * @internal
     */
    prevPage(): void;
    /**
     * Navega para a próxima página.
     * @internal
     */
    nextPage(): void;
    /**
     * Calcula o número total de páginas e atualiza as opções de índice de página.
     * @internal
     */
    private calculatePages;
    /**
     * Alterna a exibição das opções de tamanho da página.
     * @param element - O elemento HTML que contém as opções de tamanho.
     * @example
     * this.toggleSizeOptions(element);
     */
    toggleSizeOptions(element: HTMLDivElement): void;
    /**
     * Fecha as opções de tamanho da página.
     * @param id - O ID do elemento HTML que contém as opções de tamanho.
     * @example
     * this.closeSizeOptions('list-options-size');
     */
    closeSizeOptions(id: string): void;
    /**
     * Define o tamanho da página.
     * @param option - O tamanho da página a ser definido.
     * @example
     * this.setPageSize(20);
     */
    setPageSize(option: number): void;
    /**
     * Define o índice da página.
     * @param pageIndex - O índice da página a ser definido.
     * @example
     * this.setPageIndex(2);
     */
    setPageIndex(pageIndex: number): void;
    /**
     * Emite o evento de mudança de página.
     * @example
     * this.emitPageEvent();
     */
    emitPageEvent(): void;
    /**
     * Fecha todas as opções de tamanho e índice de página.
     * @example
     * this.closeAll();
     */
    closeAll(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<PaginatorComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PaginatorComponent, "app-paginator", never, { "length": { "alias": "length"; "required": true; }; "pageSize": { "alias": "pageSize"; "required": false; }; "pageIndex": { "alias": "pageIndex"; "required": false; }; "pageSizeOptions": { "alias": "pageSizeOptions"; "required": false; }; "showFirstLastButtons": { "alias": "showFirstLastButtons"; "required": false; }; }, { "page": "page"; }, never, never, true, never>;
    static ngAcceptInputType_length: unknown;
    static ngAcceptInputType_pageSize: unknown;
    static ngAcceptInputType_pageIndex: unknown;
    static ngAcceptInputType_showFirstLastButtons: unknown;
}