@sankhyalabs/sankhyablocks-docs 10.1.0-dev.2 → 10.1.0-dev.3
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.
|
@@ -184,6 +184,18 @@ Uma lista de opções ou uma única opção.
|
|
|
184
184
|
|
|
185
185
|
---
|
|
186
186
|
|
|
187
|
+
### `executePreparedSearchWithFullResponse(argument: string, options: any) => Promise<any>`
|
|
188
|
+
|
|
189
|
+
Obtém as opções em componentes de pesquisa além dos metadados como showMore e entityPk.
|
|
190
|
+
|
|
191
|
+
#### Returns
|
|
192
|
+
|
|
193
|
+
Type: `Promise<any>`
|
|
194
|
+
|
|
195
|
+
Uma lista de opções ou uma única opção.
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
187
199
|
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
|
|
188
200
|
|
|
189
201
|
Obtém as opções em componentes de pesquisa.
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
35
35
|
| `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
|
|
36
36
|
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
|
37
|
+
| `showEntitySearch` | `show-entity-search` | Define se o campo de busca de entidades será exibido na barra superior. | `boolean` | `true` |
|
|
37
38
|
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
38
39
|
| `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
|
39
40
|
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
@@ -7,45 +7,46 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| ------------------------------- |
|
|
12
|
-
| `actionsList` | --
|
|
13
|
-
| `autoFocus` | `auto-focus`
|
|
14
|
-
| `autoLoad` | `auto-load`
|
|
15
|
-
| `canEdit` | `can-edit`
|
|
16
|
-
| `columnFilterDataSource` | --
|
|
17
|
-
| `compact` | `compact`
|
|
18
|
-
| `configName` | `config-name`
|
|
19
|
-
| `disablePersonalizedFilter` | `disable-personalized-filter`
|
|
20
|
-
| `enableGridInsert` | `enable-grid-insert`
|
|
21
|
-
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp`
|
|
22
|
-
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click`
|
|
23
|
-
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name`
|
|
24
|
-
| `filterBarTitle` | `filter-bar-title`
|
|
25
|
-
| `filterCustomConfig` | --
|
|
26
|
-
| `filterCustomConfigInterceptor` | --
|
|
27
|
-
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id`
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
35
|
-
| `
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `
|
|
40
|
-
| `
|
|
41
|
-
| `
|
|
42
|
-
| `
|
|
43
|
-
| `
|
|
44
|
-
| `
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
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
|
+
| `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
|
|
26
|
+
| `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
|
|
27
|
+
| `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'` |
|
|
28
|
+
| `gridHeaderDynamicSearchSlotId` | `grid-header-dynamic-search-slot-id` | Define o nome do slot para a aba de pesquisa no cabeçalho da grade. | `string` | `'GRID_HEADER_DYNAMIC_SEARCH'` |
|
|
29
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
|
|
30
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
|
|
31
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
32
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
|
|
33
|
+
| `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
|
|
34
|
+
| `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` |
|
|
35
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
|
36
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
37
|
+
| `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
|
|
38
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
|
|
39
|
+
| `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
|
|
40
|
+
| `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
41
|
+
| `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
|
42
|
+
| `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
|
|
43
|
+
| `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
|
|
44
|
+
| `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
|
|
45
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
|
|
46
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
47
|
+
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
|
|
48
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
|
|
49
|
+
| `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
|
|
49
50
|
|
|
50
51
|
|
|
51
52
|
## Events
|
|
@@ -18,6 +18,20 @@
|
|
|
18
18
|
| `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. | `(text: string) => Promise<any>` | `undefined` |
|
|
19
19
|
|
|
20
20
|
|
|
21
|
+
## Methods
|
|
22
|
+
|
|
23
|
+
### `executeSearch(text: string) => Promise<void>`
|
|
24
|
+
|
|
25
|
+
* Executa uma pesquisa programaticamente.
|
|
26
|
+
Útil para cenários onde a pesquisa precisa ser disparada sem interação do usuário.
|
|
27
|
+
|
|
28
|
+
#### Returns
|
|
29
|
+
|
|
30
|
+
Type: `Promise<void>`
|
|
31
|
+
|
|
32
|
+
Promise<void>
|
|
33
|
+
|
|
34
|
+
|
|
21
35
|
## Dependencies
|
|
22
36
|
|
|
23
37
|
### Used by
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
|
|
12
12
|
| `actionsList` | -- | | `Action[]` | `undefined` |
|
|
13
13
|
| `actionsSettingsList` | -- | | `Action[]` | `undefined` |
|
|
14
|
+
| `additionalSlotId` | `additional-slot-id` | | `string` | `"TASKBAR_ADDITIONAL_SLOT"` |
|
|
14
15
|
| `alignRigth` | `align-rigth` | | `boolean` | `false` |
|
|
15
16
|
| `buttons` | `buttons` | | `string` | `undefined` |
|
|
16
17
|
| `configName` | `config-name` | | `string` | `undefined` |
|