@sankhyalabs/sankhyablocks-docs 9.2.0-ms.12 → 9.2.0-ms.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/components/snk-application/readme.md +26 -90
  2. package/components/snk-configurator/readme.md +1 -1
  3. package/components/snk-crud/readme.md +9 -9
  4. package/components/snk-crud/subcomponents/readme.md +4 -4
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -4
  6. package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
  7. package/components/snk-data-unit/readme.md +2 -10
  8. package/components/snk-filter-bar/filter-item/readme.md +1 -1
  9. package/components/snk-filter-bar/readme.md +24 -42
  10. package/components/snk-filter-field-search/readme.md +1 -1
  11. package/components/snk-form/readme.md +10 -20
  12. package/components/snk-grid/readme.md +50 -79
  13. package/components/snk-personalized-filter/readme.md +11 -11
  14. package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
  15. package/components/snk-simple-bar/readme.md +6 -6
  16. package/components/snk-simple-crud/readme.md +58 -60
  17. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
  18. package/components/snk-taskbar/readme.md +22 -22
  19. package/package.json +1 -1
package/components/snk-data-unit/readme.md CHANGED
@@ -33,7 +33,7 @@
33
33
  | `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
34
34
  | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
35
35
  | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
36
- | `messagesBuilderUpdated` | Emitido quando o messagesBuilder é atualizado. | `CustomEvent<SnkMessageBuilder>` |
36
+ | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
37
37
 
38
38
 
39
39
  ## Methods
@@ -46,9 +46,7 @@ Obtém o dataUnit.
46
46
 
47
47
  Type: `Promise<DataUnit>`
48
48
 
49
- Uma promessa que resolve com a instância do DataUnit.
50
49
 
51
- ---
52
50
 
53
51
  ### `getFieldsWithRmPrecision() => Promise<string[]>`
54
52
 
@@ -58,9 +56,7 @@ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precisi
58
56
 
59
57
  Type: `Promise<string[]>`
60
58
 
61
- Uma promessa que resolve com um array de nomes de campos.
62
59
 
63
- ---
64
60
 
65
61
  ### `getFieldsWithRmp() => Promise<string[]>`
66
62
 
@@ -70,9 +66,7 @@ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
70
66
 
71
67
  Type: `Promise<string[]>`
72
68
 
73
- Uma promessa que resolve com um array de nomes de campos.
74
69
 
75
- ---
76
70
 
77
71
  ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
78
72
 
@@ -82,9 +76,7 @@ Busca os metadados da linha selecionada.
82
76
 
83
77
  Type: `Promise<RowMetadata>`
84
78
 
85
- Uma promessa que resolve com os metadados da linha.
86
79
 
87
- ---
88
80
 
89
81
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
90
82
 
@@ -94,7 +86,7 @@ Método que retorna a lista de IDs dos registros selecionados.
94
86
 
95
87
  Type: `Promise<IRecordID[]>`
96
88
 
97
- Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
89
+ Retorna a lista de IDs dos registros selecionados.
98
90
 
99
91
 
100
92
  ## Dependencies
package/components/snk-filter-bar/filter-item/readme.md CHANGED
@@ -32,7 +32,7 @@ Oculta os detalhes de um item da lista.
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
- ---
35
+
36
36
 
37
37
  ### `showUp(open?: boolean) => Promise<void>`
38
38
 
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,21 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------ | ---------------------------------- | ----------- | ------------------------------------------------------------------------------------------ | ----------- |
12
- | `afterApplyConfig` | -- | | `() => void` | `undefined` |
13
- | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
14
- | `configName` | `config-name` | | `string` | `undefined` |
15
- | `customFilterBarConfig` | -- | | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
17
- | `disablePersonalizedFilter` | `disable-personalized-filter` | | `boolean` | `undefined` |
18
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
19
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | | `string` | `undefined` |
20
- | `filterConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
21
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
- | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
24
- | `title` | `title` | | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------ | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
12
+ | `afterApplyConfig` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
13
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
14
+ | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
15
+ | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
+ | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
17
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
18
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento | `boolean` | `false` |
19
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
20
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
21
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
25
25
 
26
26
 
27
27
  ## Events
@@ -35,81 +35,63 @@
35
35
 
36
36
  ### `addFilterItem(filterItem: SnkFilterItemConfig) => Promise<void>`
