@sankhyalabs/ezui 2.3.1 → 2.3.2

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

@@ -2,35 +2,35 @@ export declare class EzButton {
   _element: HTMLElement;
   private _button;
   /**
-   * Texto indicativo da ação do botão.
+   * Texto a ser apresentado como título do botão.
    */
   label: string;
   /**
-   * Deixa o botão disponível ou não para interação com o usuário.
+   * Se false o usuário não pode interagir com o botão.
    */
   enabled: boolean;
   /**
-     * Define o modo de uso do botão; opções: icon, link e regular
-     */
-  mode: string;
+   * Define o modo de uso do botão.
+   */
+  mode: "regular" | "icon" | "link" | "label-icon";
   /**
-   * Define o icone svg que será utilizado no botão. Esta propriedade só é utilizada caso o componente esteja no modo "icon"
+   * Define o caminho usado nos modos `icon` e `label-icon` para imagens não contempladas na biblioteca de ícones.
    */
   image: 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;
   /**
-   * É possível escolher entre [small,medium,large] (somente para os modos "icon" e "link")
+   * Define o tamanho do ez-button.
    */
   size: "small" | "medium" | "large" | undefined;
   /**
-   * Realiza o foco no botão
+   * Aplica o foco no botão.
    */
   setFocus(): Promise<void>;
   /**
-   * Remove o foco no botão
+   * Remove o foco do botão.
    */
   setBlur(): Promise<void>;
   componentDidLoad(): void;

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

@@ -18,39 +18,36 @@ export declare class EzCalendar {
   private _minutesScroll;
   private _secondsScroll;
   /**
-   * A data selecionada no calendário
+   * Define o valor do calendário.
    */
   value: Date;
   /**
-   * No modo floating o calendário só se tornará visível
-   * quando o método show() for acionado.
+   * Define se a exibição do ez-calendar será feita pelos métodos `show()` e `hide()`.
    */
   floating: boolean;
   /**
-   * Exibe ou não as horas e minutos no calendario
+   * Se true a data considera horas e minutos.
    */
   time: boolean;
   /**
-  * Exibe ou não os segundos no calendario
-  */
+   * Se true a data considera segundos. Deve ser usado em conjunto com a propriedade `time`.
+   */
   showSeconds: boolean;
   /**
-   * Quando o usuário escolhe uma data, esse evento é emitido.
+   * Emitido quando acontece a alteração de valor do calendário.
    */
   ezChange: EventEmitter<Date>;
   /**
-   * Usado no modo floating. Faz com que o componente seja exibido.
-   * É possível determinar ajustes de posicionamento através dos parâmetros
-   * top, left, bottom e right. Esses parâmetros devem ser informados como
-   * strings no formato css.
+   * Exibe o ez-calendar em uma posição determinada.
+   * É possível determinar o posicionamento através dos parâmetros, no formato css.
    */
   show(top?: string, left?: string, bottom?: string, right?: string): Promise<void>;
   /**
-  * Método necessário para ajustar o posicionamento do calendar acima ou abaixo do ez-date-input conforme a disponibilidade de espaço.
-  */
+   * Ajusta o posicionamento do ez-calendar conforme a disponibilidade de espaço.
+   */
   fitVertical(topOffset: number, bottomOffset: number): Promise<void>;
   /**
-   * Usado no modo floating. Faz com que o componente seja ocultado.
+   * Oculta o ez-calendar.
    */
   hide(): Promise<void>;
   observeValue(): void;

package/dist/types/components/ez-card-item/ez-card-item.d.ts

@@ -15,7 +15,14 @@ export interface DetailContainer {
 export declare class EzCardItem {
   private _details;
   private _element;
+  /**
+   * Determina o conteúdo do card. Deve conter um objeto no formato:
+   * `{title: string, key: string, details: any}`.
+   */
   item: CardItem;
+  /**
+   * Emitido sempre que o ez-card é clicado.
+   */
   ezClick: EventEmitter<CardItem>;
   componentWillRender(): void;
   componentDidLoad(): void;

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

@@ -1,40 +1,38 @@
 import { EventEmitter } from '../../stencil-public-runtime';
+import { CheckMode } from './CheckMode';
 export declare class EzCheck {
   private _element;
   private _inputElem;
   /**
-   * Evento disparado ao mudar o estado do check(onEzChange).
+   * Emitido quando acontece a alteração de valor do campo.
    */
   ezChange: EventEmitter<any>;
   /**
-  * Título do campo
+  * Texto a ser apresentado como título do campo.
   */
   label: string;
   /**
-   * Como se trata de um componente binário, o valor alterna entre true e false (marcado / desmarcado)
+   * Define o valor do campo.
    */
   value: boolean;
   /**
-   * Deixa o campo disponível ou não para interação com o usuário.
+   * Se false o usuário não pode interagir com o campo.
    */
   enabled: boolean;
   /**
-   * Deixa o campo em um estado indeterminado, nem marcado nem desmarcado (não disponível em modo "switch").
+   * Se true ativa o estado indeterminado, nem marcado nem desmarcado (não disponível em modo `switch`).
    */
   indeterminate: boolean;
   /**
-   * Existem dois modos de visualização: regular e switch.
-   * Se esta propriedade for omitida, o componete assume o formato "regular".
-   * No modo "regular" a visualização é a tradicional de uma caixinha marcada/desmarcada.
-   * No modo "switch" o campo tem uma interface em formato de um pino liga/desliga.
+   * Define o modo de visualização do ez-check.
    */
-  mode: string;
+  mode: CheckMode;
   /**
-   * Devolve o modo escolhido para o componente
+   * Obtém o modo escolhido.
    */
-  getMode(): Promise<string>;
+  getMode(): Promise<CheckMode>;
   /**
-   * Faz o foco no componente de input
+   * Aplica o foco no campo.
    */
   setFocus(): Promise<void>;
   componentDidLoad(): void;

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

@@ -4,43 +4,44 @@ export declare class EzChip {
   private _containerElem;
   private _labelElem;
   /**
-   * Título exibido no componente.
+   * Texto a ser apresentado como título do ez-chip.
    */
   label: string;
   /**
-   * Deixa o componente disponível ou não para seleção.
+   * Se false o usuário não pode interagir com o ez-chip.
    */
   enabled: boolean;
   /**
-   * Indica se o componente terá a opção de ser removido e qual sua posição: left ou right.
+   * Determina o posicionamento do botão de remover (não disponível no modo `action`).
+   * Se não informado, não exibe o botão.
    */
-  removePosition: "left" | "right";
+  removePosition: "left" | "right" | undefined;
   /**
-   * Define o modo de uso do cjip: label ou action
+   * Define o modo de uso do ez-chip.
    */
   mode: "label" | "action";
   /**
-   * Indica se o componente está ou não ativado.
+   * Define o valor do ez-chip.
    */
   value: boolean;
   /**
-  *Evento disparado quando o estado do componente mudar (onValueChange).
-  */
+   * Emitido quando acontece a alteração de valor do ez-chip.
+   */
   valueChange: EventEmitter<boolean>;
   /**
-  *Evento disparado ao clicar no botão de remoção (onRemoveChip).
-  */
+   * Emitido quando o botão de remoção é acionado.
+   */
   removeChip: EventEmitter<void>;
   /**
- *Evento disparado ao clicar no chip usando o modo "action" (onActionClick).
- */
+   * Emitido no modo "action" quando o usuário clica no ez-chip.
+   */
   actionClick: EventEmitter<void>;
   /**
-   * Faz o foco no componente de input
+   * Aplica o foco no ez-chip.
    */
   setFocus(): Promise<void>;
   /**
-   * Remove o foco no componente de input
+   * Remove o foco do ez-chip.
    */
   setBlur(): Promise<void>;
   handleSlotChange(ev: Event): void;

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

@@ -5,63 +5,63 @@ export declare class EzCollapsibleBox {
   private _hostElement;
   private _activeEditText;
   /**
-   * Valor externalizado que garante a exibição ou não do componente.
+   * Define o valor do componente.
    */
   value: boolean;
   /**
-   * Título do campo
+   * Texto a ser apresentado como título do componente.
    */
   label: string;
   /**
-  * Define o tamanho do texto e do ícone do componente.
-  */
+   * Define o tamanho do texto e do ícone.
+   */
   headerSize: "x-small" | "small" | "medium" | "large" | "x-large" | undefined;
   /**
-  * Define o local onde o ícone será renderizado.
-  */
+   * Define o posicionamento do ícone.
+   */
   iconPlacement: "left" | "right";
   /**
-  * Define se o titulo irá ocupar toda a largura do componente.
-  */
+   * Se true o título irá ocupar toda a largura do componente.
+   */
   stretchTitle: boolean;
   /**
-  * Ativa o ícone para remoção do componente.
-  */
+   * Se true mostra o ícone para remoção do componente.
+   */
   removable: boolean;
   /**
-  * Ativa o ícone para edição do componente.
-  */
+   * Se true mostra o ícone para edição do componente.
+   */
   editable: boolean;
   /**
-  * Define uma condição para salvar ou não uma alteração.
-  */
+   * Define uma condição para salvar ou não uma alteração.
+   */
   conditionalSave: Function;
   /**
-  * Evento disparado ao mudar o estado do componente (onEzChange).
-  */
+   * Emitido quando acontece a alteração de valor do componente.
+   */
   ezChange: EventEmitter<boolean>;
   /**
-  * Evento disparado ao remover o componente (onEzRemove).
-  */
+   * Emitido ao remover o componente (onEzRemove).
+   */
   ezRemove: EventEmitter<EzCollapsibleBox>;
   /**
-  * Evento disparado ao concluir edição da label (onEzSaveEditLabel).
-  */
+   * Emitido ao concluir edição da label (onEzSaveEditLabel).
+   */
   ezSaveEditLabel: EventEmitter<CustomEvent>;
   /**
-  * Evento disparado quando o modo de edição da label for aberto e fechado (onEzEditLabelMode).
-  */
+   * Emitido quando o modo de edição da label for aberto e fechado (onEzEditLabelMode).
+   */
   ezEditLabelMode: EventEmitter<boolean>;
   /**
-   * Esconde ou revela o conteúdo do componente.
+   * Oculta/mostra o conteúdo do ez-collapsible-box.
    */
   showHide(): Promise<void>;
   /**
-   * Aplica focus no campo de edição de título.
+   * Aplica o foco no campo de edição de título.
    */
   applyFocusTextEdit(): Promise<void>;
   /**
-   * Fecha a edição de título.
+   * Cancela a edição de título.
    */
   cancelEdition(): Promise<void>;
   observeCollapsedValue(): void;

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;