@sankhyalabs/ezui 1.1.67 → 1.1.70

package/dist/types/components.d.ts

@@ -17,7 +17,7 @@ export namespace Components {
          */
         "enabled": boolean;
         /**
-          * Label é o título exibido no componente.
+          * Título do campo.
          */
         "label": string;
     }
@@ -27,7 +27,7 @@ export namespace Components {
          */
         "enabled": boolean;
         /**
-          * Define o icone svg que será utilizado no botão, está propriedade só é utilizada caso o componente esteja no modo 'icon'
+          * Define o icone svg que será utilizado no botão. Esta propriedade só é utilizada caso o componente esteja no modo 'icon'
          */
         "image": string;
         /**
@@ -60,7 +60,7 @@ export namespace Components {
     }
     interface EzCheck {
         /**
-          * Deixa o campo disponível ou não interagir com o usuário.
+          * Deixa o campo disponível ou não para interação com o usuário.
          */
         "enabled": boolean;
         /**
@@ -68,11 +68,11 @@ export namespace Components {
          */
         "getMode": () => Promise<string>;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
-          * 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.
+          * 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.
          */
         "mode": string;
         /**
@@ -94,7 +94,7 @@ export namespace Components {
          */
         "iconplacement": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -114,28 +114,28 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
           * Função responsável por carregar as opções dinamicamente
          */
-        "optionloader": Function;
+        "optionLoader": Function;
         /**
-          * Array no formato "{value: string, label: string} que alimenta as opções do Combobox"
+          * Array no formato "{value: string, label: string}" que alimenta as opções do Combobox
          */
         "options": Array<Option>;
-        "searchmode": boolean;
+        "searchMode": boolean;
         /**
           * Ajusta a opção de mostrar o "value" para cada opção. Por padrão não mostra
          */
-        "showoptionvalue": boolean;
+        "showOptionValue": boolean;
         /**
           * Ajusta a opção de mostrar o "value" ao selecionar uma opção. Por padrão não mostra.
          */
-        "showselectedvalue": boolean;
+        "showSelectedValue": boolean;
         /**
           * Valor selecionado no campo
          */
@@ -149,9 +149,9 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -172,6 +172,9 @@ export namespace Components {
           * Define o título do componente.
          */
         "ezTitle": string;
+        /**
+          * Lida com o clique nos botões de dentro do componente.
+         */
         "handleButtonClick": (selectedOption: boolean) => Promise<void>;
         /**
           * Menssagem exibida dentro do Dialog
@@ -182,9 +185,12 @@ export namespace Components {
          */
         "opened": boolean;
         /**
-          * Define o ícone a ser exibido ao lado do título do
+          * Define o ícone a ser exibido ao lado do título do componente
          */
         "personalizedIconPath": string;
+        /**
+          * Faz com que o componente seja exibido.
+         */
         "show": (title: string, message: string, critical: boolean, confirm: boolean, icon: string) => Promise<boolean>;
     }
     interface EzForm {
@@ -203,7 +209,13 @@ export namespace Components {
         "validate": () => Promise<boolean>;
     }
     interface EzIcon {
+        /**
+          * Path da imagem
+         */
         "href": string;
+        /**
+          * Tamanho do ícone
+         */
         "size": string;
     }
     interface EzLabelChip {
@@ -212,7 +224,7 @@ export namespace Components {
          */
         "enabled": boolean;
         /**
-          * Label é o título exibido no componente.
+          * Título exibido no componente.
          */
         "label": string;
         /**
@@ -234,25 +246,25 @@ export namespace Components {
     }
     interface EzModal {
         /**
-          * Define o alinhamento do modal, seus valores podem ser 'right' ou 'left'
+          * Define o alinhamento do modal. Seus valores podem ser "right" ou "left"
          */
         "align": string;
         /**
-          * Define se o modal será fechado ao digitar ESC
+          * Define se o modal será fechado ao clicar ESC
          */
-        "closeesc": boolean;
+        "closeEsc": boolean;
         /**
           * Define se o modal será fechado ao clicar fora do conteúdo.
          */
-        "closeoutsideclick": boolean;
+        "closeOutsideClick": boolean;
         /**
-          * Define o tamanho do modal devem ser utilizados os tamanhos definidos de colunas como "col-sd-3"
+          * Define o tamanho do modal. Devem ser utilizados os tamanhos definidos de colunas como "col-sd-3"
          */
-        "modalsize": string;
+        "modalSize": string;
         /**
           * Controle de exibição do Modal
          */
-        "oppened": boolean;
+        "opened": boolean;
     }
     interface EzNumberInput {
         /**
@@ -262,7 +274,7 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
           * Opção de configurar a transformação de string to number entre formatação pt-BR e en-US (formatação de ENTRADA e SAÍDA do componente: pt-BR="###.###,##" en-US="###,###.##"; Default: "pt-BR") Qualquer outro valor que não seja "en-US", adotará a formatação "pt-BR" Não é case sensitive
          */
@@ -312,9 +324,9 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -334,7 +346,7 @@ export namespace Components {
         /**
           * No modo floating = false o popover só se tornará visível quando o método show() for acionado.
          */
-        "autoclose": boolean;
+        "autoClose": boolean;
         /**
           * Offset bottom do popover em relação ao componente pai
          */
@@ -342,19 +354,19 @@ export namespace Components {
         /**
           * Ajusta o comportamento da largura do popover. Opções: "100% e "fit-content" (default)
          */
-        "boxwidth": string;
+        "boxWidth": string;
         /**
           * Usado no modo floating. Faz com que o componente seja ocultado.
          */
         "hide": () => Promise<void>;
-        /**
-          * Externaliza estado atual do componente.
-         */
-        "isOpened": boolean;
         /**
           * Offset left do popover em relação ao componente pai
          */
         "left": string;
+        /**
+          * Externaliza estado atual do componente.
+         */
+        "opened": boolean;
         /**
           * Offset right do popover em relação ao componente pai
          */
@@ -374,7 +386,7 @@ export namespace Components {
     }
     interface EzPopup {
         /**
-          * Define se o título do componente.
+          * Título do componente.
          */
         "ezTitle": string;
         /**
@@ -386,7 +398,7 @@ export namespace Components {
          */
         "size": string;
         /**
-          * Define o componente utilizará um cabeçalho com botão de fechamento.
+          * Define se o componente utilizará um cabeçalho com botão de fechamento.
          */
         "useHeader": boolean;
     }
@@ -398,9 +410,9 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -421,8 +433,17 @@ export namespace Components {
         "value": Option|string;
     }
     interface EzTabselector {
-        "selectedindex": string;
-        "selectedtab": string;
+        /**
+          * Define o index da aba selecionada.
+         */
+        "selectedIndex": string;
+        /**
+          * Define a aba selecionada.
+         */
+        "selectedTab": string;
+        /**
+          * Define o nome das abas do componente, separadas por vírgulas ",".
+         */
         "tabs": string;
     }
     interface EzTextArea {
@@ -433,9 +454,9 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -443,7 +464,7 @@ export namespace Components {
          */
         "loading": boolean;
         /**
-          * Ajusta o numero de linhas e consequentemente o height do textarea. Valor default: 4
+          * Ajusta o número de linhas e consequentemente o height do textarea. Valor default: 4
          */
         "rows": number;
         /**
@@ -467,9 +488,9 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -477,13 +498,9 @@ export namespace Components {
          */
         "loading": boolean;
         /**
-          * Aplica uma máscara no conteúdo conforme um o padrão estabelecido
+          * Aplica uma máscara no conteúdo conforme o padrão estabelecido
          */
         "mask": string;
-        /**
-          * Faz com que o componente só aceite números
-         */
-        "onlynumber": boolean;
         /**
           * Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado.
          */
@@ -509,9 +526,9 @@ export namespace Components {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage": string;
+        "errorMessage": string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -557,7 +574,7 @@ export namespace Components {
          */
         "enabled": boolean;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label": string;
         /**
@@ -573,7 +590,7 @@ export namespace Components {
          */
         "requestheaders": any;
         /**
-          * Define a URL do deleção
+          * Define a URL de deleção
          */
         "urldelete": string;
         /**
@@ -581,7 +598,7 @@ export namespace Components {
          */
         "urlupload": string;
         /**
-          * Lista de arquivos que sera tráfegada entre cliente e servidor
+          * Lista de arquivos que será trafegada entre cliente e servidor
          */
         "value": Array<EzFile>;
     }
@@ -782,7 +799,7 @@ declare namespace LocalJSX {
          */
         "enabled"?: boolean;
         /**
-          * Label é o título exibido no componente.
+          * Título do campo.
          */
         "label"?: string;
         /**
@@ -796,7 +813,7 @@ declare namespace LocalJSX {
          */
         "enabled"?: boolean;
         /**
-          * Define o icone svg que será utilizado no botão, está propriedade só é utilizada caso o componente esteja no modo 'icon'
+          * Define o icone svg que será utilizado no botão. Esta propriedade só é utilizada caso o componente esteja no modo 'icon'
          */
         "image"?: string;
         /**
@@ -824,15 +841,15 @@ declare namespace LocalJSX {
     }
     interface EzCheck {
         /**
-          * Deixa o campo disponível ou não interagir com o usuário.
+          * Deixa o campo disponível ou não para interação com o usuário.
          */
         "enabled"?: boolean;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
-          * 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.
+          * 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.
          */
         "mode"?: string;
         /**
@@ -854,7 +871,7 @@ declare namespace LocalJSX {
          */
         "iconplacement"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -874,9 +891,9 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -886,20 +903,20 @@ declare namespace LocalJSX {
         /**
           * Função responsável por carregar as opções dinamicamente
          */
-        "optionloader"?: Function;
+        "optionLoader"?: Function;
         /**
-          * Array no formato "{value: string, label: string} que alimenta as opções do Combobox"
+          * Array no formato "{value: string, label: string}" que alimenta as opções do Combobox
          */
         "options"?: Array<Option>;
-        "searchmode"?: boolean;
+        "searchMode"?: boolean;
         /**
           * Ajusta a opção de mostrar o "value" para cada opção. Por padrão não mostra
          */
-        "showoptionvalue"?: boolean;
+        "showOptionValue"?: boolean;
         /**
           * Ajusta a opção de mostrar o "value" ao selecionar uma opção. Por padrão não mostra.
          */
-        "showselectedvalue"?: boolean;
+        "showSelectedValue"?: boolean;
         /**
           * Valor selecionado no campo
          */
@@ -913,9 +930,9 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -957,7 +974,7 @@ declare namespace LocalJSX {
          */
         "opened"?: boolean;
         /**
-          * Define o ícone a ser exibido ao lado do título do
+          * Define o ícone a ser exibido ao lado do título do componente
          */
         "personalizedIconPath"?: string;
     }
@@ -974,7 +991,13 @@ declare namespace LocalJSX {
         "slavemode"?: boolean;
     }
     interface EzIcon {
+        /**
+          * Path da imagem
+         */
         "href"?: string;
+        /**
+          * Tamanho do ícone
+         */
         "size"?: string;
     }
     interface EzLabelChip {
@@ -983,7 +1006,7 @@ declare namespace LocalJSX {
          */
         "enabled"?: boolean;
         /**
-          * Label é o título exibido no componente.
+          * Título exibido no componente.
          */
         "label"?: string;
         /**
@@ -1005,21 +1028,21 @@ declare namespace LocalJSX {
     }
     interface EzModal {
         /**
-          * Define o alinhamento do modal, seus valores podem ser 'right' ou 'left'
+          * Define o alinhamento do modal. Seus valores podem ser "right" ou "left"
          */
         "align"?: string;
         /**
-          * Define se o modal será fechado ao digitar ESC
+          * Define se o modal será fechado ao clicar ESC
          */
-        "closeesc"?: boolean;
+        "closeEsc"?: boolean;
         /**
           * Define se o modal será fechado ao clicar fora do conteúdo.
          */
-        "closeoutsideclick"?: boolean;
+        "closeOutsideClick"?: boolean;
         /**
-          * Define o tamanho do modal devem ser utilizados os tamanhos definidos de colunas como "col-sd-3"
+          * Define o tamanho do modal. Devem ser utilizados os tamanhos definidos de colunas como "col-sd-3"
          */
-        "modalsize"?: string;
+        "modalSize"?: string;
         /**
           * Um evento disparado quando o modal é fechado (onEzCloseModal).
          */
@@ -1027,7 +1050,7 @@ declare namespace LocalJSX {
         /**
           * Controle de exibição do Modal
          */
-        "oppened"?: boolean;
+        "opened"?: boolean;
     }
     interface EzNumberInput {
         /**
@@ -1037,7 +1060,7 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
           * Opção de configurar a transformação de string to number entre formatação pt-BR e en-US (formatação de ENTRADA e SAÍDA do componente: pt-BR="###.###,##" en-US="###,###.##"; Default: "pt-BR") Qualquer outro valor que não seja "en-US", adotará a formatação "pt-BR" Não é case sensitive
          */
@@ -1079,13 +1102,13 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
-          * Um evento disparado quando o estado do componente é alterado (onEzChange).
+          * Evento disparado quando o estado do componente é alterado (onEzChange).
          */
         "onEzChange"?: (event: CustomEvent<string>) => void;
         /**
@@ -1105,7 +1128,7 @@ declare namespace LocalJSX {
         /**
           * No modo floating = false o popover só se tornará visível quando o método show() for acionado.
          */
-        "autoclose"?: boolean;
+        "autoClose"?: boolean;
         /**
           * Offset bottom do popover em relação ao componente pai
          */
@@ -1113,11 +1136,7 @@ declare namespace LocalJSX {
         /**
           * Ajusta o comportamento da largura do popover. Opções: "100% e "fit-content" (default)
          */
-        "boxwidth"?: string;
-        /**
-          * Externaliza estado atual do componente.
-         */
-        "isOpened"?: boolean;
+        "boxWidth"?: string;
         /**
           * Offset left do popover em relação ao componente pai
          */
@@ -1126,6 +1145,10 @@ declare namespace LocalJSX {
           * Evento disparado ao exibir/ocultar o componente.
          */
         "onEzVisibilityChange"?: (event: CustomEvent<boolean>) => void;
+        /**
+          * Externaliza estado atual do componente.
+         */
+        "opened"?: boolean;
         /**
           * Offset right do popover em relação ao componente pai
          */
@@ -1137,7 +1160,7 @@ declare namespace LocalJSX {
     }
     interface EzPopup {
         /**
-          * Define se o título do componente.
+          * Título do componente.
          */
         "ezTitle"?: string;
         /**
@@ -1153,7 +1176,7 @@ declare namespace LocalJSX {
          */
         "size"?: string;
         /**
-          * Define o componente utilizará um cabeçalho com botão de fechamento.
+          * Define se o componente utilizará um cabeçalho com botão de fechamento.
          */
         "useHeader"?: boolean;
     }
@@ -1165,9 +1188,9 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -1175,7 +1198,7 @@ declare namespace LocalJSX {
          */
         "onEzChange"?: (event: CustomEvent<Option>) => void;
         /**
-          * Este é o evento emitido ao clicar para abrir o popup
+          * Evento emitido ao clicar para abrir o popup
          */
         "onShowPopup"?: (event: CustomEvent<any>) => void;
         /**
@@ -1197,11 +1220,20 @@ declare namespace LocalJSX {
     }
     interface EzTabselector {
         /**
-          * Este é o evento emitido ao clicar para abrir o popup (onChange).
+          * Evento emitido ao clicar para abrir o popup (onChange).
+         */
+        "onEzChange"?: (event: CustomEvent<string>) => void;
+        /**
+          * Define o index da aba selecionada.
+         */
+        "selectedIndex"?: string;
+        /**
+          * Define a aba selecionada.
+         */
+        "selectedTab"?: string;
+        /**
+          * Define o nome das abas do componente, separadas por vírgulas ",".
          */
-        "onChange"?: (event: CustomEvent<string>) => void;
-        "selectedindex"?: string;
-        "selectedtab"?: string;
         "tabs"?: string;
     }
     interface EzTextArea {
@@ -1212,9 +1244,9 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -1222,11 +1254,11 @@ declare namespace LocalJSX {
          */
         "loading"?: boolean;
         /**
-          * Um evento disparado quando o estado do componente é alterado (onEzChange).
+          * Evento disparado quando o estado do componente é alterado (onEzChange).
          */
         "onEzChange"?: (event: CustomEvent<string>) => void;
         /**
-          * Ajusta o numero de linhas e consequentemente o height do textarea. Valor default: 4
+          * Ajusta o número de linhas e consequentemente o height do textarea. Valor default: 4
          */
         "rows"?: number;
         /**
@@ -1242,9 +1274,9 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -1252,17 +1284,13 @@ declare namespace LocalJSX {
          */
         "loading"?: boolean;
         /**
-          * Aplica uma máscara no conteúdo conforme um o padrão estabelecido
+          * Aplica uma máscara no conteúdo conforme o padrão estabelecido
          */
         "mask"?: string;
         /**
-          * Um evento disparado quando o estado do componente é alterado (onEzChange).
+          * Evento disparado quando o estado do componente é alterado (onEzChange).
          */
         "onEzChange"?: (event: CustomEvent<string>) => void;
-        /**
-          * Faz com que o componente só aceite números
-         */
-        "onlynumber"?: boolean;
         /**
           * Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado.
          */
@@ -1280,9 +1308,9 @@ declare namespace LocalJSX {
         /**
           * Quando há um problema de validação, serve como orientação ao usuário
          */
-        "errormessage"?: string;
+        "errorMessage"?: string;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -1318,7 +1346,7 @@ declare namespace LocalJSX {
          */
         "enabled"?: boolean;
         /**
-          * Label é o título do campo
+          * Título do campo
          */
         "label"?: string;
         /**
@@ -1338,7 +1366,7 @@ declare namespace LocalJSX {
          */
         "requestheaders"?: any;
         /**
-          * Define a URL do deleção
+          * Define a URL de deleção
          */
         "urldelete"?: string;
         /**
@@ -1346,7 +1374,7 @@ declare namespace LocalJSX {
          */
         "urlupload"?: string;
         /**
-          * Lista de arquivos que sera tráfegada entre cliente e servidor
+          * Lista de arquivos que será trafegada entre cliente e servidor
          */
         "value"?: Array<EzFile>;
     }