37
37
 
38
-
38
+ Adiciona um item de filtro.
39
39
 
40
40
  #### Returns
41
41
 
42
42
  Type: `Promise<void>`
43
43
 
44
- Retorna uma Promise que resolve quando o item for adicionado.
45
44
 
46
- ---
47
45
 
48
46
  ### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
49
47
 
50
-
48
+ Retorna um item de filtro pelo ID.
51
49
 
52
50
  #### Returns
53
51
 
54
52
  Type: `Promise<SnkFilterItemConfig>`
55
53
 
56
- O item de filtro correspondente ou undefined se não for encontrado.
57
-
58
- ---
59
-
60
- ### `getFilters() => Promise<Filter[]>`
61
-
62
-
63
-
64
- #### Returns
65
-
66
- Type: `Promise<Filter[]>`
67
54
 
68
- ---
69
55
 
70
56
  ### `reload() => Promise<void>`
71
57
 
72
-
58
+ Faz o recarregamento da filterbar buscando o state no servidor.
73
59
 
74
60
  #### Returns
75
61
 
76
62
  Type: `Promise<void>`
77
63
 
78
- Retorna uma Promise que resolve quando o recarregamento for concluído.
79
64
 
80
- ---
81
65
 
82
66
  ### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
83
67
 
84
-
68
+ Remove um item de filtro.
85
69
 
86
70
  #### Returns
87
71
 
88
72
  Type: `Promise<SnkFilterItemConfig>`
89
73
 
90
- Retorna o item de filtro removido, ou undefined caso não seja encontrado.
91
-
92
- ---
74
+ - Retorna o item de filtro removido, ou undefined caso não encontrado.
93
75
 
94
76
  ### `showFilterModal() => Promise<void>`
95
77
 
96
-
78
+ Abre o modal de filtros
97
79
 
98
80
  #### Returns
99
81
 
100
82
  Type: `Promise<void>`
101
83
 
102
- ---
103
84
 
104
- ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
105
85
 
86
+ ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
106
87
 
88
+ Atualiza um item do filtro.
107
89
 
108
90
  #### Returns
109
91
 
110
92
  Type: `Promise<void>`
111
93
 
112
- Retorna uma Promise que resolve quando a atualização for concluída.
94
+
113
95
 
114
96
 
115
97
  ## Dependencies
package/components/snk-filter-field-search/readme.md CHANGED
@@ -30,7 +30,7 @@ Filtra a fonte de dados do componente.
30
30
 
31
31
  Type: `Promise<void>`
32
32
 
33
- ---
33
+
34
34
 
35
35
  ### `show(element?: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
36
36
 
