@sankhyalabs/sankhyablocks 2.4.0 → 2.4.1

package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts

@@ -25,7 +25,7 @@ export declare class SnkFilterBar implements FilterProvider {
    */
   configName: string;
   /**
-   * Lista de todos os filtros disponíveis ao usuário.
+   * Lista todos os filtros disponíveis ao usuário.
    */
   filterConfig: Array<SnkFilterItemConfig>;
   allowDefault: boolean;
@@ -60,6 +60,9 @@ export declare class SnkFilterBar implements FilterProvider {
   private loadPermitions;
   private loadConfigFromApplication;
   private attachDataUnit;
+  /**
+  * Emitido quando acontece a alteração do estado do filtro.
+  */
   filterChangeListener(evt: CustomEvent): void;
   private addFilterHandler;
   private appliedFilterHandler;

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

@@ -15,15 +15,15 @@ export declare class SnkForm {
   _insertionFormConfig: IFormConfig;
   _showFormConfig: boolean;
   /**
-   * Nome usado para guardar/recuperar as configurações do formulário
+   * Nome usado para guardar/recuperar as configurações do formulário.
    */
   configName: string;
   /**
-   * 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;
   /**
-   * 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>;
   /**
@@ -32,19 +32,19 @@ export declare class SnkForm {
   */
   taskbarManager: TaskbarManager;
   /**
-   * Emitido quando o botão de voltar é acionado
+   * Emitido quando o botão de voltar é acionado.
    */
   exit: EventEmitter<void>;
   /**
-   * Emitido sempre que houver click de botão ou ação
+   * Emitido sempre que houver click de botão ou ação.
    */
   actionClick: EventEmitter<string>;
   /**
-   * 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>;
   /**
-   * 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>;
   private loadConfig;

package/dist/types/components/snk-form/subcomponents/snk-config-options/snk-config-options.d.ts

@@ -7,19 +7,19 @@ export declare class SnkConfigOptions {
   _element: HTMLSnkConfigOptionsElement;
   private _defaultType;
   /**
-   * 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;
   /**
-   * 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;
   /**
-   * Evento disparado ao realizar alguma alteração nos campos
+   * Emitido ao realizar alguma alteração nos campos.
    */
   configOptionsChanged: EventEmitter<any>;
   private onConfigDefault;

package/dist/types/components/snk-form/subcomponents/snk-field-config/snk-field-config.d.ts

@@ -10,19 +10,19 @@ export declare class SnkFieldConfig {
    */
   isConfigActive: Boolean;
   /**
-   * Armazena as propriedades do campo
+   * Armazena as propriedades do campo.
    */
   fieldConfig: IFieldConfig;
   /**
-   * Define se o componente está em modo de inserção
+   * Define se o componente está em modo de inserção.
    */
   modeInsertion: boolean;
   /**
-   * Repositório de dados, controla a manipulação dos dados
+   * Repositório de dados, controla a manipulação dos dados.
    */
   dataUnit: DataUnit;
   /**
-   * Evento disparado ao pressionar button icon(onEzClickIcon)
+   * Emitido ao clicar no ícone do botão.
    */
   ezClickIcon: EventEmitter<Object>;
   handleAction(evt: MouseEvent, type: string): void;
@@ -30,7 +30,7 @@ export declare class SnkFieldConfig {
    * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
    * através de um pequeno modulo na estrutura da aplicação:
    * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
-   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-form.msg.ts"
+   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-form.msg.ts".
    */
   private getMessage;
   private isRequired;

package/dist/types/components/snk-form/subcomponents/snk-form-config/snk-form-config.d.ts

@@ -33,7 +33,7 @@ export declare class SnkFormConfig {
   private _optionFormConfigChanged;
   private _tempGroups;
   /**
-   * Repositório de dados, controla a manipulação dos dados
+   * Repositório de dados, controla a manipulação dos dados.
    */
   dataUnit: DataUnit;
   /**
@@ -41,15 +41,15 @@ export declare class SnkFormConfig {
    */
   formConfig: IFormConfig;
   /**
-   * 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;
   /**
-   * Evento disparado ao salvar as configurações.
+   * Emitido ao salvar as configurações.
    */
   configChange: EventEmitter<IFormConfig>;
   /**
-   * Evento disparado ao fechar as configurações.
+   * Emitido ao fechar as configurações.
    */
   configClose: EventEmitter<void>;
   observeFormConfig(): void;

package/dist/types/components/snk-form/subcomponents/snk-tab-config/snk-tab-config.d.ts

@@ -26,33 +26,31 @@ export declare class SnkTabConfig {
    */
   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;
   /**
-* 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.
+  */
   ezTabChange: EventEmitter<ITab>;
   /**
-  * 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.
   */
   editionTitleTab: EventEmitter<any>;
   /**
-  * Evento emitido ao deletar uma aba.
+  * Emitido ao deletar uma aba.
   */
   deleteTab: EventEmitter<any>;
   /**
-   * Evento emitido ao ocultar uma aba.
+   * Emitido ao ocultar uma aba.
    */
   hideTab: EventEmitter<any>;
   /**
-  * Evento emitido ao mover a aba mudando a sua ordem.
+  * Emitido ao mover a ordem da aba.
   */
   ezOrderChange: EventEmitter<number>;
   /**
-   * Evento emitido ao ocultar uma aba.
+   * Emitido ao ocultar uma aba.
    */
   canStartDrag: EventEmitter<any>;
   /**

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

@@ -16,11 +16,11 @@ export declare class SnkGrid {
   _gridConfig: IGridConfig;
   _popUpGridConfig: boolean;
   /**
-   * Nome usado para salvar/recuperar a configuração
+   * Nome usado para salvar/recuperar a configuração.
    */
   configName: string;
   /**
-   * 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>;
   /**
@@ -30,31 +30,31 @@ export declare class SnkGrid {
   taskbarManager: TaskbarManager;
   /**
    * Configuração do valor da coluna de status.
-   * Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
+   * Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
    */
   statusResolver: IStatusResolver;
   /**
-   * 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.
    */
   actionClick: EventEmitter<string>;
   /**
-  * Emitido sempre que houver duplo click na grade
+  * Emitido sempre que houver duplo click na grade.
   */
   gridDoubleClick: EventEmitter<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>;
   /**
-   * Método responsável em fechar o modal de configurações da grade.
+   * Fecha a janela de configurações da grade.
    */
   hideConfig(): Promise<void>;
   /**
-   * Método responsável por setar as configurações da grade.
+   * Atribui o valor da configuração da grade.
    */
   setConfig(config: IGridConfig): Promise<void>;
   private openGridConfig;

package/dist/types/components/snk-grid/subcomponents/snk-grid-config/snk-grid-config.d.ts

@@ -27,13 +27,16 @@ export declare class EzGridConfig {
    */
   config: IGridConfig;
   /**
-   * Evento disparado ao salvar a alteração das configurações.
+   * Emitido ao salvar a alteração das configurações.
    */
   configChange: EventEmitter<IGridConfig>;
   /**
-   * Evento disparado ao cancelar a alteração das configurações.
+   * Emitido ao cancelar a alteração das configurações.
    */
   configCancel: EventEmitter<void>;
+  /**
+   * Salva as configurações da grade.
+   */
   saveConfig(config: IGridConfig): Promise<void>;
   /**
    * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção

package/dist/types/components/snk-grid/subcomponents/snk-select-box/snk-select-box.d.ts

@@ -1,7 +1,13 @@
 import { IOption } from '@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez-combo-box';
 import { EventEmitter } from '../../../../stencil-public-runtime';
 export declare class SelectBox {
+  /**
+   * Emitido ao alterar a seleção do componente snk-select-box.
+   */
   ezChange: EventEmitter<string>;
+  /**
+   * Determina a opção selecionada.
+   */
   selectedOption: IOption | string;
   render(): any;
 }

package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts

@@ -1,3 +1,4 @@
+import { IOption } from '@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez-combo-box';
 export declare class SnkPesquisa {
   private _textInput;
   private _mdByName;
@@ -12,8 +13,17 @@ export declare class SnkPesquisa {
   private _element;
   private _itemList;
   private _startLoading;
-  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;
+  /**
+   * Argumentos que serão usados ao chamar a função searchLoader.
+   */
   argument: string;
   observeArgument(): void;
   private clearSearch;

package/dist/types/components/snk-taskbar/snk-taskbar.d.ts

@@ -9,11 +9,11 @@ export declare class SnkTaskbar {
   private _element;
   _permissions: any;
   /**
-   * Nome usado para guardar/recuperar as configurações do formulário
+   * Usado para guardar ou recuperar as configurações do formulário.
    */
   configName: string;
   /**
-   * Lista separada por virgula, contendo todos os elementos a serem criados
+   * Lista separada por virgula, contendo todos os elementos a serem criados.
    */
   buttons: string;
   /**
@@ -22,27 +22,27 @@ export declare class SnkTaskbar {
    */
   customButtons: Map<string, CustomButton>;
   /**
-   * 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>;
   /**
-   * Qual botão deve ter aparência primária
+   * Determina qual botão deve ter aparência primária.
    */
   primaryButton: string;
   /**
-   * Array contendo todos os botões a serem desabilitados
+   * Array contendo todos os botões a serem desabilitados.
    */
   disabledButtons: Array<string>;
   /**
-   * Instância do DataUnit
+   * Instância do DataUnit.
    */
   dataUnit: DataUnit;
   /**
-   * Emitido sempre que houver click de botão ou ação
+   * Emitido sempre que houver click de botão ou ação.
    */
   actionClick: EventEmitter<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.
    */
   actionChange: EventEmitter<any>;
   _titleKeyByElement: {