@sankhyalabs/ezui 2.3.0 → 2.3.2

package/dist/types/components/ez-combo-box/ez-combo-box.d.ts

@@ -20,73 +20,74 @@ export declare class EzComboBox {
   private _showLoading;
   private _criteria;
   /**
-   * Valor selecionado no campo
+   * 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 para interação com usuário.
+   * Se false o usuário não pode interagir com o campo.
    */
   enabled: boolean;
   /**
-   * Array no formato "{value: string, label: string}" que alimenta as opções do Combobox
+   * Array com as opções do ez-combo-box. Os elementos devem obedecer
+   * o formato: `{value: string, label: string}`.
    */
   options: Array<IOption>;
   /**
-   * 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;
   /**
-   * Ativa o modo pesquisa do combobox
+   * Se true ativa o modo pesquisa do ez-combo-box.
    */
   searchMode: boolean;
   /**
-   * Ajusta a opção de mostrar o "value" ao selecionar uma opção. Por padrão não mostra.
+   * Se true a opção selecionada exibe o `value` junto com `label`.
    */
   showSelectedValue: boolean;
   /**
-   * Ajusta a opção de mostrar o "value" para cada opção. Por padrão não mostra
+   * Se true cada opção na lista exibe o `value` junto com `label`.
    */
   showOptionValue: boolean;
   /**
-  * Desabilita a digitação dentro do componente.
-  */
+   * Se true desabilita a digitação dentro do componente.
+   */
   suppressSearch: boolean;
   /**
-   * Função responsável por carregar as opções dinamicamente
+   * Carrega as opções dinamicamente.
    */
-  optionLoader: Function;
+  optionLoader: (argument: ISearchArgument) => Promise<Array<IOption>> | Array<IOption> | IOption;
   /**
-   * Remove a opção vazia da lista de opções
+   * Se true remove a opção vazia da lista.
    */
   suppressEmptyOption: boolean;
   /**
-   * 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";
   /**
-   * Evento que é disparado ao alterar o valor do componente
+   * Emitido quando acontece a alteração de valor do campo.
    */
   ezChange: EventEmitter<IOption>;
   observeErrorMessage(): void;
   observeValue(newValue: IOption | string, oldValue: IOption | string): void;
   /**
-   * Realiza o foco no componente de seleção
+   * Aplica o foco no campo.
    */
   setFocus(): Promise<void>;
   /**
-   * Remove o foco no componente de seleção
+   * 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 getText;

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

@@ -6,51 +6,50 @@ export declare class EzDateInput {
   private _focused;
   private _elem;
   /**
-    * Evento disparado ao mudar o estado do componente(onEzChange).
-    */
+   * Emitido quando acontece a alteração de valor do campo.
+   */
   ezChange: EventEmitter<Date>;
   /**
-  *  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;
   /**
-   * A data informada pelo usuário
+   * Define o valor do campo.
    */
   value: Date;
   /**
-   * 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;
   /**
-   * 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: Date, oldValue: Date): void;
   /**
-   * Realiza o foco no componente de data
+   * Aplica o foco no campo.
    */
   setFocus(): Promise<void>;
   /**
-   * Remove o foco no componente de data
+   * 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 changeValue;

package/dist/types/components/ez-date-time-input/ez-date-time-input.d.ts

@@ -6,55 +6,54 @@ export declare class EzDateTimeInput {
   private _focused;
   private _elem;
   /**
-    * Evento disparado ao mudar o estado do componente(onEzChange).
-    */
+   * Emitido quando acontece a alteração de valor do campo.
+   */
   ezChange: EventEmitter<Date>;
   /**
-  *  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;
   /**
-   * A data informada pelo usuário
+   * Define o valor do campo.
    */
   value: Date;
   /**
-   * 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;
   /**
-* Exibe ou não os segundos no input
-*/
+   * Se true considera segundos.
+   */
   showSeconds: boolean;
   /**
-   * 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: Date, oldValue: Date): void;
   /**
-   * Realiza o foco no componente de datetime
+   * Aplica o foco no campo.
    */
   setFocus(): Promise<void>;
   /**
-   * Remove o foco no componente de datetime
+   * 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 handleKeyDown;

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

@@ -17,45 +17,42 @@ export declare class EzDialog {
   private labelCancel;
   private btnConfirmDanger;
   /**
-   * Define se o componente será utilizado no modo de confirmação.
+   * Define se o ez-dialog será utilizado no modo de confirmação.
    */
   confirm: boolean;
   /**
-  * Define se o componente terá o visual padrão, de erro ou de aviso
-  */
+   * Define aparência do ez-dialog.
+   */
   dialogType: DialogType;
   /**
-  * Menssagem exibida dentro do Dialog
-  */
+   * Define a menssagem exibida no ez-dialog.
+   */
   message: string;
   /**
-   * Controla a exibição do componente
+   * Define se o ez-dialog está aberto.
    */
   opened: boolean;
   /**
-   * Define o ícone a ser exibido ao lado do título do componente
+   * Define o ícone a ser exibido.
    */
   personalizedIconPath: string;
   /**
-   * Define o título do componente.
+   * Texto a ser apresentado como título do campo.
    */
   ezTitle: string;
   /**
-   * Evento disparado ao clicar tanto no botão de negação quanto no X.
+   * Emitido ao cancelar o ez-dialog.
    */
   ezCancel: EventEmitter<boolean>;
   /**
-  * Evento disparado ao clicar no botão de aceitação.
-  */
+   * Emitido ao confirmar o ez-dialog.
+   */
   ezAccept: EventEmitter<boolean>;
   private _messageQueue;
   private _currentMessage;
+  private handleButtonClick;
   /**
-   * Lida com o clique nos botões de dentro do componente.
-   */
-  handleButtonClick(selectedOption: boolean): Promise<void>;
-  /**
-   * Faz com que o componente seja exibido.
+   * Exibe o ez-dialog.
    */
   show(title: string, message: string, dialogType: DialogType, confirm: boolean, icon: string, labelCancel: string, labelConfirm: string, btnConfirmDanger: boolean): Promise<boolean>;
   isCritical(dialogType: DialogType): boolean;

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

@@ -84,6 +84,14 @@ export default interface EzGridController {
    * Adiciona um filtro rápido na grid e faz o refresh.
    */
   quickFilter(term: string): void;
+  /**
+   * Foca a ultima linha da grade, usado durante a troca de página
+   */
+  setFocusLastRow(): void;
+  /**
+   * Foca a primeira linha da grade, usado durante a troca de página
+   */
+  setFocusFirstRow(): void;
 }
 /**
  * Carrega as informações necessárias para contextualizar corretamente a instância.
@@ -128,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;
   /**
@@ -179,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/controller/ag-grid/AgGridController.d.ts

@@ -24,6 +24,7 @@ export default class AgGridController implements EzGridController, SortingProvid
   getSort(): Array<Sort>;
   initDatagrid(container: HTMLElement, options: EzGridOptions): void;
   private getRowHeight;
+  private navigateToNextCell;
   private setOptionsEvents;
   private setOptionsSupress;
   private getSelectionHeaderStatus;
@@ -35,6 +36,9 @@ export default class AgGridController implements EzGridController, SortingProvid
   removeRows(): void;
   changeValues(changes: any, rowIds?: Array<string>): void;
   refresh(): void;
+  setFocusFirstRow(): void;
+  setFocusLastRow(): void;
+  private setFocusOnRow;
   setColumnsDef(cols: Array<EzGridColumn>): void;
   getColumnsDef(): Array<EzGridColumn>;
   setColumnsState(state: Array<EzGridColumnConfig>): void;

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

@@ -8,77 +8,76 @@ export declare class EzGrid {
   _lastColumnMovedName: string;
   _element: HTMLElement;
   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;