@sankhyalabs/sankhyablocks 2.4.0 → 2.4.2-SKA-61927.1

package/dist/types/components.d.ts

@@ -26,12 +26,15 @@ import { Action as Action1, CustomButton } from "./components/snk-taskbar/snk-ta
 export namespace Components {
     interface SnkApplication {
         /**
-          * Mostra o diálogo de alerta de acordo com os parâmetros passados.
+          * Exibe o diálogo de alerta de acordo com os parâmetros passados.
          */
         "alert": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
+        /**
+          * Fecha o Modal e limpa o conteúdo.
+         */
         "closeModal": () => Promise<void>;
         /**
-          * Fecha o popup, liberando o conteúdo.
+          * Fecha o Popup e limpa o conteúdo.
          */
         "closePopUp": () => Promise<void>;
         /**
@@ -43,41 +46,47 @@ export namespace Components {
          */
         "confirm": (title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>;
         /**
-          * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
+          * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
          */
         "createDataunit": (entityName: string, dataUnitName?: string) => Promise<DataUnit>;
         /**
-          * Mostra o diálogo de erro de acordo com os parâmetros passados.
+          * Exibe o diálogo de erro de acordo com os parâmetros passados.
          */
         "error": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
+        /**
+          * Obtém as opções em componentes de pesquisa Ex.: snk-config-options
+         */
         "executePreparedSearch": (mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>;
+        /**
+          * Obtém as opções em componentes de pesquisa Ex.: snk-config-options
+         */
         "executeSearch": (searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>;
         /**
-          * Busca a configuração padrão de formulário.
+          * Obtém a configuração padrão de formulário.
          */
         "fetchDefaultConfig": (name: string) => Promise<IFormConfig>;
         /**
-          * Busca a configuração de formulário do usuário.
+          * Obtém a configuração de formulário do usuário.
          */
         "fetchLegacyConfig": (name: string) => Promise<IFormConfig>;
         /**
-          * Busca lista de configurações de formulário do usuário.
+          * Obtém a lista de configurações de formulário do usuário.
          */
         "fetchUserAvailableConfigs": (name: string) => Promise<Array<IUserConfig>>;
         /**
-          * Retorna todos os acessos do usuário logado.
+          * Obtém todos os acessos do usuário logado.
          */
         "getAllAccess": () => Promise<any>;
         /**
-          * Acessa informações de contexto "empurrados" na abertura da tela
+          * Acessa informações de contexto "empurrados" na abertura da tela.
          */
         "getAttributeFromHTMLWrapper": (attribName: string) => Promise<string>;
         /**
-          * Retorna o valor de um parâmetro do tipo booleano.
+          * Obtém o valor de um parâmetro do tipo booleano.
          */
         "getBooleanParam": (name: string) => Promise<boolean>;
         /**
-          * Retorna a configuração de um recurso por service broker
+          * Obtém a configuração de um recurso por service broker
          */
         "getConfig": (key: string) => Promise<any>;
         /**
@@ -85,15 +94,15 @@ export namespace Components {
          */
         "getDataUnit": (entityName: string, dataUnitName: string) => Promise<DataUnit>;
         /**
-          * Retorna o valor de um parâmetro do tipo data.
+          * Obtém o valor de um parâmetro do tipo data.
          */
         "getDateParam": (name: string) => Promise<Date>;
         /**
-          * Retorna um valor padrão específico de uma expressão.
+          * Obtém um valor padrão específico de uma expressão.
          */
         "getDefaultValue": (expression: string) => Promise<any>;
         /**
-          * Busca um objeto com um conjunto de valores padrão.
+          * Obtém um objeto com um conjunto de valores padrão.
          */
         "getDefaultValues": () => Promise<string>;
         /**
@@ -101,48 +110,51 @@ export namespace Components {
          */
         "getFilterBarConfig": (name: string) => Promise<Array<SnkFilterItemConfig>>;
         /**
-          * Retorna o valor de um parâmetro do tipo Decimal.
+          * Obtém o valor de um parâmetro do tipo Decimal.
          */
         "getFloatParam": (name: string) => Promise<number>;
         /**
-          * Retorna o valor de um parâmetro do tipo Inteiro.
+          * Obtém o valor de um parâmetro do tipo Inteiro.
          */
         "getIntParam": (name: string) => Promise<number>;
         /**
-          * Retorna o resourceID da tela em questão.
+          * Obtém o resourceID da tela em questão.
          */
         "getResourceID": () => Promise<string>;
         /**
-          * Retorna o valor de um parâmetro do tipo string.
+          * Obtém o valor de um parâmetro do tipo string.
          */
         "getStringParam": (name: string) => Promise<string>;
         /**
-          * Retorna o resourceID da tela em questão.
+          * Obtém o UserId da tela em questão.
          */
         "getUserID": () => Promise<string>;
         /**
-          * Se o usuário logado tem permissão pra determinada ação.
+          * Obtém `true` caso o usuário logado tem permissão pra determinada ação.
          */
         "hasAccess": (access: AutorizationType) => Promise<boolean>;
         /**
-          * Mostra uma informação efêmera (de segundo plano).
+          * Exibe uma informação efêmera (de segundo plano).
          */
         "info": (message: string, options?: MessageOptions) => Promise<void>;
+        /**
+          * Obtém `true` caso a tela esteja em modo de debug.
+         */
         "isDebugMode": () => Promise<boolean>;
         /**
-          * Caso o usuário logado seja o SUP.
+          * Obtém `true` caso o usuário logado seja o SUP.
          */
         "isUserSup": () => Promise<boolean>;
         /**
-          * Busca a configuração de formulário.
+          * Obtém a configuração de formulário.
          */
         "loadFormConfig": (name: string) => Promise<IFormConfig>;
         /**
-          * Busca a configuração de grade.
+          * Obtém a configuração de grade.
          */
         "loadGridConfig": (name: string) => Promise<IGridConfig>;
         /**
-          * Busca os totalizadores da grade.
+          * Obtém os totalizadores da grade.
          */
         "loadTotals": (name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>;
         /**
@@ -150,11 +162,11 @@ export namespace Components {
          */
         "message": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
         /**
-          * messagesBuilder é um utilitário responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
         "messagesBuilder": SnkMessageBuilder;
         /**
-          * Abre determinada tela, repassando pkObject
+          * Abre determinada tela, repassando pkObject.
          */
         "openApp": (resourceId: string, pkObject: Object) => Promise<void>;
         /**
@@ -173,13 +185,16 @@ export namespace Components {
           * Salva a configuração de grade.
          */
         "saveGridConfig": (config: IGridConfig) => Promise<boolean>;
+        /**
+          * Exibe o conteúdo passado em um Modal.
+         */
         "showModal": (content: HTMLElement) => Promise<void>;
         /**
-          * Mostra o conteúdo passado em um Popup
+          * Exibe o conteúdo passado em um Popup.
          */
         "showPopUp": (content: HTMLElement, size?: string, useHeader?: boolean) => Promise<void>;
         /**
-          * Mostra o diálogo de sucesso de acordo com os parâmetros passados.
+          * Exibe o diálogo de sucesso de acordo com os parâmetros passados.
          */
         "success": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
         /**
@@ -189,24 +204,30 @@ export namespace Components {
     }
     interface SnkConfigOptions {
         /**
-          * Repositório de dados responsável por controlar a manipulação dos dados
+          * Repositório de dados responsável por controlar a manipulação dos dados.
          */
         "dataUnit": DataUnit;
         /**
-          * Armazena as propriedades do campo
+          * Armazena as propriedades do campo.
          */
         "fieldConfig": IFieldConfig;
         /**
-          * Armazena a chave de opções de configuração
+          * Armazena a chave de opções de configuração.
          */
         "idConfig": string;
     }
     interface SnkConfigurator {
+        /**
+          * Fecha a janela de configuração.
+         */
         "close": () => Promise<void>;
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário
+          * Usado para guardar ou recuperar as configurações do formulário.
          */
         "configName": string;
+        /**
+          * Exibe a janela de configuração.
+         */
         "open": () => Promise<void>;
         /**
           * Define qual modo de visualização está ativo.
@@ -215,7 +236,7 @@ export namespace Components {
     }
     interface SnkCrud {
         /**
-          * Ações a serem colocadas no botão "Mais opções".
+          * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList": Array<Action>;
         /**
@@ -227,11 +248,11 @@ export namespace Components {
          */
         "goToView": (mode: string) => Promise<void>;
         /**
-          * Determina se pode haver mais de uma linha selecionada na grade
+          * Determina se pode haver mais de uma linha selecionada na grade.
          */
         "multipleSelection": boolean;
         /**
-          * Validador responsável por checar a integridade das informações do registro
+          * Validador responsável por checar a integridade das informações do registro.
          */
         "recordsValidator": IRecordValidator;
         /**
@@ -245,7 +266,7 @@ export namespace Components {
     }
     interface SnkDataUnit {
         /**
-          * Executado após a ação de salvar
+          * Executado após a ação de salvar.
          */
         "afterSave": (dataUnit: DataUnit) => void;
         /**
@@ -253,38 +274,37 @@ export namespace Components {
          */
         "beforeSave": (dataUnit: DataUnit) => boolean | Promise<boolean>;
         /**
-          * O estato atual dos dados, isto é se há alteração, insersão, as linhas selecionadas, etc.
+          * Controla o estado atual dos dados.
          */
         "dataState": DataState;
         /**
-          * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade
+          * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
          */
         "dataUnit": DataUnit;
         /**
-          * Este atributo é usado para criar o dataUnit uma única vez. Se omitido será usado o próprio nome da entidade.
+          * Usado para criar o dataUnit uma única vez.  Se omitido, será usado o próprio nome da entidade.
          */
         "dataUnitName": string;
         /**
-          * Determina qual a entidade representa os dados em questão.
+          * Determina qual a entidade que representa os dados em questão.
          */
         "entityName": string;
         /**
-          * Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
-          * @returns dataUnit
+          * Obtém o dataUnit.
          */
         "getDataUnit": () => Promise<DataUnit>;
         /**
-          * Determina quantas linhas são retornadas por página
+          * Determina quantas linhas são retornadas por página.
          */
         "pageSize": number;
     }
     interface SnkFieldConfig {
         /**
-          * Repositório de dados, controla a manipulação dos dados
+          * Repositório de dados, controla a manipulação dos dados.
          */
         "dataUnit": DataUnit;
         /**
-          * Armazena as propriedades do campo
+          * Armazena as propriedades do campo.
          */
         "fieldConfig": IFieldConfig;
         /**
@@ -292,7 +312,7 @@ export namespace Components {
          */
         "isConfigActive": Boolean;
         /**
-          * Define se o componente está em modo de inserção
+          * Define se o componente está em modo de inserção.
          */
         "modeInsertion": boolean;
     }
@@ -306,97 +326,229 @@ export namespace Components {
          */
         "dataUnit": DataUnit;
         /**
-          * Lista de todos os filtros disponíveis ao usuário.
+          * Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig": Array<SnkFilterItemConfig>;
     }
     interface SnkFilterBinarySelect {
+        /**
+          * Define as configurações do componente snk-filter-binary-select
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Exibe o componente snk-filter-binary-select
+         */
         "show": () => Promise<void>;
+        /**
+          * Define o valor do componente snk-filter-binary-select
+         */
         "value": any;
     }
     interface SnkFilterDetail {
+        /**
+          * Define as configurações do componente snk-filter-detail.
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage": (key: string, props?: any) => string;
+        /**
+          * Exibe o componente snk-filter-detail.
+         */
         "show": () => Promise<void>;
     }
     interface SnkFilterItem {
+        /**
+          * Define as configurações do componente snk-filter-item.
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage": (key: string, props?: any) => string;
+        /**
+          * Oculta os detalhes de um item da lista.
+         */
         "hideDetail": () => Promise<void>;
+        /**
+          * Exibe os detalhes de um item da lista.
+         */
         "showUp": (open?: boolean) => Promise<void>;
     }
     interface SnkFilterList {
+        /**
+          * Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado).
+         */
         "buttonClass": string;
+        /**
+          * Define o texto exibido quando a lista está vazia.
+         */
         "emptyText": string;
+        /**
+          * Define o texto exibido no componente de busca.
+         */
         "findFilterText": string;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage": (key: string, props?: any) => string;
+        /**
+          * Oculta os detalhes do componente snk-filter-list.
+         */
         "hideDetail": () => Promise<void>;
+        /**
+          * Define o ícone usado no ez-button do filtro.
+         */
         "iconName": string;
+        /**
+          * Guarda a lista de filtros.
+         */
         "items": Array<ListItem>;
+        /**
+          * Define o label usado no ez-button do filtro.
+         */
         "label": string;
     }
     interface SnkFilterModal {
+        /**
+          * Define o label do botão de cancelar.
+         */
         "cancelButtonLabel": string;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage": (key: string, props?: any) => string;
+        /**
+          * Define a descrição do filtro.
+         */
         "infoText": string;
+        /**
+          * Guarda a lista de filtros.
+         */
         "items": Array<ModalItem>;
+        /**
+          * Define o subtítulo do filtro.
+         */
         "modalSubTitle": string;
+        /**
+          * Define o título do filtro.
+         */
         "modalTitle": string;
+        /**
+          * Define o label do botão de confirmar.
+         */
         "okButtonLabel": string;
+        /**
+          * É disparado em qualquer interação com o filtro.
+         */
         "processModalAction": (action: ModalAction) => void;
+        /**
+          * Se `true`, exibe a barra de pesquisa do filtro.
+         */
         "useSearch": boolean;
     }
     interface SnkFilterMultiSelect {
+        /**
+          * Define as configurações do componente snk-filter-multi-select
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Exibe o componente snk-filter-multi-select
+         */
         "show": () => Promise<void>;
+        /**
+          * Define o valor do componente snk-filter-multi-select
+         */
         "value": any;
     }
     interface SnkFilterNumber {
+        /**
+          * Define as configurações do componente snk-filter-number
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Exibe o componente snk-filter-number
+         */
         "show": () => Promise<void>;
+        /**
+          * Define o valor do componente snk-filter-number
+         */
         "value": number;
     }
     interface SnkFilterPeriod {
+        /**
+          * Define as configurações do componente snk-filter-period
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Exibe o componente snk-filter-period
+         */
         "show": () => Promise<void>;
+        /**
+          * Define o valor do componente snk-filter-period
+         */
         "value": any;
     }
     interface SnkFilterPersonalized {
+        /**
+          * Define as configurações do componente snk-filter-personalized
+         */
         "config": SnkFilterItemConfig;
         "fix": ()=>void;
+        /**
+          * Exibe o componente snk-filter-personalized
+         */
         "show": () => Promise<void>;
         "unfix": ()=>void;
+        /**
+          * Define o valor do componente snk-filter-personalized
+         */
         "value": Array<IOption|boolean|string|number|Date>;
     }
     interface SnkFilterSearch {
+        /**
+          * Define as configurações do componente snk-filter-search
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Exibe o componente snk-filter-search
+         */
         "show": () => Promise<void>;
+        /**
+          * Define o valor do componente snk-filter-search
+         */
         "value": IOption;
     }
     interface SnkFilterText {
+        /**
+          * Define as configurações do componente snk-filter-text.
+         */
         "config": SnkFilterItemConfig;
+        /**
+          * Define o valor do componente snk-filter-text.
+         */
         "value": string;
     }
     interface SnkForm {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções"
+          * Define a lista de ações que devem ser usadas no botão "Mais opções" do snk-taskbar.
          */
         "actionsList": Array<Action>;
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário
+          * Nome usado para guardar/recuperar as configurações do formulário.
          */
         "configName": string;
         /**
-          * Método responsável em fechar o modal de configurações do form.
+          * Fecha a janela de configurações do formulário.
          */
         "hideConfig": () => Promise<void>;
         /**
-          * Validador responsável por checar a integridade das informações do registro
+          * Validador responsável por checar a integridade das informações do registro.
          */
         "recordsValidator": IRecordValidator;
         /**
-          * Método responsável em abrir o modal de configurações do form.
+          * Exibe a janela de configurações do formulário.
          */
         "showConfig": () => Promise<void>;
         /**
@@ -406,11 +558,11 @@ export namespace Components {
     }
     interface SnkFormConfig {
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário.
+          * Nome usado para guardar ou recuperar as configurações do formulário.
          */
         "configName": string;
         /**
-          * Repositório de dados, controla a manipulação dos dados
+          * Repositório de dados, controla a manipulação dos dados.
          */
         "dataUnit": DataUnit;
         /**
@@ -420,31 +572,31 @@ export namespace Components {
     }
     interface SnkGrid {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções"
+          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList": Array<Action>;
         /**
-          * Nome usado para salvar/recuperar a configuração
+          * Nome usado para salvar/recuperar a configuração.
          */
         "configName": string;
         /**
-          * Método responsável em fechar o modal de configurações da grade.
+          * Fecha a janela de configurações da grade.
          */
         "hideConfig": () => Promise<void>;
         /**
-          * Determina se pode haver mais de uma linha selecionada
+          * Determina se pode haver mais de uma linha selecionada.
          */
         "multipleSelection": boolean;
         /**
-          * Método responsável por setar as configurações da grade.
+          * Atribui o valor da configuração da grade.
          */
         "setConfig": (config: IGridConfig) => Promise<void>;
         /**
-          * Método responsável em abrir o modal de configurações da grade.
+          * Exibe a janela de configurações da grade.
          */
         "showConfig": () => Promise<void>;
         /**
-          * Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
+          * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
          */
         "statusResolver": IStatusResolver;
         /**
@@ -461,6 +613,9 @@ export namespace Components {
           * Configurações da grade.
          */
         "config": IGridConfig;
+        /**
+          * Salva as configurações da grade.
+         */
         "saveConfig": (config: IGridConfig) => Promise<void>;
         /**
           * Aba selecionada das configurações da grade.
@@ -468,11 +623,23 @@ export namespace Components {
         "selectedIndex": number;
     }
     interface SnkPesquisa {
+        /**
+          * Argumentos que serão usados ao chamar a função searchLoader.
+         */
         "argument": string;
-        "searchLoader": Function;
-        "selectItem": Function;
+        /**
+          * Função responsável em carregar os itens do componente snk-pesquisa.
+         */
+        "searchLoader": (text: string) => Promise<any>;
+        /**
+          * Função disparada ao selecionar um item.
+         */
+        "selectItem": (option: IOption) => void;
     }
     interface SnkSelectBox {
+        /**
+          * Determina a opção selecionada.
+         */
         "selectedOption": IOption | string;
     }
     interface SnkTabConfig {
@@ -485,21 +652,21 @@ export namespace Components {
          */
         "selectedTab": string;
         /**
-          * Define o nome das abas do componente, separadas por vírgulas ",".
+          * Define o nome das abas do componente separadas por vírgulas ",".
          */
         "tabs": string;
     }
     interface SnkTaskbar {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções"
+          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList": Array<Action>;
         /**
-          * Lista separada por virgula, contendo todos os elementos a serem criados
+          * Lista separada por virgula, contendo todos os elementos a serem criados.
          */
         "buttons": string;
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário
+          * Usado para guardar ou recuperar as configurações do formulário.
          */
         "configName": string;
         /**
@@ -507,15 +674,15 @@ export namespace Components {
          */
         "customButtons": Map<string, CustomButton>;
         /**
-          * Instância do DataUnit
+          * Instância do DataUnit.
          */
         "dataUnit": DataUnit;
         /**
-          * Array contendo todos os botões a serem desabilitados
+          * Array contendo todos os botões a serem desabilitados.
          */
         "disabledButtons": Array<string>;
         /**
-          * Qual botão deve ter aparência primária
+          * Determina qual botão deve ter aparência primária.
          */
         "primaryButton": string;
     }
@@ -786,47 +953,47 @@ declare namespace LocalJSX {
          */
         "configName"?: string;
         /**
-          * messagesBuilder é um utilitário responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
         "messagesBuilder"?: SnkMessageBuilder;
         /**
-          * Evento disparado quando a aplicação for carregada.
+          * Emitido quando a aplicação for carregada.
          */
         "onApplicationLoaded"?: (event: SnkApplicationCustomEvent<boolean>) => void;
         /**
-          * Evento disparado ao iniciar a carga do componente
+          * Emitido ao iniciar a carga do componente.
          */
         "onApplicationLoading"?: (event: SnkApplicationCustomEvent<boolean>) => void;
     }
     interface SnkConfigOptions {
         /**
-          * Repositório de dados responsável por controlar a manipulação dos dados
+          * Repositório de dados responsável por controlar a manipulação dos dados.
          */
         "dataUnit"?: DataUnit;
         /**
-          * Armazena as propriedades do campo
+          * Armazena as propriedades do campo.
          */
         "fieldConfig"?: IFieldConfig;
         /**
-          * Armazena a chave de opções de configuração
+          * Armazena a chave de opções de configuração.
          */
         "idConfig"?: string;
         /**
-          * Evento disparado ao realizar alguma alteração nos campos
+          * Emitido ao realizar alguma alteração nos campos.
          */
         "onConfigOptionsChanged"?: (event: SnkConfigOptionsCustomEvent<any>) => void;
     }
     interface SnkConfigurator {
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário
+          * Usado para guardar ou recuperar as configurações do formulário.
          */
         "configName"?: string;
         /**
-          * Evento disparado quando seleciona modo de visualização
+          * Emitido quando seleciona o modo de visualização.
          */
         "onConfigSelected"?: (event: SnkConfiguratorCustomEvent<string>) => void;
         /**
-          * Evento disparado quando clicar para abrir uma configuração
+          * Emitido quando clica para abrir a configuração.
          */
         "onOpenConfig"?: (event: SnkConfiguratorCustomEvent<string>) => void;
         /**
@@ -836,7 +1003,7 @@ declare namespace LocalJSX {
     }
     interface SnkCrud {
         /**
-          * Ações a serem colocadas no botão "Mais opções".
+          * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList"?: Array<Action>;
         /**
@@ -844,15 +1011,15 @@ declare namespace LocalJSX {
          */
         "configName"?: string;
         /**
-          * Determina se pode haver mais de uma linha selecionada na grade
+          * Determina se pode haver mais de uma linha selecionada na grade.
          */
         "multipleSelection"?: boolean;
         /**
-          * Emitido pela taskbar sempre que houver click de botão ou ação
+          * Emitido pela taskbar sempre que houver click de botão ou ação.
          */
         "onActionClick"?: (event: SnkCrudCustomEvent<string>) => void;
         /**
-          * Validador responsável por checar a integridade das informações do registro
+          * Validador responsável por checar a integridade das informações do registro.
          */
         "recordsValidator"?: IRecordValidator;
         /**
@@ -866,7 +1033,7 @@ declare namespace LocalJSX {
     }
     interface SnkDataUnit {
         /**
-          * Executado após a ação de salvar
+          * Executado após a ação de salvar.
          */
         "afterSave"?: (dataUnit: DataUnit) => void;
         /**
@@ -874,49 +1041,49 @@ declare namespace LocalJSX {
          */
         "beforeSave"?: (dataUnit: DataUnit) => boolean | Promise<boolean>;
         /**
-          * O estato atual dos dados, isto é se há alteração, insersão, as linhas selecionadas, etc.
+          * Controla o estado atual dos dados.
          */
         "dataState"?: DataState;
         /**
-          * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade
+          * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
          */
         "dataUnit"?: DataUnit;
         /**
-          * Este atributo é usado para criar o dataUnit uma única vez. Se omitido será usado o próprio nome da entidade.
+          * Usado para criar o dataUnit uma única vez.  Se omitido, será usado o próprio nome da entidade.
          */
         "dataUnitName"?: string;
         /**
-          * Determina qual a entidade representa os dados em questão.
+          * Determina qual a entidade que representa os dados em questão.
          */
         "entityName"?: string;
         /**
-          * Disparado quando se cancela uma insersão/cópia
+          * Emitido quando se cancela uma inserção ou cópia.
          */
         "onCancelEdition"?: (event: SnkDataUnitCustomEvent<void>) => void;
         /**
-          * Disparado quando o há qualquer mudança de estado no DataUnit
+          * Emitido quando há qualquer mudança de estado no DataUnit.
          */
         "onDataStateChange"?: (event: SnkDataUnitCustomEvent<DataState>) => void;
         /**
-          * Disparado quando o DataUnit está pronto
+          * Emitido quando o DataUnit está pronto.
          */
         "onDataUnitReady"?: (event: SnkDataUnitCustomEvent<DataUnit>) => void;
         /**
-          * Disparado quando um registro é adicionado ou copiado
+          * Emitido quando um registro é adicionado ou copiado.
          */
         "onInsertionMode"?: (event: SnkDataUnitCustomEvent<void>) => void;
         /**
-          * Determina quantas linhas são retornadas por página
+          * Determina quantas linhas são retornadas por página.
          */
         "pageSize"?: number;
     }
     interface SnkFieldConfig {
         /**
-          * Repositório de dados, controla a manipulação dos dados
+          * Repositório de dados, controla a manipulação dos dados.
          */
         "dataUnit"?: DataUnit;
         /**
-          * Armazena as propriedades do campo
+          * Armazena as propriedades do campo.
          */
         "fieldConfig"?: IFieldConfig;
         /**
@@ -924,11 +1091,11 @@ declare namespace LocalJSX {
          */
         "isConfigActive"?: Boolean;
         /**
-          * Define se o componente está em modo de inserção
+          * Define se o componente está em modo de inserção.
          */
         "modeInsertion"?: boolean;
         /**
-          * Evento disparado ao pressionar button icon(onEzClickIcon)
+          * Emitido ao clicar no ícone do botão.
          */
         "onEzClickIcon"?: (event: SnkFieldConfigCustomEvent<Object>) => void;
     }
@@ -942,94 +1109,205 @@ declare namespace LocalJSX {
          */
         "dataUnit"?: DataUnit;
         /**
-          * Lista de todos os filtros disponíveis ao usuário.
+          * Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig"?: Array<SnkFilterItemConfig>;
     }
     interface SnkFilterBinarySelect {
+        /**
+          * Define as configurações do componente snk-filter-binary-select
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Define o valor do componente snk-filter-binary-select
+         */
         "value"?: any;
     }
     interface SnkFilterDetail {
+        /**
+          * Define as configurações do componente snk-filter-detail.
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage"?: (key: string, props?: any) => string;
+        /**
+          * Emitido quando há uma alteração nos filtros.
+         */
         "onFilterChange"?: (event: SnkFilterDetailCustomEvent<SnkFilterItemConfig>) => void;
     }
     interface SnkFilterItem {
+        /**
+          * Define as configurações do componente snk-filter-item.
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage"?: (key: string, props?: any) => string;
+        /**
+          * Emitido quando há uma alteração nos filtros.
+         */
         "onFilterChange"?: (event: SnkFilterItemCustomEvent<SnkFilterItemConfig>) => void;
         /**
-          * Disparado quando o detalhe de um item da lista é aberto ou fechado.
+          * Emitido quando o detalhe de um item da lista é aberto ou fechado.
          */
         "onVisibleChanged"?: (event: SnkFilterItemCustomEvent<boolean>) => void;
     }
     interface SnkFilterList {
+        /**
+          * Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado).
+         */
         "buttonClass"?: string;
+        /**
+          * Define o texto exibido quando a lista está vazia.
+         */
         "emptyText"?: string;
+        /**
+          * Define o texto exibido no componente de busca.
+         */
         "findFilterText"?: string;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage"?: (key: string, props?: any) => string;
+        /**
+          * Define o ícone usado no ez-button do filtro.
+         */
         "iconName"?: string;
+        /**
+          * Guarda a lista de filtros.
+         */
         "items"?: Array<ListItem>;
+        /**
+          * Define o label usado no ez-button do filtro.
+         */
         "label"?: string;
+        /**
+          * Disparado quando um item da lista é clicado.
+         */
         "onSnkItemSelected"?: (event: SnkFilterListCustomEvent<string>) => void;
     }
     interface SnkFilterModal {
+        /**
+          * Define o label do botão de cancelar.
+         */
         "cancelButtonLabel"?: string;
+        /**
+          * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+         */
         "getMessage"?: (key: string, props?: any) => string;
+        /**
+          * Define a descrição do filtro.
+         */
         "infoText"?: string;
+        /**
+          * Guarda a lista de filtros.
+         */
         "items"?: Array<ModalItem>;
+        /**
+          * Define o subtítulo do filtro.
+         */
         "modalSubTitle"?: string;
+        /**
+          * Define o título do filtro.
+         */
         "modalTitle"?: string;
+        /**
+          * Define o label do botão de confirmar.
+         */
         "okButtonLabel"?: string;
+        /**
+          * É disparado em qualquer interação com o filtro.
+         */
         "processModalAction"?: (action: ModalAction) => void;
+        /**
+          * Se `true`, exibe a barra de pesquisa do filtro.
+         */
         "useSearch"?: boolean;
     }
     interface SnkFilterMultiSelect {
+        /**
+          * Define as configurações do componente snk-filter-multi-select
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Define o valor do componente snk-filter-multi-select
+         */
         "value"?: any;
     }
     interface SnkFilterNumber {
+        /**
+          * Define as configurações do componente snk-filter-number
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Define o valor do componente snk-filter-number
+         */
         "value"?: number;
     }
     interface SnkFilterPeriod {
+        /**
+          * Define as configurações do componente snk-filter-period
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Define o valor do componente snk-filter-period
+         */
         "value"?: any;
     }
     interface SnkFilterPersonalized {
+        /**
+          * Define as configurações do componente snk-filter-personalized
+         */
         "config"?: SnkFilterItemConfig;
         "fix"?: ()=>void;
         "unfix"?: ()=>void;
+        /**
+          * Define o valor do componente snk-filter-personalized
+         */
         "value"?: Array<IOption|boolean|string|number|Date>;
     }
     interface SnkFilterSearch {
+        /**
+          * Define as configurações do componente snk-filter-search
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Define o valor do componente snk-filter-search
+         */
         "value"?: IOption;
     }
     interface SnkFilterText {
+        /**
+          * Define as configurações do componente snk-filter-text.
+         */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Define o valor do componente snk-filter-text.
+         */
         "value"?: string;
     }
     interface SnkForm {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções"
+          * Define a lista de ações que devem ser usadas no botão "Mais opções" do snk-taskbar.
          */
         "actionsList"?: Array<Action>;
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário
+          * Nome usado para guardar/recuperar as configurações do formulário.
          */
         "configName"?: string;
         /**
-          * Emitido sempre que houver click de botão ou ação
+          * Emitido sempre que houver click de botão ou ação.
          */
         "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
         /**
-          * Emitido quando o botão de voltar é acionado
+          * Emitido quando o botão de voltar é acionado.
          */
         "onExit"?: (event: SnkFormCustomEvent<void>) => void;
         /**
-          * Validador responsável por checar a integridade das informações do registro
+          * Validador responsável por checar a integridade das informações do registro.
          */
         "recordsValidator"?: IRecordValidator;
         /**
@@ -1039,11 +1317,11 @@ declare namespace LocalJSX {
     }
     interface SnkFormConfig {
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário.
+          * Nome usado para guardar ou recuperar as configurações do formulário.
          */
         "configName"?: string;
         /**
-          * Repositório de dados, controla a manipulação dos dados
+          * Repositório de dados, controla a manipulação dos dados.
          */
         "dataUnit"?: DataUnit;
         /**
@@ -1051,37 +1329,37 @@ declare namespace LocalJSX {
          */
         "formConfig"?: IFormConfig;
         /**
-          * Evento disparado ao salvar as configurações.
+          * Emitido ao salvar as configurações.
          */
         "onConfigChange"?: (event: SnkFormConfigCustomEvent<IFormConfig>) => void;
         /**
-          * Evento disparado ao fechar as configurações.
+          * Emitido ao fechar as configurações.
          */
         "onConfigClose"?: (event: SnkFormConfigCustomEvent<void>) => void;
     }
     interface SnkGrid {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções"
+          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList"?: Array<Action>;
         /**
-          * Nome usado para salvar/recuperar a configuração
+          * Nome usado para salvar/recuperar a configuração.
          */
         "configName"?: string;
         /**
-          * Determina se pode haver mais de uma linha selecionada
+          * Determina se pode haver mais de uma linha selecionada.
          */
         "multipleSelection"?: boolean;
         /**
-          * Emitido sempre que houver click de botão ou ação
+          * Emitido sempre que houver click de botão ou ação.
          */
         "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
         /**
-          * Emitido sempre que houver duplo click na grade
+          * Emitido sempre que houver duplo click na grade.
          */
         "onGridDoubleClick"?: (event: SnkGridCustomEvent<void>) => void;
         /**
-          * Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
+          * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
          */
         "statusResolver"?: IStatusResolver;
         /**
@@ -1099,11 +1377,11 @@ declare namespace LocalJSX {
          */
         "config"?: IGridConfig;
         /**
-          * Evento disparado ao cancelar a alteração das configurações.
+          * Emitido ao cancelar a alteração das configurações.
          */
         "onConfigCancel"?: (event: SnkGridConfigCustomEvent<void>) => void;
         /**
-          * Evento disparado ao salvar a alteração das configurações.
+          * Emitido ao salvar a alteração das configurações.
          */
         "onConfigChange"?: (event: SnkGridConfigCustomEvent<IGridConfig>) => void;
         /**
@@ -1112,37 +1390,52 @@ declare namespace LocalJSX {
         "selectedIndex"?: number;
     }
     interface SnkPesquisa {
+        /**
+          * Argumentos que serão usados ao chamar a função searchLoader.
+         */
         "argument"?: string;
-        "searchLoader"?: Function;
-        "selectItem"?: Function;
+        /**
+          * Função responsável em carregar os itens do componente snk-pesquisa.
+         */
+        "searchLoader"?: (text: string) => Promise<any>;
+        /**
+          * Função disparada ao selecionar um item.
+         */
+        "selectItem"?: (option: IOption) => void;
     }
     interface SnkSelectBox {
+        /**
+          * Emitido ao alterar a seleção do componente snk-select-box.
+         */
         "onEzChange"?: (event: SnkSelectBoxCustomEvent<string>) => void;
+        /**
+          * Determina a opção selecionada.
+         */
         "selectedOption"?: IOption | string;
     }
     interface SnkTabConfig {
         /**
-          * Evento emitido ao ocultar uma aba.
+          * Emitido ao ocultar uma aba.
          */
         "onCanStartDrag"?: (event: SnkTabConfigCustomEvent<any>) => void;
         /**
-          * Evento emitido ao deletar uma aba.
+          * Emitido ao deletar uma aba.
          */
         "onDeleteTab"?: (event: SnkTabConfigCustomEvent<any>) => void;
         /**
-          * Evento emitido ao salvar uma alteração realizada no título da tab
+          * Emitido ao salvar uma alteração realizada no título da tab.
          */
         "onEditionTitleTab"?: (event: SnkTabConfigCustomEvent<any>) => void;
         /**
-          * Evento emitido ao mover a aba mudando a sua ordem.
+          * Emitido ao mover a ordem da aba.
          */
         "onEzOrderChange"?: (event: SnkTabConfigCustomEvent<number>) => void;
         /**
-          * Evento emitido ao clicar para abrir o popup (ezTabChange). O detail desse evento carrega tanto o tabKey quanto o index da aba selecionada.
+          * Emitido ao clicar para abrir o popup.
          */
         "onEzTabChange"?: (event: SnkTabConfigCustomEvent<ITab>) => void;
         /**
-          * Evento emitido ao ocultar uma aba.
+          * Emitido ao ocultar uma aba.
          */
         "onHideTab"?: (event: SnkTabConfigCustomEvent<any>) => void;
         /**
@@ -1154,21 +1447,21 @@ declare namespace LocalJSX {
          */
         "selectedTab"?: string;
         /**
-          * Define o nome das abas do componente, separadas por vírgulas ",".
+          * Define o nome das abas do componente separadas por vírgulas ",".
          */
         "tabs"?: string;
     }
     interface SnkTaskbar {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções"
+          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList"?: Array<Action>;
         /**
-          * Lista separada por virgula, contendo todos os elementos a serem criados
+          * Lista separada por virgula, contendo todos os elementos a serem criados.
          */
         "buttons"?: string;
         /**
-          * Nome usado para guardar/recuperar as configurações do formulário
+          * Usado para guardar ou recuperar as configurações do formulário.
          */
         "configName"?: string;
         /**
@@ -1176,23 +1469,23 @@ declare namespace LocalJSX {
          */
         "customButtons"?: Map<string, CustomButton>;
         /**
-          * Instância do DataUnit
+          * Instância do DataUnit.
          */
         "dataUnit"?: DataUnit;
         /**
-          * Array contendo todos os botões a serem desabilitados
+          * Array contendo todos os botões a serem desabilitados.
          */
         "disabledButtons"?: Array<string>;
         /**
-          * Emitido sempre que houver alteração em algum elemento aberto pelo botão de ação
+          * Emitido sempre que houver alteração em algum elemento aberto pelo botão de ação.
          */
         "onActionChange"?: (event: SnkTaskbarCustomEvent<any>) => void;
         /**
-          * Emitido sempre que houver click de botão ou ação
+          * Emitido sempre que houver click de botão ou ação.
          */
         "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
         /**
-          * Qual botão deve ter aparência primária
+          * Determina qual botão deve ter aparência primária.
          */
         "primaryButton"?: string;
     }