@sankhyalabs/sankhyablocks 2.4.0 → 2.4.2

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

@@ -45,8 +45,7 @@ export declare class SnkApplication {
   private get auth();
   private _element;
   /**
-   * 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;
   /**
@@ -54,45 +53,51 @@ export declare class SnkApplication {
   */
   configName: string;
   /**
-   * Caso o usuário logado seja o SUP.
+   * Obtém `true` caso o usuário logado seja o SUP.
    */
   isUserSup(): Promise<boolean>;
   /**
-   * 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>;
   /**
-   * Retorna todos os acessos do usuário logado.
+   * Obtém todos os acessos do usuário logado.
    */
   getAllAccess(): Promise<any>;
   /**
-   * 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 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 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 booleano.
+   * Obtém o valor de um parâmetro do tipo booleano.
    */
   getBooleanParam(name: string): Promise<boolean>;
   /**
-   * 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>;
   /**
-   * 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>;
+  /**
+   * Exibe o conteúdo passado em um Modal.
+   */
   showModal(content: HTMLElement): Promise<void>;
+  /**
+   * 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>;
   /**
@@ -100,7 +105,7 @@ export declare class SnkApplication {
    */
   temOpcional(opcional: 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>;
   /**
@@ -108,17 +113,17 @@ export declare class SnkApplication {
    */
   saveConfig(key: string, data: Object): 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>;
   /**
-   * Abre determinada tela, repassando pkObject
+   * Abre determinada tela, repassando pkObject.
    */
   openApp(resourceId: string, pkObject: Object): Promise<void>;
   private getDuPromissesStack;
   /**
    * 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
+   * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
    */
   createDataunit(entityName: string, dataUnitName?: string): Promise<DataUnit>;
   /**
@@ -126,23 +131,23 @@ export declare class SnkApplication {
    */
   getDataUnit(entityName: string, dataUnitName: string): Promise<DataUnit>;
   /**
-   * Retorna o resourceID da tela em questão.
+   * Obtém o resourceID da tela em questão.
    */
   getResourceID(): Promise<string>;
   /**
-   * Retorna o resourceID da tela em questão.
+   * Obtém o UserId da tela em questão.
    */
   getUserID(): Promise<string>;
   /**
-   * 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>;
   /**
-   * 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>;
   /**
-   * 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>;
   /**
@@ -154,31 +159,31 @@ export declare class SnkApplication {
    */
   confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions): 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>;
   /**
-   * 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 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>>;
   /**
-   * 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 a configuração padrão de formulário.
+   * Obtém a configuração padrão de formulário.
    */
   fetchDefaultConfig(name: string): Promise<IFormConfig>;
   /**
-   * Busca os totalizadores da grade.
+   * Obtém os totalizadores da grade.
    */
   loadTotals(name: string, resourceID: string, filters: Array<Filter>): Promise<Map<string, number>>;
   /**
@@ -198,19 +203,19 @@ export declare class SnkApplication {
    */
   saveFormConfig(config: IFormConfig, name: string): Promise<boolean>;
   /**
-   * Busca um objeto com um conjunto de valores padrão.
+   * Obtém um objeto com um conjunto de valores padrão.
    */
   getDefaultValues(): Promise<string>;
   /**
-   * 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>;
   /**
-   * Evento disparado quando a aplicação for carregada.
+   * Emitido quando a aplicação for carregada.
    */
   applicationLoaded: EventEmitter<boolean>;
   /**
-   * Evento disparado ao iniciar a carga do componente
+   * Emitido ao iniciar a carga do componente.
    */
   applicationLoading: EventEmitter<boolean>;
   private getAuthList;
@@ -223,8 +228,19 @@ export declare class SnkApplication {
   private get authFetcher();
   private get filterBarConfigFetcher();
   private get defaultValuesFetcher();
+  /**
+   * Obtém as opções em componentes de pesquisa
+   * Ex.: snk-config-options
+   */
   executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit): Promise<Array<IOption> | IOption>;
+  /**
+   * 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 `true` caso a tela esteja em modo de debug.
+   */
   isDebugMode(): Promise<boolean>;
   private clearContent;
   private clearPopUpTitle;

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

@@ -8,7 +8,7 @@ export declare class SnkConfigurator {
   _opened: boolean;
   _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;
   /**
@@ -16,14 +16,20 @@ export declare class SnkConfigurator {
    */
   viewMode: string;
   /**
-   * Evento disparado quando seleciona modo de visualização
+   * Emitido quando seleciona o modo de visualização.
    */
   configSelected: EventEmitter<string>;
   /**
-   * Evento disparado quando clicar para abrir uma configuração
+   * Emitido quando clica para abrir a configuração.
    */
   openConfig: EventEmitter<string>;
+  /**
+   * Exibe a janela de configuração.
+   */
   open(): Promise<void>;
+  /**
+   * Fecha a janela de configuração.
+   */
   close(): Promise<void>;
   private closeConfig;
   private onViewModeChanged;

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

@@ -20,7 +20,7 @@ export declare class SnkCrud {
    */
   configName: string;
   /**
-   * 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>;
   /**
@@ -29,7 +29,7 @@ export declare class SnkCrud {
   */
   taskbarManager: TaskbarManager;
   /**
-  * 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;
   /**
@@ -38,11 +38,11 @@ export declare class SnkCrud {
    */
   statusResolver: IStatusResolver;
   /**
-   * 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.
    */
   actionClick: EventEmitter<string>;
   /**

package/dist/types/components/snk-data-unit/snk-data-unit.d.ts

@@ -7,24 +7,24 @@ export declare class SnkDataUnit implements DUActionInterceptor {
   _permissions: any;
   element: HTMLSnkDataUnitElement;
   /**
-   * O estato atual dos dados, isto é se há alteração, insersão, as linhas selecionadas, etc.
+   * Controla o estado atual dos dados.
    */
   dataState: DataState;
   /**
-   * 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;
   /**
-   * Determina quantas linhas são retornadas por página
+   * Determina quantas linhas são retornadas por página.
    */
   pageSize: number;
   /**
-   * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade
+   * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
    */
   dataUnit: DataUnit;
   /**
@@ -33,7 +33,7 @@ export declare class SnkDataUnit implements DUActionInterceptor {
    */
   beforeSave: (dataUnit: DataUnit) => boolean | Promise<boolean>;
   /**
-   * Executado após a ação de salvar
+   * Executado após a ação de salvar.
    */
   afterSave: (dataUnit: DataUnit) => void;
   observePageSize(): void;
@@ -42,25 +42,23 @@ export declare class SnkDataUnit implements DUActionInterceptor {
   observeDataState(newValue: DataState, oldValue: DataState): void;
   observeDataUnit(): void;
   /**
-   * Disparado quando o há qualquer mudança de estado no DataUnit
+   * Emitido quando há qualquer mudança de estado no DataUnit.
    */
   dataStateChange: EventEmitter<DataState>;
   /**
-   * Disparado quando o DataUnit está pronto
+   * Emitido quando o DataUnit está pronto.
    */
   dataUnitReady: EventEmitter<DataUnit>;
   /**
-   * Disparado quando um registro é adicionado ou copiado
+   * Emitido quando um registro é adicionado ou copiado.
    */
   insertionMode: EventEmitter<void>;
   /**
-   * Disparado quando se cancela uma insersão/cópia
+   * Emitido quando se cancela uma inserção ou cópia.
    */
   cancelEdition: EventEmitter<void>;
   /**
-   * 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>;
   interceptAction(action: DataUnitAction): Promise<DataUnitAction>;

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.d.ts

@@ -3,13 +3,25 @@ export declare class SnkFilterBinarySelect {
   _element: HTMLElement;
   _checkOne: HTMLEzCheckElement;
   _checkTwo: HTMLEzCheckElement;
+  /**
+   * Define o valor do componente snk-filter-binary-select
+   */
   value: any;
+  /**
+   * Define as configurações do componente snk-filter-binary-select
+   */
   config: SnkFilterItemConfig;
   isSelected(option: string): boolean;
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-binary-select
+   */
   ezChangeListener(evt: CustomEvent): void;
   componentDidLoad(): void;
   assertCheckedOption(updatingCheck: HTMLElement): void;
   updateValue(): void;
+  /**
+   * Exibe o componente snk-filter-binary-select
+   */
   show(): Promise<void>;
   render(): any;
 }

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.d.ts

@@ -2,9 +2,21 @@ import { SnkFilterItemConfig } from '../snk-filter-item';
 export declare class SnkFilterMultiSelect {
   _element: HTMLElement;
   _comboElement: HTMLEzComboBoxElement;
+  /**
+   * Define o valor do componente snk-filter-multi-select
+   */
   value: any;
+  /**
+   * Define as configurações do componente snk-filter-multi-select
+   */
   config: SnkFilterItemConfig;
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-multi-select
+   */
   ezChangeListener(evt: CustomEvent): void;
+  /**
+   * Exibe o componente snk-filter-multi-select
+   */
   show(): Promise<void>;
   componentDidLoad(): void;
   render(): any;

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

@@ -2,9 +2,21 @@ import { SnkFilterItemConfig } from '../snk-filter-item';
 export declare class SnkFilterPeriod {
   _element: HTMLElement;
   _numberElement: HTMLEzNumberInputElement;
+  /**
+   * Define as configurações do componente snk-filter-number
+   */
   config: SnkFilterItemConfig;
+  /**
+   * Define o valor do componente snk-filter-number
+   */
   value: number;
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-number
+   */
   ezChangeListener(evt: CustomEvent): void;
+  /**
+   * Exibe o componente snk-filter-number
+   */
   show(): Promise<void>;
   componentDidLoad(): void;
   render(): any;

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

@@ -3,11 +3,23 @@ export declare class SnkFilterPeriod {
   _element: HTMLElement;
   _startDate: HTMLEzDateInputElement;
   _endDate: HTMLEzDateInputElement;
+  /**
+   * Define as configurações do componente snk-filter-period
+   */
   config: SnkFilterItemConfig;
+  /**
+   * Define o valor do componente snk-filter-period
+   */
   value: any;
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-period
+   */
   ezChangeListener(): void;
   componentDidLoad(): void;
   getDate(prop: string): Date;
+  /**
+   * Exibe o componente snk-filter-period
+   */
   show(): Promise<void>;
   render(): any;
 }

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

@@ -3,7 +3,13 @@ import { IOption } from '@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez
 import { SnkFilterItemConfig } from '../snk-filter-item';
 export declare class SnkFilterPersonalized {
   _element: HTMLElement;
+  /**
+   * Define as configurações do componente snk-filter-personalized
+   */
   config: SnkFilterItemConfig;
+  /**
+   * Define o valor do componente snk-filter-personalized
+   */
   value: Array<IOption | boolean | string | number | Date>;
   fix: () => void;
   unfix: () => void;
@@ -12,6 +18,9 @@ export declare class SnkFilterPersonalized {
   setValue(index: number, value: IOption | boolean | string | number | Date): void;
   doSearch(mode: string, argument: string, param: FilterParameter): Promise<Array<IOption> | IOption>;
   getParamsInterface(): any[];
+  /**
+   * Exibe o componente snk-filter-personalized
+   */
   show(): Promise<void>;
   render(): any;
 }

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

@@ -2,12 +2,24 @@ import { IOption } from '@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez
 import { SnkFilterItemConfig } from '../snk-filter-item';
 export declare class SnkFilterSearch {
   _element: HTMLElement;
+  /**
+   * Define as configurações do componente snk-filter-search
+   */
   config: SnkFilterItemConfig;
+  /**
+   * Define o valor do componente snk-filter-search
+   */
   value: IOption;
   _searchInput: HTMLEzSearchElement;
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-search
+   */
   ezChangeListener(_evt: CustomEvent): void;
   componentDidLoad(): void;
   doSearch(mode: string, argument: string): Promise<Array<IOption> | IOption>;
+  /**
+   * Exibe o componente snk-filter-search
+   */
   show(): Promise<void>;
   render(): any;
 }

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

@@ -2,8 +2,17 @@ import { SnkFilterItemConfig } from '../snk-filter-item';
 export declare class SnkFilterText {
   _element: HTMLElement;
   _textInputElement: HTMLEzTextInputElement;
+  /**
+   * Define as configurações do componente snk-filter-text.
+   */
   config: SnkFilterItemConfig;
+  /**
+   * Define o valor do componente snk-filter-text.
+   */
   value: string;
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-text.
+   */
   ezChangeListener(evt: CustomEvent): void;
   componentDidLoad(): void;
   render(): any;

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

@@ -6,9 +6,21 @@ export declare class SnkFilterDetail {
   _editor: HTMLElement;
   _applyButton: HTMLEzButtonElement;
   _idContentEditor: string;
+  /**
+   * 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.
+   */
   filterChange: EventEmitter<SnkFilterItemConfig>;
+  /**
+   * Exibe o componente snk-filter-detail.
+   */
   show(): Promise<void>;
   componentDidLoad(): void;
   changeConfig(newConfig: SnkFilterItemConfig): void;

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

@@ -12,16 +12,31 @@ export declare class SnkFilterItem {
   _idSnkFilterDetail: string;
   _idEzChip: string;
   detailIsVisible: boolean;
+  /**
+   * 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;
   /**
-   * Disparado quando o detalhe de um item da lista é aberto ou fechado.
+   * Emitido quando o detalhe de um item da lista é aberto ou fechado.
    */
   visibleChanged: EventEmitter<boolean>;
+  /**
+   * Emitido quando há uma alteração nos filtros.
+   */
+  filterChange: EventEmitter<SnkFilterItemConfig>;
   observeDetailIsVisible(value: boolean): void;
+  /**
+   * Exibe os detalhes de um item da lista.
+   */
   showUp(open?: boolean): Promise<void>;
-  filterChange: EventEmitter<SnkFilterItemConfig>;
   private getScrollOffset;
+  /**
+   * Oculta os detalhes de um item da lista.
+   */
   hideDetail(): Promise<void>;
   onDetailCloseCallback(): void;
   innerClickCheck: (_floatingContainer: HTMLElement, node: HTMLElement) => boolean;
@@ -30,6 +45,9 @@ export declare class SnkFilterItem {
   getLabel(): any;
   componentDidLoad(): void;
   componentDidRender(): void;
+  /**
+   * Emitido quando o estado do filtro é alterado.
+   */
   filterChangeListener(): void;
   getRightIconName(): "close" | "chevron-up" | "chevron-down";
   getLeftIconName(): "calendar" | "tune";

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

@@ -11,16 +11,43 @@ export declare class SnkFilterList {
   _preselection: number;
   _filterArgument: string;
   _showAll: boolean;
+  /**
+   * Define o label usado no ez-button do filtro.
+   */
   label: string;
+  /**
+   * Define o ícone usado no ez-button do filtro.
+   */
   iconName: string;
+  /**
+   * Guarda a lista de filtros.
+   */
   items: Array<ListItem>;
+  /**
+   * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+   */
   getMessage: (key: string, props?: any) => string;
+  /**
+   * Define o texto exibido quando a lista está vazia.
+   */
   emptyText: string;
+  /**
+   * Define o texto exibido no componente de busca.
+   */
   findFilterText: string;
+  /**
+   * Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado).
+   */
   buttonClass: string;
+  /**
+   *  Disparado quando um item da lista é clicado.
+   */
   snkItemSelected: EventEmitter<string>;
   private showDetail;
   innerClickCheck: (_floatingContainer: HTMLElement, node: HTMLElement) => boolean;
+  /**
+   * Oculta os detalhes do componente snk-filter-list.
+   */
   hideDetail(): Promise<void>;
   private onListCloseCallback;
   private buttonClick;

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

@@ -1,15 +1,42 @@
 import { ModalAction } from "@sankhyalabs/ezui/dist/collection/components/ez-modal-container";
 export declare class SnkFilterModal {
   _filterInput: HTMLEzFilterInputElement;
+  _filterArgument: string;
+  /**
+   * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+   */
   getMessage: (key: string, props?: any) => string;
+  /**
+   * Guarda a lista de filtros.
+   */
   items: Array<ModalItem>;
-  _filterArgument: string;
+  /**
+   * Define o título do filtro.
+   */
   modalTitle: string;
+  /**
+   * Define o subtítulo do filtro.
+   */
   modalSubTitle: string;
+  /**
+   * Define o label do botão de cancelar.
+   */
   cancelButtonLabel: string;
+  /**
+   * Define o label do botão de confirmar.
+   */
   okButtonLabel: string;
+  /**
+   * Define a descrição do filtro.
+   */
   infoText: string;
+  /**
+   * Se `true`, exibe a barra de pesquisa do filtro.
+   */
   useSearch: boolean;
+  /**
+   * É disparado em qualquer interação com o filtro.
+   */
   processModalAction: (action: ModalAction) => void;
   updateValue(id: string, value?: boolean): void;
   getActiveFiltersMsg(): string;