@sankhyalabs/sankhyablocks-docs 8.16.0-dev.12 → 8.16.0-dev.120

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 (37) hide show
  1. package/components/snk-application/readme.md +93 -8
  2. package/components/snk-attach/readme.md +6 -5
  3. package/components/snk-configurator/readme.md +7 -0
  4. package/components/snk-crud/readme.md +49 -27
  5. package/components/snk-crud/subcomponents/readme.md +26 -20
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +27 -22
  7. package/components/snk-filter-bar/filter-modal/readme.md +15 -12
  8. package/components/snk-filter-bar/filter-modal/subcomponents/snk-default-filter/readme.md +38 -0
  9. package/components/snk-filter-bar/readme.md +15 -12
  10. package/components/snk-form/readme.md +8 -3
  11. package/components/snk-form-config/config-header/configs-button/readme.md +40 -0
  12. package/components/snk-form-config/config-header/readme.md +47 -0
  13. package/components/snk-form-config/field-item/field-config/readme.md +53 -0
  14. package/components/snk-form-config/field-item/readme.md +48 -0
  15. package/components/snk-form-config/fields-layout/readme.md +64 -0
  16. package/components/snk-form-config/fields-selector/readme.md +44 -0
  17. package/components/snk-form-config/guides-configurator/readme.md +42 -0
  18. package/components/snk-form-config/readme.md +19 -14
  19. package/components/snk-grid/readme.md +45 -33
  20. package/components/snk-layout-form-config/readme.md +41 -0
  21. package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
  22. package/components/snk-personalized-filter/readme.md +8 -7
  23. package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +8 -7
  24. package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +7 -6
  25. package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +8 -7
  26. package/components/snk-pesquisa/pesquisa-grid/readme.md +42 -0
  27. package/components/snk-pesquisa/pesquisa-tree/readme.md +53 -0
  28. package/components/snk-pesquisa/readme.md +16 -5
  29. package/components/snk-simple-crud/readme.md +41 -31
  30. package/components/snk-simple-form-config/readme.md +51 -0
  31. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
  32. package/components/snk-taskbar/readme.md +24 -19
  33. package/components/teste-pesquisa/readme.md +2 -0
  34. package/package.json +1 -1
  35. package/components/snk-form-config/subcomponents/snk-config-options/readme.md +0 -40
  36. package/components/snk-form-config/subcomponents/snk-field-config/readme.md +0 -41
  37. package/components/snk-form-config/subcomponents/snk-tab-config/readme.md +0 -46
@@ -7,31 +7,40 @@
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 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
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
18
- | `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` |
19
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
20
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
21
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
22
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
23
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
24
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
25
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
26
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
27
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
28
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
29
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
30
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
31
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
32
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
33
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
34
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
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
+ | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
18
+ | `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` |
19
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
20
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
21
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
22
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
23
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
24
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
25
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
26
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
27
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
28
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
29
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
30
+ | `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` |
31
+ | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
32
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
33
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
34
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
35
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
36
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
37
+ | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
38
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
39
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
40
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
41
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
42
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
43
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
35
44
 
36
45
 
37
46
  ## Events
@@ -74,29 +83,29 @@ Type: `Promise<void>`
74
83
 
75
84
 
76
85
 
77
- ### `findColumn() => Promise<void>`
86
+ ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
78
87
 
79
- Abre o localizador de colunas
88
+ Retorna o elemento da filter-bar da grade.
80
89
 
81
90
  #### Returns
82
91
 
83
- Type: `Promise<void>`
92
+ Type: `Promise<HTMLSnkFilterBarElement>`
84
93
 
85
94
 
86
95
 
87
- ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
96
+ ### `hideConfig() => Promise<void>`
88
97
 
89
- Retorna o elemento da filter-bar da grade.
98
+ Fecha a janela de configurações da grade.
90
99
 
91
100
  #### Returns
92
101
 
93
- Type: `Promise<HTMLSnkFilterBarElement>`
102
+ Type: `Promise<void>`
94
103
 
95
104
 
96
105
 
97
- ### `hideConfig() => Promise<void>`
106
+ ### `reloadConfig() => Promise<void>`
107
+
98
108
 
99
- Fecha a janela de configurações da grade.
100
109
 
