@sankhyalabs/ezui 2.3.1 → 2.3.2

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

@@ -3,51 +3,46 @@ export declare class EzFilterInput {
   private _elem;
   private _textInput;
   /**
-  * 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;
   /**
-   * O valor informado pelo usuário
+   * Define o valor do campo.
    */
   value: string;
   /**
-   * Deixa o campo disponível ou não para uso.
+   * 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;
   /**
-   * Restringe o que o usuário pode digitar. Cada caractere digitado será testado
-   * e deve estar contido nessa string ou será descartado.
+   * Restringe o que o usuário pode digitar.
    */
   restrict: string;
   /**
-   * Define o modo do tamanho do campo; opções: slim e regular.
+   * Define o tamanho do campo.
    */
-  mode: string;
+  mode: "slim" | "regular";
   observeLabel(): void;
   observeErrorMessage(): void;
   observeValue(newValue: string, oldValue: string): void;
   /**
-   * 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>;
   changeValue(evt: CustomEvent<string>): void;

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

@@ -8,23 +8,25 @@ export declare class EzForm implements DUActionInterceptor {
   private _dataBinder;
   private _dataElementIdEzForm;
   /**
-   * Repositório de dados, controla a manipulação dos dados
+   * Unidade de dados. Responsável pelo controle de edição de registros e
+   * informações pertinentes aos campos.
    */
   dataUnit: DataUnit;
   /**
-   * Configuração dos campos.
+   * Configuração do formulário.
    */
   config: IFormConfig;
   /**
-   * Validador responsável por checar a integridade das informações do registro
+   * Define um validador responsável pela integridade dos registros.
    */
   recordsValidator: IRecordValidator;
   /**
   * Evento disparado quando o formulário está disponível na DOM.
   */
   ezReady: EventEmitter<void>;
-  submit(): Promise<void>;
-  cancel(): Promise<void>;
+  /**
+   * Realiza validação no conteúdo de todos os campos.
+   */
   validate(): Promise<void>;
   observeConfig(): void;
   private validateRequired;

package/dist/types/components/ez-grid/controller/EzGridController.d.ts

@@ -136,7 +136,7 @@ export interface EzGridOptions {
  */
 export interface EzGridColumn {
   /**
-   * Texto exibido no cabeçalho da coluna.
+   * Texto a ser apresentado como título da coluna.
    */
   label: string;
   /**
@@ -187,7 +187,7 @@ export interface EzGridColumn {
  */
 export interface EzGridColumnMenuItemDef {
   /**
-   * Texto exibido no item de menu.
+   * Texto a ser apresentado como título do item de menu.
    */
   label: string;
   /**

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

@@ -10,76 +10,74 @@ export declare class EzGrid {
   private _paginationInfo;
   private _paginationChangedByKeyboard;
   /**
-  * Evento disparado ao mudar o estado das colunas do grid. Ordenação, largura, etc.
-  */
+   * Emitido quando acontece a alteração de estado das colunas do grid: Ordenação, largura, etc.
+   */
   ezColumnStateChange: EventEmitter<EzGridColumStateEvent>;
   /**
-  * Evento disparado ao selecionar linhas da grade.
-  */
+   * Emitido quando acontece a alteração de seleção de linhas.
+   */
   ezSelectionChange: EventEmitter<Array<any>>;
   /**
-  * Evento disparado com o duplo clique de uma linha
-  */
+   * Emitido com o duplo clique de uma linha
+   */
   ezDoubleClick: EventEmitter<any>;
   /**
-  * Evento disparado ao realizar alguma modificação na configuração da grid.
-  */
+   * Emitido quando acontece a alteração de configuração do grade.
+   */
   configChange: EventEmitter<IGridConfig>;
   /**
-  * Habilita a seleção de várias linhas
-  */
+   * Habilita a seleção de várias linhas.
+   */
   multipleSelection: boolean;
   /**
-  * Configuração de exibição da grade.
-  */
+   * Configuração de exibição da grade.
+   */
   config: IGridConfig;
   /**
-   * Endereço do servidor. Se informado, o próprio datagrid controlará a obtenção
-   * dos dados, anulando a necessidade de acionar o método "setData(data)"
+   * Endereço do servidor para obtenção dos dados.
    */
   serverUrl: string;
   /**
-   * Repositório de dados, controla a manipulação dos dados.
+   * Unidade de dados. Responsável pelo controle de edição de registros e
+   * informações pertinentes aos campos.
    */
   dataUnit: DataUnit;
   /**
-   * Configuração do valor da coluna de status.
-   * Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
+   * Define um `IStatusResolver` responsável pelo estado da coluna de status.
    */
   statusResolver: IStatusResolver;
   /**
-  * Método responsável por receber a definição das colunas
-  */
-  setColumnsDef(cols: Array<EzGridColumn>): Promise<any>;
+   * Aplica a definição de colunas.
+   */
+  setColumnsDef(cols: Array<EzGridColumn>): Promise<void>;
   /**
-  * Adiciona item de menu nas colunas.
-  */
-  addColumnMenuItem(label: string, name: string, action: Function): Promise<any>;
+   * Adiciona item de menu nas colunas.
+   */
+  addColumnMenuItem(label: string, name: string, action: Function): Promise<void>;
   /**
-  * Método responsável por aplicar estado pré-existente nas colunas do grid.
-  */
-  setColumnsState(state: Array<EzGridColumnConfig>): Promise<any>;
+   * Aplica o estado das colunas.
+   */
+  setColumnsState(state: Array<EzGridColumnConfig>): Promise<void>;
   /**
-  * Método de carga dos registros. Os objetos deste array devem conter atributos
-  * para as colunas desejadas.
-  */
-  setData(data: Array<any>): Promise<any>;
+   * Insere os registros no ez-grid.
+   */
+  setData(data: Array<any>): Promise<void>;
   /**
-  * Retorna as linhas selecionadas na grade.
-  */
+   * Obtém as linhas selecionadas.
+   */
   getSelection(): Promise<Array<any>>;
   /**
-  * Método retornar o estado atual das colunas do grid.
-  */
+   * Obtém o estado atual das colunas.
+   */
   getColumnsState(): Promise<Array<EzGridColumn>>;
   /**
-  * Método retornar o estado atual das colunas do grid.
-  */
+   * Obtém a lista de definição de colunas.
+   */
   getColumns(): Promise<Array<EzGridColumn>>;
   /**
-  * Método para fazer um filtro rápido na grid.
-  */
-  quickFilter(term: string): Promise<any>;
+   * Aplica um filtro rápido.
+   */
+  quickFilter(term: string): Promise<void>;
   componentWillLoad(): void;
   onColumnStateChange(type: string, state: Array<EzGridColumn>, info: any): void;
   private createConfigFromState;

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

@@ -1,14 +1,14 @@
 export declare class EzIcon {
   /**
-   * Tamanho do ícone
+   * Define o tamanho do ícone.
    */
-  size: string;
+  size: "x-small" | "small" | "medium" | "large" | "x-large";
   /**
-   * Path da imagem
+   * Define o endereço da imagem quando não contempladas na biblioteca de ícones.
    */
   href: string;
   /**
-   * Nome do icone disponível no pacote de fontes [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
+   * Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
    */
   iconName: string;
   isSprite(): boolean;

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;
 }