@seniorsistemas/angular-components 19.0.5 → 19.0.7

package/text-area/lib/text-area/text-area.component.d.ts

@@ -2,6 +2,23 @@ import { ChangeDetectorRef, ElementRef } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
 import { KeyFilterPattern } from 'primeng/keyfilter';
 import * as i0 from "@angular/core";
+/**
+ * @description Componente de área de texto com suporte a reconhecimento de voz,
+ * filtro de teclas, comprimento máximo e integração com `ControlValueAccessor`.
+ * Renderiza condicionalmente o componente `SpeechRecognitionComponent` quando
+ * a flag `speechRecognition` está ativa.
+ *
+ * @example
+ * ```html
+ * <s-textarea
+ *   formControlName="descricao"
+ *   [rows]="6"
+ *   [maxLength]="500"
+ *   placeholder="Digite aqui..." />
+ * ```
+ *
+ * @category Inputs
+ */
 export declare class TextAreaComponent implements ControlValueAccessor {
     private readonly cdr;
     onChange: (value: string) => void;
@@ -11,17 +28,27 @@ export declare class TextAreaComponent implements ControlValueAccessor {
     private _textAreaElement;
     get textAreaElement(): ElementRef<HTMLTextAreaElement>;
     set textAreaElement(value: ElementRef<HTMLTextAreaElement>);
+    /** @description Identificador do elemento `<textarea>` no DOM. @default 'textarea-{random}' */
     inputId: string;
+    /** @description Número de linhas visíveis no textarea. @default 5 */
     rows: number;
+    /** @description Habilita o botão de reconhecimento de voz. @default false */
     speechRecognition: boolean;
+    /** @description Filtro de teclas aceitas, usando padrão ou expressão regular. */
     keyFilter: RegExp | KeyFilterPattern | null | undefined;
+    /** @description Quando `true`, mantém o contexto ao reiniciar o reconhecimento de voz. @default false */
     keepContext: boolean;
+    /** @description Placeholder exibido durante o reconhecimento de voz. @default '' */
     speechRecognitionPlaceholder: string;
+    /** @description Número máximo de caracteres aceitos. @default null (ilimitado) */
     maxLength: number | null;
+    /** @description Texto exibido quando o campo está vazio. */
     placeholder: string | undefined;
     private _inputStyle;
+    /** @description Estilos inline aplicados ao elemento `<textarea>` interno. @default `{ resize: 'vertical' }` */
     get inputStyle(): Partial<CSSStyleDeclaration>;
     set inputStyle(value: Partial<CSSStyleDeclaration>);
+    /** @description Coloca o textarea em modo somente leitura. @default false */
     readOnly: boolean;
     renderTextArea: boolean;
     constructor(cdr: ChangeDetectorRef);

package/thumbnail/lib/thumbnail/thumbnail.component.d.ts

@@ -2,21 +2,45 @@ import { AfterViewInit, ElementRef, OnDestroy } from '@angular/core';
 import { ThumbnailSize } from './thumbnail-size';
 import { ThumbnailService } from './thumbnail.service';
 import * as i0 from "@angular/core";
+/**
+ * @description Componente de miniatura de imagem com suporte a imagem de fallback,
+ * ícone de ação sobrepôsto, orientação automática e diferentes tamanhos predefinidos.
+ *
+ * @example
+ * ```html
+ * <s-thumbnail
+ *   [imageSource]="urlDaImagem"
+ *   size="large"
+ *   iconClass="fas fa-user" />
+ * ```
+ *
+ * @category Data
+ */
 export declare class ThumbnailComponent implements AfterViewInit, OnDestroy {
     private readonly thumbnailService;
     static nextId: number;
     fallback: boolean;
     orientation: number;
     imgEl: ElementRef | null;
+    /** @description Identificador único do componente no DOM. Gerado automaticamente se não informado. */
     id: string;
+    /** @description Tamanho da miniatura: `'small'`, `'medium'`, `'large'`, etc. @default 'medium' */
     size: ThumbnailSize;
+    /** @description URL da imagem principal. */
     imageSource?: string;
+    /** @description URL da imagem de fallback exibida quando a principal falha ao carregar. */
     imageFallback?: string;
+    /** @description Texto alternativo (atributo `alt`) da imagem. */
     imageAlt?: string;
+    /** @description Classe do ícone exibido quando não há imagem disponível. @default 'far fa-image' */
     iconClass: string;
+    /** @description Habilita a exibição de um botão de ação sobrepôsto. @default false */
     hasAction: boolean;
+    /** @description Classe do ícone do botão de ação. @default 'fas fa-camera' */
     actionIconClass: string;
+    /** @description Aplica estilo de tile ao thumbnail. @default false */
     isTile: boolean;
+    /** @description Aplica estilo de marca ao thumbnail. @default false */
     isBrand: boolean;
     private ngUnsubscribe;
     constructor(thumbnailService: ThumbnailService);

package/thumbnails/lib/thumbnails/thumbnails.component.d.ts

@@ -1,12 +1,37 @@
-import { EventEmitter } from "@angular/core";
-import { ThumbnailsItem } from "./models/thumbnails-item";
+import { EventEmitter } from '@angular/core';
+import { ThumbnailsItem } from './models/thumbnails-item';
 import * as i0 from "@angular/core";
+/**
+ * @description Componente de galeria de miniaturas com suporte a seleção múltipla
+ * e abertura de itens. Gerencia o estado de seleção internamente e emite eventos
+ * para o componente pai.
+ *
+ * @example
+ * ```html
+ * <s-thumbnails
+ *   [items]="miniaturas"
+ *   [selectable]="true"
+ *   [(selection)]="itensSelecionados"
+ *   (itemOpened)="onItemAberto($event)" />
+ * ```
+ *
+ * @category Data
+ */
 export declare class ThumbnailsComponent {
+    /** @description Lista de itens exibidos na galeria. @default [] */
     items: ThumbnailsItem[];
+    /** @description Habilita a seleção de itens. @default true */
     selectable: boolean;
+    /** @description Quando `true`, combina o evento de checkbox com o de seleção. @default true */
     combineCheckboxEvent: boolean;
+    /**
+     * @description Lista de itens atualmente selecionados. Suporta two-way binding.
+     * @default []
+     */
     set selection(items: ThumbnailsItem[]);
+    /** @description Emitido quando a seleção de itens muda. */
     selectionChange: EventEmitter<ThumbnailsItem[]>;
+    /** @description Emitido quando o usuário abre um item (clique duplo ou ação de abrir). */
     itemOpened: EventEmitter<ThumbnailsItem>;
     private _selection;
     onItemOpened(item: ThumbnailsItem): void;

package/tiered-menu/lib/tiered-menu/tiered-menu.directive.d.ts

@@ -4,6 +4,19 @@ import { TieredMenuEventService } from './services/tiered-menu.event.service';
 import { TieredMenuGlobalService } from './services/tiered-menu.global.service';
 import { TieredMenuService } from './services/tiered-menu.service';
 import * as i0 from "@angular/core";
+/**
+ * @description Diretiva que anexa um menu multinível (tiered menu) a qualquer elemento do DOM.
+ * Ao disparar o evento configurado no elemento hospedeiro, exibe um painel flutuante
+ * com itens de menu hierárquicos, suportando submenus aninhados e divisores.
+ * Em telas estreitas (< 600px), o menu é exibido em modo aninhado fullscreen.
+ *
+ * @example
+ * ```html
+ * <s-button [sTieredMenu]="menuItems" triggerEvent="click">Abrir menu</s-button>
+ * ```
+ *
+ * @category Navegação
+ */
 export declare class TieredMenuDirective implements OnInit, OnChanges, OnDestroy {
     private readonly _elementRef;
     private readonly _appRef;
@@ -13,8 +26,24 @@ export declare class TieredMenuDirective implements OnInit, OnChanges, OnDestroy
     private readonly _tieredMenuService;
     private readonly _tieredMenuGlobalService;
     private readonly _changeDetectorRef;
+    /**
+     * @description Lista de itens exibidos no menu. Cada item pode conter um array de `children`
+     * para criar submenus aninhados, além de propriedades como `label`, `icon`,
+     * `disabled`, `command` e `divider`.
+     */
     items: TieredMenuItemData[];
+    /**
+     * @description Item que receberá o foco inicial ao abrir o menu.
+     * Útil para destacar uma opção pré-selecionada ou contextual.
+     */
     focusedItem: TieredMenuItemData | undefined;
+    /**
+     * @description Define o evento do elemento hospedeiro que dispara a abertura do menu.
+     * - `'click'`: abre o menu ao clicar no elemento (padrão).
+     * - `'hover'`: abre o menu ao passar o mouse sobre o elemento.
+     *
+     * @default 'click'
+     */
     triggerEvent: 'click' | 'hover';
     ariaLabel?: string;
     private _componentRef;

package/tile/lib/tile/tile.component.d.ts

@@ -1,16 +1,41 @@
 import { EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * @description Card clicável que representa uma opção ou destino de navegação,
+ * exibindo ícone (por classe ou imagem), rótulo e descrição opcional.
+ * Suporta navegação por teclado e exibe as iniciais do rótulo como fallback.
+ *
+ * @example
+ * ```html
+ * <s-tile
+ *   label="Relatórios"
+ *   iconClass="fas fa-chart-bar"
+ *   (clicked)="onTileClicado()" />
+ * ```
+ *
+ * @category Summary
+ */
 export declare class TileComponent {
     static nextId: number;
+    /** @description Identificador único do elemento no DOM. Gerado automaticamente se não informado. */
     id: string;
+    /** @description Rótulo principal exibido no tile. Campo obrigatório. */
     label: string;
+    /** @description Texto descritivo exibido abaixo do rótulo. */
     description?: string;
+    /** @description Classe do ícone exibido no tile (ex.: `'fas fa-home'`). */
     iconClass?: string;
+    /** @description URL da imagem exibida no tile. */
     imageSource?: string;
+    /** @description Texto alternativo para a imagem (`alt`). */
     imageAlt?: string;
+    /** @description Desabilita o tile, removendo interações e aplicando estilo desativado. @default false */
     disabled: boolean;
+    /** @description `tabindex` do tile para navegação por teclado. @default 0 */
     tabIndex: number;
+    /** @description Exibe o thumbnail (miniatura) no tile. @default true */
     thumbnail: boolean;
+    /** @description Emitido quando o usuário clica ou pressiona Enter/Espaço no tile. */
     clicked: EventEmitter<any>;
     get initialLetter(): string;
     onKeyDown(event: any): void;

package/timeline/lib/timeline/timeline.component.d.ts

@@ -3,15 +3,39 @@ import { TimelineItem } from './models/timeline-item';
 import * as i0 from "@angular/core";
 declare const HORIZONTAL = "horizontal";
 declare const VERTICAL = "vertical";
+/**
+ * @description Componente de linha do tempo que renderiza itens de forma horizontal
+ * ou vertical (ou autodetectável por largura de tela). Suporta navegação entre
+ * etapas, destaque do item ativo e modo colapsável para muitos itens.
+ *
+ * @example
+ * ```html
+ * <s-timeline
+ *   [items]="etapas"
+ *   [activeIndex]="etapaAtiva"
+ *   direction="horizontal" />
+ * ```
+ *
+ * @category Structure
+ */
 export declare class TimelineComponent implements OnInit {
     private _innerWidth;
     private _items;
     get items(): TimelineItem[];
+    /**
+     * @description Lista de itens da linha do tempo. Campo obrigatório.
+     * IDs duplicados são rejeitados com exceção.
+     */
     set items(items: TimelineItem[]);
+    /** @description Índice ativo (0-based) que define o item em destaque. Campo obrigatório. */
     activeIndex: number;
+    /** @description Aplica destaque visual ao item ativo. @default true */
     highlightActiveItem: boolean;
+    /** @description Direção de renderização: `'horizontal'` ou `'vertical'`. @default 'horizontal' */
     direction: typeof HORIZONTAL | typeof VERTICAL;
+    /** @description Habilita o modo colapsável quando há muitos itens. @default true */
     collapsable: boolean;
+    /** @description Rótulo exibido no contador de itens colapsados. @default 'items' */
     counterLabel: string;
     ngOnInit(): void;
     onResize(_: any): void;

package/toast/lib/toast/toast.component.d.ts

@@ -1,8 +1,28 @@
-import { EventEmitter, OnDestroy, OnInit } from "@angular/core";
-import { Toast } from "./types/toast";
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { Toast } from './types/toast';
 import * as i0 from "@angular/core";
+/**
+ * @description Componente individual de notificação (toast) que exibe uma mensagem temporária na tela.
+ * Gerencia automaticamente o timer de dismiss quando `toast.sticky` é `false`.
+ * Recomenda-se utilizar o `ToastService` para criar e empilhar toasts na aplicação.
+ *
+ * @example
+ * ```html
+ * <s-toast [toast]="toastData" (dismiss)="onDismiss()" />
+ * ```
+ *
+ * @category Feedback
+ */
 export declare class ToastComponent implements OnInit, OnDestroy {
+    /**
+     * @description Objeto com os dados da notificação a ser exibida.
+     * Inclui propriedades como `severity`, `summary`, `detail`, `duration` e `sticky`.
+     */
     toast: Toast;
+    /**
+     * @description Emitido quando a notificação é descartada, seja pelo timer automático
+     * (ao expirar `toast.duration`) ou pela ação manual do usuário.
+     */
     dismiss: EventEmitter<void>;
     isLeaving: boolean;
     private timer;

package/token-list/lib/token-list/token-list.component.d.ts

@@ -1,13 +1,34 @@
 import { EventEmitter } from '@angular/core';
 import { IToken } from './models/token';
 import * as i0 from "@angular/core";
+/**
+ * @description Componente de lista de tokens (etiquetas) clicáveis e opcionalmente
+ * removíveis. Emite eventos ao selecionar ou remover um token.
+ *
+ * @example
+ * ```html
+ * <s-token-list
+ *   [tokens]="listaDeTokens"
+ *   [removableTokens]="true"
+ *   (tokenSelected)="onTokenSelecionado($event)"
+ *   (tokenRemoved)="onTokenRemovido($event)" />
+ * ```
+ *
+ * @category Summary
+ */
 export declare class TokenListComponent {
     static nextId: number;
+    /** @description Identificador único do componente no DOM. Gerado automaticamente se não informado. */
     id: string;
+    /** @description Lista de tokens exibidos. Campo obrigatório. */
     tokens: IToken[];
+    /** @description Exibe o botão de remoção em cada token. @default false */
     removableTokens: boolean;
+    /** @description Quando `true`, remove os eventos de ponteiro (hover/clique) dos tokens. @default false */
     hidePointerEvents: boolean;
+    /** @description Emitido quando o usuário clica em um token não desabilitado. */
     tokenSelected: EventEmitter<IToken>;
+    /** @description Emitido quando o usuário remove um token não desabilitado. */
     tokenRemoved: EventEmitter<IToken>;
     onTokenSelected(token: IToken): void;
     onTokenRemoved(token: IToken): void;

package/tooltip/lib/tooltip/tooltip.directive.d.ts

@@ -4,21 +4,86 @@ import { MobileBehavior } from './models/mobile-behavior';
 import { TooltipEvent } from './models/tooltip-event';
 import { TooltipPositions } from './models/tooltip-position';
 import * as i0 from "@angular/core";
+/**
+ * @description Diretiva que exibe um tooltip (dica de ferramenta) flutuante ao interagir com o elemento hospedeiro.
+ * Posiciona-se automaticamente considerando o espaço disponível na tela.
+ * Suporta eventos de hover, click e focus, além de comportamentos customizados para mobile.
+ *
+ * @example
+ * ```html
+ * <button sTooltip="Clique aqui" tooltipPosition="top">Ação</button>
+ * ```
+ *
+ * @category Overlay
+ */
 export declare class TooltipDirective implements OnInit, OnDestroy {
     private readonly elementRef;
     private readonly appRef;
     private readonly debounceUtils;
     private readonly renderer;
     private readonly viewContainerRef;
+    /**
+     * @description Texto exibido no tooltip. Quando vazio ou `undefined`, o tooltip não é renderizado.
+     */
     tooltip?: string;
+    /**
+     * @description Posição preferencial do tooltip em relação ao elemento hospedeiro.
+     * O tooltip se reposiciona automaticamente se não houver espaço suficiente.
+     *
+     * @default 'top'
+     */
     tooltipPosition: TooltipPositions;
+    /**
+     * @description Tempo em milissegundos antes do tooltip aparecer após o evento de ativação.
+     *
+     * @default 500
+     */
     showDelay: number;
+    /**
+     * @description Tempo em milissegundos que o tooltip permanece visível após aparecer.
+     * Quando não informado, o tooltip permanece até o usuário sair do elemento.
+     */
     displayTime?: number;
+    /**
+     * @description Evento do elemento hospedeiro que dispara a exibição do tooltip.
+     * - `'hover'`: exibe ao passar o mouse (padrão).
+     * - `'click'`: exibe ao clicar.
+     * - `'focus'`: exibe ao focar no elemento.
+     *
+     * @default 'hover'
+     */
     tooltipEvent: TooltipEvent;
+    /**
+     * @description Quando `true`, o conteúdo HTML do tooltip é escapado antes de ser renderizado.
+     *
+     * @default false
+     */
     escape: boolean;
+    /**
+     * @description Quando `false`, o tooltip nunca é exibido, mesmo que haja interação do usuário.
+     * Útil para desabilitar tooltips dinamicamente.
+     *
+     * @default true
+     */
     visible: boolean;
+    /**
+     * @description Comportamento do tooltip em dispositivos móveis (touch).
+     * - `'pressing'`: exibe ao pressionar e manter o toque (padrão).
+     * - `'none'`: desabilita o tooltip em dispositivos táteis.
+     *
+     * @default 'pressing'
+     */
     mobileBehavior: MobileBehavior;
+    /**
+     * @description Referência a um input HTML para sincronizar a exibição do tooltip com o foco no campo.
+     */
     focusedInputRef: HTMLInputElement | null;
+    /**
+     * @description Quando `true`, o tooltip só é exibido se o texto do elemento estiver truncado (overflow).
+     * Útil para cells de tabela ou elementos com `text-overflow: ellipsis`.
+     *
+     * @default false
+     */
     checkTruncatedText: import("@angular/core").InputSignal<boolean>;
     private componentRef;
     private showTimeout?;

package/topbar/lib/topbar/topbar.component.d.ts

@@ -1,13 +1,30 @@
 import { AfterViewInit, ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@seniorsistemas/angular-components/common/deprecated-selector";
+/**
+ * @description Componente de barra superior (topbar) com título e suporte a
+ * conteúdo transclusão. Também responde ao seletor legado `s-product-header`.
+ *
+ * @example
+ * ```html
+ * <s-topbar header="Minha Aplicação">
+ *   <!-- ações e menus -->
+ * </s-topbar>
+ * ```
+ *
+ * @category Structure
+ */
 export declare class TopbarComponent implements AfterViewInit {
     static readonly nextIdSeed = 0;
     private static _nextId;
     static getNextId(): number;
+    /** @description Identificador único do componente no DOM. Gerado automaticamente se não informado. */
     id: string;
+    /** @description Título exibido na barra superior. Campo obrigatório. */
     header: string;
+    /** @description Z-index base aplicado ao componente. @default 0 */
     baseZIndex: number;
+    /** @description Quando `true`, aplica borda inferior; quando `false`, aplica borda superior. @default true */
     isHeaderFrame: boolean;
     container: ElementRef | null;
     ngAfterViewInit(): void;

package/tree/lib/tree/tree.component.d.ts

@@ -1,19 +1,46 @@
 import { EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
 import { InternalTreeNodeItem, TreeNodeEdit, TreeNodeItem } from './Models/tree.models';
 import * as i0 from "@angular/core";
+/**
+ * @description Componente de árvore hierárquica com suporte a seleção única ou múltipla,
+ * checkboxes, noós expansíveis e edição inline de rótulos. Gerencia o estado interno
+ * dos nós e emite eventos na seleção, expansão, colapso e edição.
+ *
+ * @example
+ * ```html
+ * <s-tree
+ *   [treeData]="nos"
+ *   selectionMode="multiple"
+ *   [showCheckbox]="true"
+ *   (selectedChange)="onSelecaoMudou($event)" />
+ * ```
+ *
+ * @category Data
+ */
 export declare class TreeComponent implements OnChanges {
+    /** @description Lista de nós raíz da árvore. @default [] */
     treeData: TreeNodeItem[];
     private _selected;
+    /** @description Nó(s) selecionado(s). Suporta array ou item único dependendo de `selectionMode`. @default [] */
     get selected(): TreeNodeItem[];
     set selected(value: TreeNodeItem[] | TreeNodeItem | undefined);
+    /** @description Exibe indicador de carregamento nos nós. @default false */
     loading: boolean;
+    /** @description Modo de seleção: `'single'` ou `'multiple'`. @default 'single' */
     selectionMode: 'single' | 'multiple';
+    /** @description Exibe checkboxes nos nós para seleção visual. @default false */
     showCheckbox: boolean;
+    /** @description Expão todos os nós inicialmente. @default false */
     allExpanded: boolean;
+    /** @description Emitido quando a seleção muda, com o(s) nó(s) selecionado(s). */
     selectedChange: EventEmitter<TreeNodeItem[] | TreeNodeItem>;
+    /** @description Emitido quando o usuário clica em um nó da árvore. */
     treeNodeItemClicked: EventEmitter<TreeNodeItem>;
+    /** @description Emitido após uma edição inline de rótulo de nó. */
     treeNodeEdit: EventEmitter<TreeNodeEdit>;
+    /** @description Emitido quando um nó é expandido pelo usuário. */
     nodeExpanded: EventEmitter<TreeNodeItem>;
+    /** @description Emitido quando um nó é colapsado pelo usuário. */
     nodeCollapsed: EventEmitter<TreeNodeItem>;
     ngOnChanges(changes: SimpleChanges): void;
     onTreeNodeItemClicked({ item }: {

package/workspace-switch/lib/workspace-switch/workspace-switch.component.d.ts

@@ -1,14 +1,60 @@
 import { ChangeDetectorRef, ElementRef, EventEmitter, OnInit, QueryList } from '@angular/core';
 import { Workspace } from './models/workspace';
 import * as i0 from "@angular/core";
+/**
+ * @description Componente de seleção de workspace exibe um dropdown com a lista de espaços de trabalho
+ * disponíveis, permitindo ao usuário alternar entre eles. Suporta navegação por teclado
+ * (setas, Enter, Escape), estado desabilitado e um botão de ação customizável no rodapé.
+ *
+ * @example
+ * ```html
+ * <s-workspace-switch
+ *   [workspaces]="workspaces"
+ *   footerButtonLabel="Criar workspace"
+ *   (selected)="onWorkspaceSelect($event)"
+ *   (footerButtonClicked)="onCreate()"
+ * />
+ * ```
+ *
+ * @category Navegação
+ */
 export declare class WorkspaceSwitchComponent implements OnInit {
     private readonly eRef;
     private readonly changeDetectorRef;
+    /**
+     * @description Lista de workspaces disponíveis para seleção. Campo obrigatório.
+     * Cada item deve implementar a interface `Workspace`.
+     * Lança um erro em runtime se a lista estiver vazia.
+     */
     workspaces: Workspace[];
+    /**
+     * @description Rótulo exibido no botão de ação localizado no rodapé do dropdown.
+     *
+     * @default 'Adicionar'
+     */
     footerButtonLabel: string;
+    /**
+     * @description Controla a visibilidade do botão de ação no rodapé do dropdown.
+     * Quando `false`, o botão não é renderizado.
+     *
+     * @default true
+     */
     showFooterButton: boolean;
+    /**
+     * @description Quando `true`, o componente fica desabilitado: não abre o dropdown,
+     * não emite eventos e fica inacessível via teclado (`tabindex = -1`).
+     *
+     * @default false
+     */
     disabled: boolean;
+    /**
+     * @description Emitido quando o usuário clica no botão de ação do rodapé do dropdown.
+     */
     footerButtonClicked: EventEmitter<any>;
+    /**
+     * @description Emitido quando o usuário seleciona um workspace da lista.
+     * Retorna o objeto `Workspace` selecionado.
+     */
     selected: EventEmitter<Workspace>;
     listItems: QueryList<ElementRef> | null;
     get open(): boolean;