package/components/snk-form/readme.md CHANGED
@@ -10,7 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
12
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
16
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
@@ -18,24 +18,24 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
23
- | `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<string>` |
24
- | `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
25
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view | `CustomEvent<HTMLElement[]>` |
21
+ | Event | Description | Type |
22
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
23
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
24
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
25
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
26
26
 
27
27
 
28
28
  ## Methods
29
29
 
30
30
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
31
31
 
32
- Registra um editor customizado para campos do formulário.
32
+ Registra um editor customizado para campos da grade e formulário.
33
33
 
34
34
  #### Returns
35
35
 
36
36
  Type: `Promise<void>`
37
37
 
38
- ---
38
+
39
39
 
40
40
  ### `hideConfig() => Promise<void>`
41
41
 
@@ -45,7 +45,7 @@ Fecha a janela de configurações do formulário.
45
45
 
46
46
  Type: `Promise<void>`
47
47
 
48
- ---
48
+
49
49
 
50
50
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
51
51
 
@@ -55,7 +55,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
55
55
 
56
56
  Type: `Promise<void>`
57
57
 
58
- ---
58
+
59
59
 
60
60
  ### `showConfig() => Promise<void>`
61
61
 
@@ -65,16 +65,6 @@ Exibe a janela de configurações do formulário.
65
65
 
66
66
  Type: `Promise<void>`
67
67
 
68
- ---
69
-
70
- ### `validate() => Promise<void>`
71
-
72
- Valida o formulário.
73
-
74
- #### Returns
75
-
76
- Type: `Promise<void>`
77
-
78
68
 
79
69
 
80
70
 
package/components/snk-grid/readme.md CHANGED
@@ -7,103 +7,94 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
- | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Define se a grade receberá o foco automaticamente ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se os dados serão carregados automaticamente na inicialização do componente. | `boolean` | `undefined` |
15
- | `canEdit` | `can-edit` | Define se a edição de dados na grade está habilitada. | `boolean` | `true` |
16
- | `columnFilterDataSource` | -- | Define o data source para o filtro de colunas. | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
- | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto. | `boolean` | `undefined` |
18
- | `configName` | `config-name` | Nome usado para salvar e recuperar a configuração da grade. | `string` | `undefined` |
19
- | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). | `boolean` | `undefined` |
20
- | `enableGridInsert` | `enable-grid-insert` | Habilita a inserção de registros diretamente na grade. | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
24
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
25
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
26
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
27
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
28
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
29
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
30
- | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
31
- | `outlineMode` | `outline-mode` | Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). | `boolean` | `false` |
32
- | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
33
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
34
- | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
35
- | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
36
- | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
37
- | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
- | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
- | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
40
- | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
41
- | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
42
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
43
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
44
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
45
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
46
- | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
+ | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
16
+ | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
+ | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `undefined` |
18
+ | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
19
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
20
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
21
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
22
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
24
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
25
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
26
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
27
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
28
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
29
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
30
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
31
+ | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
32
+ | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
33
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
34
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
35
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
36
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
37
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
+ | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
+ | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `undefined` |
40
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
41
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
42
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
43
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
44
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
45
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
47
46
 
48
47
 
49
48
  ## Events
50
49
 
51
- | Event | Description | Type |
52
- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
53
- | `actionClick` | Emitido ao clicar em um botão de ação ou item de menu. | `CustomEvent<string>` |
54
- | `componentReady` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
55
- | `gridDoubleClick` | Emitido ao realizar um duplo clique em uma linha da grade. | `CustomEvent<any>` |
50
+ | Event | Description | Type |
51
+ | ----------------- | ------------------------------------------------------------ | --------------------- |
52
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
53
+ | `componentReady` | Emitido quando o componente estiver completamente carregado. | `CustomEvent<void>` |
54
+ | `gridDoubleClick` | Emitido sempre que houver duplo click na grade. | `CustomEvent<any>` |
56
55
 
57
56
 
58
57
  ## Methods
59
58
 
60
59
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
61
60
 
62
- Registra um editor customizado para um campo da grade ou formulário.
61
+ Registra um editor customizado para campos da grade e formulário
63
62
 
64
63
  #### Returns
65
64
 
66
65
  Type: `Promise<void>`
67
66
 
68
- Uma promessa que é resolvida quando o editor é registrado.
69
67
 
70
- ---
71
68
 
72
69
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
73
70
 
74
- Registra um formatador de valor customizado para uma coluna da grade.
71
+ Registra um formatador de valores para uma coluna da grid.
75
72
 
76
73
  #### Returns
77
74
 
78
75
  Type: `Promise<void>`
79
76
 
80
- Uma promessa que é resolvida quando o formatador é registrado.
81
77
 
82
- ---
83
78
 
84
79
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
85
80
 
86
- Registra um renderizador customizado para uma coluna da grade.
81
+ Registra um render customizado para colunas da grid.
87
82
 
88
83
  #### Returns
89
84
 
90
85
  Type: `Promise<void>`
91
86
 
92
- Uma promessa que é resolvida quando o renderizador é registrado.
93
87
 
94
- ---
95
88
 
96
89
  ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
97
90
 
98
- Retorna o elemento da barra de filtros da grade.
91
+ Retorna o elemento da filter-bar da grade.
99
92
 
100
93
  #### Returns
101
94
 
102
95
  Type: `Promise<HTMLSnkFilterBarElement>`
103
96
 
104
- O elemento da barra de filtros.
105
97
 
106
- ---
107
98
 
108
99
  ### `hideConfig() => Promise<void>`
109
100
 
@@ -113,11 +104,9 @@ Fecha a janela de configurações da grade.
113
104
 
114
105
  Type: `Promise<void>`
115
106
 
116
- Uma promessa que é resolvida quando a janela de configuração é fechada.
117
107
 
118
- ---
119
108
 
120
- ### `refreshColumnFilterDataSource() => Promise<void>`
109
+ ### `reloadConfig() => Promise<void>`
121
110
 
122
111
 
123
112
 
@@ -125,53 +114,37 @@ Uma promessa que é resolvida quando a janela de configuração é fechada.
125
114
 
126
115
  Type: `Promise<void>`
127
116
 
128
- ---
129
-
130
- ### `reloadConfig() => Promise<void>`
131
117
 
132
- Recarrega a configuração da grade.
133
-
134
- #### Returns
135
-
136
- Type: `Promise<void>`
137
-
138
- ---
139
118
 
140
119
  ### `reloadFilterBar() => Promise<void>`
141
120
 
142
- Recarrega a barra de filtros da grade, buscando o estado do servidor.
121
+ Faz o recarregamento da filter-bar da grade buscando o state no servidor.
143
122
 
144
123
  #### Returns
145
124
 
146
125
  Type: `Promise<void>`
147
126
 
148
- Uma promessa que é resolvida quando a barra de filtros é recarregada.
149
127
 
150
- ---
151
128
 
152
129
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
153
130
 
154
- Remove um formatador de valor customizado de uma coluna da grade.
131
+ Remove o formatador de valores de uma coluna da grid.
155
132
 
156
133
  #### Returns
157
134
 
158
135
  Type: `Promise<void>`
159
136
 
160
- Uma promessa que é resolvida quando o formatador é removido.
161
137
 
162
- ---
163
138
 
164
139
  ### `setConfig(config: IGridConfig) => Promise<void>`
165
140
 
166
- Define a configuração da grade.
141
+ Atribui o valor da configuração da grade.
167
142
 
168
143
  #### Returns
169
144
 
170
145
  Type: `Promise<void>`
171
146
 
172
- Uma promessa que é resolvida quando a configuração é aplicada.
173
147
 
174
- ---
175
148
 
176
149
  ### `setFocus() => Promise<void>`
177
150
 
@@ -181,9 +154,7 @@ Atribui o foco para a grade.
181
154
 
182
155
  Type: `Promise<void>`
183
156
 
184
- Uma promessa que é resolvida quando o foco é atribuído.
185
157
 
186
- ---
187
158
 
188
159
  ### `showConfig() => Promise<void>`
189
160
 
@@ -193,7 +164,7 @@ Exibe a janela de configurações da grade.
193
164
 
194
165
  Type: `Promise<void>`
195
166
 
196
- Uma promessa que é resolvida quando a janela de configuração é exibida.
167
+
197
168
 
198
169
 
199
170
  ## Dependencies
package/components/snk-personalized-filter/readme.md CHANGED
@@ -9,28 +9,28 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome da configuração, utilizado para distinguir múltiplas instâncias do componente. | `string` | `undefined` |
13
- | `entityUri` | `entity-uri` | URI da entidade utilizada para buscar os campos disponíveis para filtro. | `string` | `undefined` |
14
- | `filterId` | `filter-id` | Identificador do filtro a ser carregado. | `string` | `undefined` |
15
- | `isDefaultFilter` | `is-default-filter` | Indica se o filtro é o filtro padrão do sistema. | `boolean` | `false` |
12
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
+ | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
16
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
- | `resourceID` | `resource-i-d` | Identificador do recurso utilizado para salvar e recuperar filtros. | `string` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
21
21
 
22
- | Event | Description | Type |
23
- | ------------- | ----------------------------------------------------------------- | --------------------- |
24
- | `ezAfterSave` | Evento emitido após salvar as alterações do filtro personalizado. | `CustomEvent<void>` |
25
- | `ezCancel` | Evento emitido ao cancelar a personalização do filtro. | `CustomEvent<void>` |
26
- | `ezSave` | Evento emitido ao salvar as alterações do filtro personalizado. | `CustomEvent<string>` |
22
+ | Event | Description | Type |
23
+ | ------------- | ----------- | --------------------- |
24
+ | `ezAfterSave` | | `CustomEvent<void>` |
25
+ | `ezCancel` | | `CustomEvent<void>` |
26
+ | `ezSave` | | `CustomEvent<string>` |
27
27
 
28
28
 
29
29
  ## Methods
30
30
 
31
31
  ### `createPersonalizedFilter() => Promise<void>`
32
32
 
33
- Cria um novo filtro personalizado caso não exista nenhum.
33
+
34
34
 
35
35
  #### Returns
36
36