@sankhyalabs/ezui 2.3.0 → 2.3.2

package/dist/types/components/ez-list/ez-list.d.ts

@@ -1,4 +1,4 @@
-import { EventEmitter } from '../../stencil-public-runtime';
+import { EventEmitter } from "../../stencil-public-runtime";
 export interface ListItem {
   label: string;
   selected?: boolean;
@@ -25,55 +25,52 @@ export declare class EzList {
   private _draggingElement;
   private _changeDeboucingTimeout;
   /**
-  * Define a lista inicial do componente.
-  */
-  dataSource: any[];
+   * Define a lista inicial do componente.
+   */
+  dataSource: Array<ListGroup | ListItem>;
   /**
-  * Define se o componente renderizará os itens separados em grupos..
-  */
+   * Se true os grupos serão exibidos.
+   */
   useGroups: boolean;
   /**
-  * Define se o componente terá o comportamento de arrasto de linhas.
-  */
+   * Se true habilita `drag and drop` para os itens.
+   */
   ezDraggable: boolean;
   /**
-  * Define se os items da lista serão selecionáveis.
-  */
+   * Se true os itens serão selecionáveis.
+   */
   ezSelectable: boolean;
   /**
-  * Define se é possível selecionar mais de um registro.
-
-  /**
- * Função responsável por renderizar um conteúdo dentro do item da lista.
- */
+   * Define um `builder` para construir o `HTMLElement` do item da lista.
+   */
   itemSlotBuilder: (item: any, group?: any) => HTMLElement;
-  createList(): void;
   /**
- * Evento disparado ao modificar ordenação nas linhas da grade.
- */
-  ezChange: EventEmitter<ListItem[] | ListGroup[]>;
-  private sortGroup;
+   * Emitido quando acontece a alteração de estado da lista.
+   */
+  ezChange: EventEmitter<Array<ListItem | ListGroup>>;
   /**
-  * Responsável por limpar a lista de histórico do componente.
-  */
+   * Limpa o histórico da lista.
+   */
   clearHistory(): Promise<void>;
   /**
-  * Responsável por dar um scroll top no componente da lista.
-  */
+   * Traz o conteúdo da lista para a área visível.
+   */
   scrollToTop(): Promise<void>;
   /**
-  * Recebe   como argumento um ListItem {label: string} e um booleano que define se o componente deve fazer scroll para exibir o item específico (opcional).
-  */
+   * Aplica seleção nas linhas da lista.
+   */
   setSelection(selectedItem: ListItem, scrollToOption?: boolean): Promise<void>;
-  removeSelection(): void;
   /**
-   * Retorna   o item selecionado.
-  */
-  getSelection(): Promise<any>;
+   * Obtém o item selecionado.
+   */
+  getSelection(): Promise<ListItem>;
   /**
-   * Retorna   a lista de items conforme o modo de uso.
+   * Obtém a lista de items ou grupos.
    */
-  getList(): Promise<ListItem[] | ListGroup[]>;
+  getList(): Promise<Array<ListItem | ListGroup>>;
+  private createList;
+  private sortGroup;
+  removeSelection(): void;
   componentWillLoad(): void;
   componentWillRender(): void;
   onDrop(ev: any, dragEndItem: ListItemGroup): void;

package/dist/types/components/ez-loading-bar/ez-loading-bar.d.ts

@@ -1,6 +1,12 @@
 export declare class EzLoadingBar {
   private _showLoading;
+  /**
+   * Oculta o ez-loading-bar.
+   */
   hide(): Promise<void>;
+  /**
+   * Exibe o ez-loading-bar.
+   */
   show(): Promise<void>;
   render(): any;
 }

package/dist/types/components/ez-modal/ez-modal.d.ts

@@ -2,32 +2,32 @@ import { EventEmitter } from "../../stencil-public-runtime";
 export declare class EzModal {
   private _overlay;
   /**
-    * Define o tamanho do modal. Devem ser utilizados os tamanhos definidos de colunas como "col-sd-3"
-    */
+   * Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`.
+   */
   modalSize: string;
   /**
-  * Define o alinhamento do modal. Seus valores podem ser "right" ou "left"
-  */
-  align: string;
+   * Define o alinhamento do ez-modal.
+   */
+  align: "right" | "left";
   /**
-  * Controle de exibição do Modal
-  */
+   * Define se o ez-modal está aberto.
+   */
   opened: boolean;
   /**
-  * Define se o modal será fechado ao clicar ESC
-  */
+   * Define se o ez-modal será fechado ao clicar `ESC`.
+   */
   closeEsc: boolean;
   /**
-  * Define se o modal será fechado ao clicar fora do conteúdo.
-  */
+   * Define se o modal será fechado ao clicar fora do conteúdo.
+   */
   closeOutsideClick: boolean;
   /**
-  * Um evento disparado quando o modal é fechado (onEzCloseModal).
-  */
+   * Emitido quando o modal é fechado.
+   */
   ezCloseModal: EventEmitter<boolean>;
   /**
-  * Um evento disparado quando o modal é aberto (onEzOpenModal).
-  */
+   * Emitido quando o modal é aberto.
+   */
   ezOpenModal: EventEmitter;
   observeOpened(): void;
   handleKeyboardEvent: (ev: any) => void;

package/dist/types/components/ez-modal-container/ez-modal-container.d.ts

@@ -1,35 +1,35 @@
-import { EventEmitter } from '../../stencil-public-runtime';
+import { EventEmitter } from "../../stencil-public-runtime";
 export declare class EzModalContainer {
   _closeButton: HTMLElement;
   _okButton: HTMLEzButtonElement;
   /**
-   * Título do modal
+   * Texto a ser apresentado como título do modal.
    */
   modalTitle: string;
   /**
-   * Subtítulo (opcional), geralmente usado para orientação do usuário
+   * Texto do subtítulo, geralmente usado para orientação do usuário.
    */
   modalSubTitle: string;
   /**
-   * Determina se o cabeçalho com o título deverá ser mostrado
+   * Define se o cabeçalho será mostrado.
    */
   showTitleBar: boolean;
   /**
-   * Determina o texto do botão de cancelar
+   * Define o texto do botão de cancelamento.
    */
   cancelButtonLabel: string;
   /**
-   * Determina o texto do botão de Ok
+   * Determina o texto do botão de confirmação.
    */
   okButtonLabel: string;
   /**
-   * Variação de estado do botão de cancelar: [HIDDEN|ENABLED|DISABLED]
+   * Define o estado do botão de cancelamento.
    */
-  cancelButtonStatus: string;
+  cancelButtonStatus: "HIDDEN" | "ENABLED" | "DISABLED";
   /**
-   * Variação de estado do botão de ok: [HIDDEN|ENABLED|DISABLED]
+   * Define o estado do botão de confirmação.
    */
-  okButtonStatus: string;
+  okButtonStatus: "HIDDEN" | "ENABLED" | "DISABLED";
   /**
    * Representa a interação com o usuário.
    * OK - Quando o botão é acionado

package/dist/types/components/ez-number-input/ez-number-input.d.ts

@@ -5,62 +5,56 @@ export declare class EzNumberInput {
   private _focused;
   private _elem;
   /**
-  * Evento disparado quando o estado do componente é alterado (onEzChange).
-  */
+   * Emitido quando acontece a alteração de valor do campo.
+   */
   ezChange: EventEmitter<number>;
   /**
-  *  Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).
-  */
+   * Emitido ao iniciar a alteração (digitação incompleta).
+   */
   ezStartChange: EventEmitter<WaitingChange>;
   /**
-  *  Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível
-  *  completar a alteração, esse evento é disparado.
-  */
+   * Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange.
+   */
   ezCancelWaitingChange: EventEmitter<void>;
   /**
-  * Título do campo
+  * Texto a ser apresentado como título do campo.
   */
   label: string;
   /**
-   * O valor informado pelo usuário
+   * Define o valor do campo.
    */
   value: number;
   /**
-   * Deixa o campo disponível ou não para uso.
+   * Se false, o usuário não pode interagir com o campo.
    */
   enabled: boolean;
   /**
-   * Quando há um problema de validação, serve como orientação ao usuário
+   * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
    */
   errorMessage: string;
   /**
-   * Precisão decimal, ou seja, quantas casas decimais podem ser exibidas. Caso a
-   * quantidade de casas decimais do valor seja maior que precision, haverá arredondamento
+   * Define quantas casas decimais serão exibidas. Caso haja mais casas haverá arredondamento.
    */
   precision: number;
   /**
-   * Esse atributo determina qual é o número mínimo de casas depois da vírgula.
-   * Exemplo: Digamos que a precision seja igual a 4, assim qualquer número será
-   * representado com 4 casas decimais mesmo que iguais a zero: 1,0100.
-   * Se prettiprecision igual a 2, como não há necessidade de mais de duas casas decimais
-   * o valor exibido será 1,01. Por outro lado, até a quarta casa não haverá arredondamento
-   * (1,1234 = 1,1234) mas a partir da quinta casa sim (1,12345 = 1,1235).
+   * Define qual é o mínimo de casas depois da vírgula.
+   * Exemplo: 1,1 será exibido como 1,1000 quando `prettyPrecision = 4`.
    */
   prettyPrecision: number;
   /**
-   * Define o modo do tamanho do campo; opções: slim e regular.
+   * Define o tamanho do campo.
    */
-  mode: string;
+  mode: "slim" | "regular";
   /**
-   * Realiza o foco no componente de input
+   * Aplica o foco no campo.
    */
   setFocus(): Promise<void>;
   /**
-   * Remove o foco no componente de input
+   * Remove o foco do campo.
    */
   setBlur(): Promise<void>;
   /**
-   * Retorna informando se o campo está inválido (true | false)
+   * Retorna se o conteúdo é inválido.
    */
   isInvalid(): Promise<boolean>;
   observeLabel(): void;

package/dist/types/components/ez-popover/ez-popover.d.ts

@@ -6,57 +6,54 @@ export declare class EzPopover {
   private _firstRender;
   _host: any;
   /**
-   * No modo floating = false o popover só se tornará visível
-   * quando o método show() for acionado.
+   * Define que será fechado automaticamente quando o usuário clicar fora do conteúdo.
    */
   autoClose: boolean;
   /**
-   * Offset top do popover em relação ao componente pai
+   * Define a distância do topo. Devem ser usados valores válidos de CSS.
    */
   top: string;
   /**
-   * Offset left do popover em relação ao componente pai
+   * Define a distância do lado esquerdo. Devem ser usados valores válidos de CSS.
    */
   left: string;
   /**
-   * Offset bottom do popover em relação ao componente pai
+   * Define a distância de baixo. Devem ser usados valores válidos de CSS.
    */
   bottom: string;
   /**
-   * Offset right do popover em relação ao componente pai
+   * Define a distância do lado direito. Devem ser usados valores válidos de CSS.
    */
   right: string;
   /**
    * Ajusta o comportamento da largura do popover.
-   * Opções: "100% e "fit-content" (default)
    */
-  boxWidth: string;
+  boxWidth: "full-width" | "fit-content";
   /**
-   * Externaliza estado atual do componente.
+   * Define se o ez-popover está aberto.
    */
   opened: boolean;
   /**
-   * Array de componente(s) que irá(ão) abrir o popover.
+   * Define as tags que serão consideradas conteúdo.
    */
   innerElement: Array<string> | string;
   /**
-   *
-    * Evento disparado ao exibir/ocultar o componente.
-    */
+   * Emitido quando acontece a alteração de estado do componente.
+   */
   ezVisibilityChange: EventEmitter<boolean>;
   observeOpened(newValue: boolean, oldValue: boolean): void;
   innerClickTest: (_popOvercontainer: HTMLElement, node: HTMLElement, eventOrigin?: any) => boolean;
   backClickListener: () => void;
   /**
-   * Atualiza a posição do popover em relação ao componente pai.
+   * Atualiza a posição do popover.
    */
   updatePosition(top?: string, left?: string, bottom?: string, right?: string): Promise<void>;
   /**
-   * Faz com que o popover seja renderizado na DOM.
+   * Exibe o ez-popover.
    */
   show(top?: string, left?: string, bottom?: string, right?: string): Promise<void>;
   /**
-   * Usado no modo floating. Faz com que o componente seja ocultado.
+   * Oculta o ez-popover.
    */
   hide(): Promise<void>;
   componentDidRender(): void;

package/dist/types/components/ez-popup/ez-popup.d.ts

@@ -3,31 +3,30 @@ export declare class EzPopup {
   private _container;
   private _sizeClasses;
   /**
-   * Define o width que o componente deve ter, seguindo o grid system. Os valores devem estar
-   * compreendidos em [x-small | small | medium | large | x-large].
+   * Define a largura do ez-popup.
    */
-  size: string;
+  size: "x-small" | "small" | "medium" | "large" | "x-large";
   /**
-   * Controla a exibição do componente.
+   * Define se o ez-popover está aberto.
    */
   opened: boolean;
   /**
-   * Define se o componente utilizará um cabeçalho com botão de fechamento.
+   * Define se o componente utilizará cabeçalho.
    */
   useHeader: boolean;
   /**
-   * Define se o componente utilizará um cabeçalho com botão de fechamento.
+   * Define altura do componente.
    */
-  heightMode: string;
+  heightMode: "auto" | "full";
   /**
-  * Evento disparado ao clicar no botão de fechar (onEzClosePopup).
-  */
-  ezClosePopup: EventEmitter;
-  /**
-   * Título do componente.
+   * Texto a ser apresentado como título do componente.
    */
   ezTitle: string;
-  getGridSize(): any;
+  /**
+   * Emitido ao clicar no botão de fechar (onEzClosePopup).
+   */
+  ezClosePopup: EventEmitter;
+  getGridSize(): string;
   componentDidRender(): void;
   render(): any;
 }

package/dist/types/components/ez-radio-button/ez-radio-button.d.ts

@@ -3,7 +3,7 @@ export declare class EzRadioButton {
   private hostElement;
   private _options;
   /**
-   * Representa o valor atualmente selecionado entre as opções
+   * Define o valor do campo.
    */
   value: any;
   /**
@@ -11,21 +11,21 @@ export declare class EzRadioButton {
    */
   options: Array<Radio>;
   /**
-  * Define se o componente está habilitado ou desabilitado
-  */
+   * Se false o usuário não pode interagir com o campo.
+   */
   enabled: boolean;
   /**
-   * Determina a descrição do grupo
+   * Texto a ser apresentado como título do campo.
    */
   label: string;
   /**
-   * Evento disparado quando uma opção for selecionada
+   * Define a direção dos itens.
    */
-  ezChange: EventEmitter<any>;
+  direction: "vertical" | "horizontal";
   /**
-   * Define a direção em que os itens são apresentadoss, podendo ser horizontal ou vertical.
+   * Emitido quando acontece a alteração de valor do campo.
    */
-  direction: "vertical" | "horizontal";
+  ezChange: EventEmitter<any>;
   componentDidLoad(): void;
   componentWillLoad(): void;
   handleInputChange(ev: Event): void;

package/dist/types/components/ez-scroller/ez-scroller.d.ts

@@ -9,16 +9,15 @@ export declare class EzScroller {
   private _classHidden;
   isFirefox: boolean;
   /**
-   * Determina se haverá scroll na direção Vertical, Horizontal ou Ambos.
-   * Por padrão, a direção é "Ambos".
+   * Define a direção em que haverá scroll.
    */
   direction: EzScrollDirection;
   /**
-   * Determina se o scroll estará bloqueado quando necessário.
+   * Define se o `scroll` estará bloqueado.
    */
   locked: boolean;
   /**
-   * Determina de o efeito de sombreado está ativo.
+   * Define se haverá efeito de sombreado.
    */
   activeShadow: boolean;
   private getContainerClass;

package/dist/types/components/ez-search/ez-search.d.ts

@@ -1,64 +1,60 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IOption } from "../ez-combo-box/ez-combo-box";
+import { IOption, ISearchArgument } from "../ez-combo-box/ez-combo-box";
 export declare class EzSearch {
   private _elem;
   private _comboElement;
   /**
-    * Código do registro selecionado
-    */
+   * Define o valor do campo.
+   */
   value: IOption | string;
   /**
-    * Título do campo
-    */
+   * Texto a ser apresentado como título do campo.
+   */
   label: string;
   /**
-    * Deixa o campo disponível ou não.
-    */
+   * Se false o usuário não pode interagir com o campo.
+   */
   enabled: boolean;
   /**
-    * Um evento disparado quando o estado do componente é alterado (onEzChange).
-    */
-  ezChange: EventEmitter<IOption>;
-  /**
-    * Evento emitido ao clicar para abrir o popup
-    */
-  showPopup: EventEmitter;
-  /**
-   * Quando há um problema de validação, serve como orientação ao usuário
+   * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
    */
   errorMessage: string;
   /**
-    * Função responsável por carregar as opções dinamicamente
-    */
-  optionLoader: Function;
+   * Carrega as opções dinamicamente.
+   */
+  optionLoader: (argument: ISearchArgument) => Promise<Array<IOption>> | Array<IOption> | IOption;
   /**
-    * Ajusta a opção de mostrar o "value" ao selecionar uma opção.
-    */
+   * Se false a opção selecionada deve exibir somente o `label`.
+   */
   showSelectedValue: boolean;
   /**
-    * Ajusta a opção de mostrar o "value" para cada opção.
-    */
+   * Se false cada opção na lista deve exibir somente o `label`.
+   */
   showOptionValue: boolean;
   /**
-    * Remove a opção vazia da lista de opções
-    */
+   * Se true remove a opção vazia da lista.
+   */
   suppressEmptyOption: boolean;
   /**
-    * Define o modo do tamanho do campo; opções: slim e regular.
-    */
-  mode: string;
+   * Define o tamanho do campo.
+   */
+  mode: "slim" | "regular";
+  /**
+   * Emitido quando acontece a alteração de valor do campo.
+   */
+  ezChange: EventEmitter<IOption>;
   observeErrorMessage(): void;
   observeValue(): void;
   /**
-    * Realiza o foco no componente de pesquisa
+    * Aplica o foco no campo.
     */
   setFocus(): Promise<void>;
   /**
-    * Remove o foco no componente de pesquisa
+    * Remove o foco do campo.
     */
   setBlur(): Promise<void>;
   /**
-   * Retorna informando se o campo está inválido (true | false)
+   * Retorna se o conteúdo é inválido.
    */
   isInvalid(): Promise<boolean>;
   onComboChange(event: any): void;

package/dist/types/components/ez-tabselector/ez-tabselector.d.ts

@@ -18,16 +18,13 @@ export declare class EzTabselector {
    */
   selectedTab: string;
   /**
-   * Define o nome das abas do componente, separadas por vírgulas ",".
-   * Opcionalmente pode-se construir um array de objetos do tipo Tab, nesse caso
-   * o tabKey e o índice serão respeitados.
+   * Define o nome das abas do componente.
+   * Podendo serem separadas por vírgula "," ou em um Array de configuração.
    */
   tabs: string | Array<Tab>;
   /**
-  * Evento emitido ao clicar para abrir o popup (ezChange).
-  * O detail desse evento carrega tanto o tabKey quanto o index da aba
-  * selecionada.
-  */
+   * Emitido quando acontece a alteração de valor do componente.
+   */
   ezChange: EventEmitter<Tab>;
   observeTabs(newValue: any): void;
   handleTabClick(tab: Tab): void;

package/dist/types/components/ez-text-area/ez-text-area.d.ts

@@ -7,55 +7,51 @@ export declare class EzTextArea {
   private _initialRows;
   private _hostElement;
   /**
-   * Evento disparado quando o estado do componente é alterado (onEzChange).
+   * Emitido quando acontece a alteração de valor do campo.
    */
   ezChange: EventEmitter<string>;
   /**
-   * Título do campo
+   * Texto a ser apresentado como título do campo.
    */
   label: string;
   /**
-   * Valor digitado pelo usuário. Este valor é o que fica visível no campo.
+   * Define o valor do campo.
    */
   value: string;
   /**
-   * Deixa o campo disponível ou não para digitação.
+   * Se false o usuário não pode interagir com o campo.
    */
   enabled: boolean;
   /**
-   * Deixa o componente em modo "carregando".
-   */
-  loading: boolean;
-  /**
-   * Quando há um problema de validação, serve como orientação ao usuário
+   * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
    */
   errorMessage: string;
   /**
-   * Ajusta o número de linhas e consequentemente o height do textarea. Valor default: 4
+   * Define o número de linhas.
    */
   rows: number;
   /**
-   * Permite exibir a mensagem de erro.
+   * Se false deixa de exibir a mensagem de erro dentro do campo.
    */
   canShowError: boolean;
   /**
-   * Define o modo do tamanho do campo; opções: slim e regular.
+   * Define o tamanho do campo.
    */
-  mode: string;
+  mode: "slim" | "regular";
   observeErrorMessage(): void;
   observeValue(newValue: string, oldValue: string): void;
   observeMode(): void;
   observeRows(): void;
   /**
-   * Faz o foco no componente de input
+   * Aplica o foco no campo.
    */
   setFocus(): Promise<void>;
   /**
-   * Remove o foco no componente de input
+   * Remove o foco do campo.
    */
   setBlur(): Promise<void>;
   /**
-   * Retorna informando se o campo está inválido (true | false)
+   * Retorna se o conteúdo é inválido.
    */
   isInvalid(): Promise<boolean>;
   private canChangeValue;