101
110
  #### Returns
102
111
 
@@ -169,6 +178,7 @@ Type: `Promise<void>`
169
178
  - [snk-grid-config](../snk-grid-config)
170
179
  - [snk-data-exporter](../snk-data-exporter)
171
180
  - [snk-actions-button](../snk-actions-button)
181
+ - [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
172
182
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
173
183
 
174
184
  ### Graph
@@ -179,6 +189,7 @@ graph TD;
179
189
  snk-grid --> snk-grid-config
180
190
  snk-grid --> snk-data-exporter
181
191
  snk-grid --> snk-actions-button
192
+ snk-grid --> taskbar-split-button
182
193
  snk-grid --> taskbar-actions-button
183
194
  snk-filter-bar --> snk-filter-item
184
195
  snk-filter-bar --> snk-personalized-filter
@@ -194,6 +205,7 @@ graph TD;
194
205
  snk-expression-item --> snk-filter-param-config
195
206
  snk-taskbar --> snk-data-exporter
196
207
  snk-taskbar --> snk-actions-button
208
+ snk-taskbar --> taskbar-split-button
197
209
  snk-taskbar --> taskbar-actions-button
198
210
  snk-data-exporter --> snk-exporter-email-sender
199
211
  snk-grid-config --> snk-select-box
@@ -0,0 +1,41 @@
1
+ # snk-layout-form-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Methods
9
+
10
+ ### `save() => Promise<void>`
11
+
12
+ Salva o tipo de layout escolhido. Sem retorno.
13
+
14
+ #### Returns
15
+
16
+ Type: `Promise<void>`
17
+
18
+
19
+
20
+
21
+ ## Dependencies
22
+
23
+ ### Used by
24
+
25
+ - [snk-configurator](../snk-configurator)
26
+
27
+ ### Depends on
28
+
29
+ - [snk-view-representation](snk-view-representation)
30
+
31
+ ### Graph
32
+ ```mermaid
33
+ graph TD;
34
+ snk-layout-form-config --> snk-view-representation
35
+ snk-configurator --> snk-layout-form-config
36
+ style snk-layout-form-config fill:#f9f,stroke:#333,stroke-width:4px
37
+ ```
38
+
39
+ ----------------------------------------------
40
+
41
+
@@ -0,0 +1,30 @@
1
+ # snk-view-representation
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | ---------------------------------------------------------- | ------------ | ------------------------- |
12
+ | `mode` | `mode` | Define o layout do componente: 'CASCADE' ou 'SIDE_BY_SIDE' | `FormLayout` | `FormLayout.SIDE_BY_SIDE` |
13
+
14
+
15
+ ## Dependencies
16
+
17
+ ### Used by
18
+
19
+ - [snk-layout-form-config](..)
20
+
21
+ ### Graph
22
+ ```mermaid
23
+ graph TD;
24
+ snk-layout-form-config --> snk-view-representation
25
+ style snk-view-representation fill:#f9f,stroke:#333,stroke-width:4px
26
+ ```
27
+
28
+ ----------------------------------------------
29
+
30
+
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
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
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
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
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
13
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
14
- | `group` | -- | Grupo que será representado visualmente pelo componente. | `IExpressionGroup` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `parentTop` | `parent-top` | Tamanho do elemento pai do grupo | `number` | `0` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
13
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
14
+ | `group` | -- | Grupo que será representado visualmente pelo componente. | `IExpressionGroup` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `parentTop` | `parent-top` | Tamanho do elemento pai do grupo | `number` | `0` |
17
18
 
18
19
 
19
20
  ## Events
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `canRemove` | `can-remove` | Controla a exibição do botão Remover. | `boolean` | `true` |
13
- | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
14
- | `expression` | -- | Expressão que será representada visualmente. | `IExpressionItem` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `canRemove` | `can-remove` | Controla a exibição do botão Remover. | `boolean` | `true` |
13
+ | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
14
+ | `expression` | -- | Expressão que será representada visualmente. | `IExpressionItem` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
17
 
17
18
 
18
19
  ## Events
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------ | -------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `application` | -- | Propriedade que mantém informações relacionadas ao SnkApplication. | `SnkApplication` | `undefined` |
13
- | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
- | `filterAssistent` | -- | Propriedade que contém informações do filtro personalizado. | `IPersonalizedFilter` | `undefined` |
15
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
16
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `application` | -- | Propriedade que mantém informações relacionadas ao SnkApplication. | `SnkApplication` | `undefined` |
13
+ | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
+ | `filterAssistent` | -- | Propriedade que contém informações do filtro personalizado. | `IPersonalizedFilter` | `undefined` |
15
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
16
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
@@ -0,0 +1,42 @@
1
+ # pesquisa-grid
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------------- | ------------------------------------------------- | -------------- | ----------- |
12
+ | `dataSource` | -- | Registros da grade | `Record[]` | `[]` |
13
+ | `descriptionField` | `description-field` | Campo que representa a descrição do registro | `string` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade representada na grade | `string` | `undefined` |
15
+ | `metadata` | -- | Campos que representam as colunas da grade. | `UnitMetadata` | `undefined` |
16
+ | `pkField` | `pk-field` | Campo que representa a chave primária do registro | `string` | `undefined` |
17
+ | `shouldLoadConfig` | `should-load-config` | Define se deve carregar configurações da grade | `boolean` | `false` |
18
+
19
+
20
+ ## Events
21
+
22
+ | Event | Description | Type |
23
+ | ------------------------ | ----------- | ---------------------- |
24
+ | `pesquisaGridSelectItem` | | `CustomEvent<IOption>` |
25
+
26
+
27
+ ## Dependencies
28
+
29
+ ### Used by
30
+
31
+ - [snk-pesquisa](..)
32
+
33
+ ### Graph
34
+ ```mermaid
35
+ graph TD;
36
+ snk-pesquisa --> pesquisa-grid
37
+ style pesquisa-grid fill:#f9f,stroke:#333,stroke-width:4px
38
+ ```
39
+
40
+ ----------------------------------------------
41
+
42
+
@@ -0,0 +1,53 @@
1
+ # pesquisa-tree
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ------------------------------------------------------------------ | ---------------------------------------- | ----------- |
12
+ | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
13
+ | `argument` | `argument` | Argumentos que serão usados ao chamar a função treeLoader. | `string` | `undefined` |
14
+ | `shouldLoadTree` | `should-load-tree` | Informa se a árvore hierárquica deve ou não ser carregada. | `boolean` | `false` |
15
+ | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<ITreeItem[]>` | `undefined` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ------------------------ | ----------- | ---------------------- |
22
+ | `pesquisaTreeSelectItem` | | `CustomEvent<IOption>` |
23
+
24
+
25
+ ## Methods
26
+
27
+ ### `applyFilter() => Promise<void>`
28
+
29
+
30
+
31
+ #### Returns
32
+
33
+ Type: `Promise<void>`
34
+
35
+
36
+
37
+
38
+ ## Dependencies
39
+
40
+ ### Used by
41
+
42
+ - [snk-pesquisa](..)
43
+
44
+ ### Graph
45
+ ```mermaid
46
+ graph TD;
47
+ snk-pesquisa --> pesquisa-tree
48
+ style pesquisa-tree fill:#f9f,stroke:#333,stroke-width:4px
49
+ ```
50
+
51
+ ----------------------------------------------
52
+
53
+
@@ -7,11 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | ---------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
12
- | `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
13
- | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
14
- | `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
13
+ | `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade onde a pesquisa é aplicada. | `string` | `undefined` |
15
+ | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa possuirá ou não modo Hierarquico. | `boolean` | `false` |
16
+ | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
17
+ | `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
18
+ | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<any>` | `undefined` |
15
19
 
16
20
 
17
21
  ## Dependencies
@@ -20,9 +24,16 @@
20
24
 
21
25
  - [snk-application](../snk-application)
22
26
 
27
+ ### Depends on
28
+
29
+ - [pesquisa-grid](pesquisa-grid)
30
+ - [pesquisa-tree](pesquisa-tree)
31
+
23
32
  ### Graph
24
33
  ```mermaid
25
34
  graph TD;
35
+ snk-pesquisa --> pesquisa-grid
36
+ snk-pesquisa --> pesquisa-tree
26
37
  snk-application --> snk-pesquisa
27
38
  style snk-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
28
39
  ```