@sankhyalabs/sankhyablocks-docs 8.16.0-dev.8 → 8.16.0-dev.80

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 (16) hide show
  1. package/components/snk-application/readme.md +52 -8
  2. package/components/snk-attach/readme.md +2 -5
  3. package/components/snk-crud/readme.md +35 -29
  4. package/components/snk-crud/subcomponents/readme.md +5 -2
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +2 -5
  6. package/components/snk-filter-bar/readme.md +15 -12
  7. package/components/snk-form-config/readme.md +6 -7
  8. package/components/snk-grid/readme.md +39 -25
  9. package/components/snk-pesquisa/pesquisa-grid/readme.md +42 -0
  10. package/components/snk-pesquisa/pesquisa-tree/readme.md +53 -0
  11. package/components/snk-pesquisa/readme.md +16 -5
  12. package/components/snk-simple-crud/readme.md +32 -31
  13. package/components/snk-simple-form-config/readme.md +51 -0
  14. package/components/snk-taskbar/readme.md +5 -3
  15. package/components/teste-pesquisa/readme.md +2 -0
  16. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------- |
12
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
15
- | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }, redirectFrom?: string) => void` | `undefined` |
16
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
12
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
+ | `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `undefined` |
14
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
15
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
16
+ | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any; }, redirectFrom?: string) => void` | `undefined` |
17
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
@@ -36,6 +37,16 @@ Type: `Promise<void>`
36
37
 
37
38
 
38
39
 
40
+ ### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
41
+
42
+
43
+
44
+ #### Returns
45
+
46
+ Type: `Promise<() => void>`
47
+
48
+
49
+
39
50
  ### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
40
51
 
41
52
  Adiciona uma ação pendente que deve ser executada por um determinado locker.
@@ -138,7 +149,7 @@ Type: `Promise<IOption | IOption[]>`
138
149
 
139
150
 
140
151
 
141
- ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>`
152
+ ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
142
153
 
143
154
  Obtém as opções em componentes de pesquisa
144
155
  Ex.: snk-config-options
@@ -401,6 +412,16 @@ Type: `Promise<Map<string, number>>`
401
412
 
402
413
 
403
414
 
415
+ ### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
416
+
417
+
418
+
419
+ #### Returns
420
+
421
+ Type: `Promise<void>`
422
+
423
+
424
+
404
425
  ### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
405
426
 
406
427
  Exibe um diálogo de mensagem comum
@@ -421,6 +442,17 @@ Type: `Promise<void>`
421
442
 
422
443
 
423
444
 
445
+ ### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
446
+
447
+ Remove registro do cache do PreLoader do dataunit.
448
+ Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
449
+
450
+ #### Returns
451
+
452
+ Type: `Promise<void>`
453
+
454
+
455
+
424
456
  ### `removeClientEvent(eventID: String) => Promise<void>`
425
457
 
426
458
  Remove um client event para o DataFetcher da aplicação.
@@ -483,6 +515,16 @@ Type: `Promise<void>`
483
515
 
484
516
 
485
517
 
518
+ ### `showScrimApp(active: boolean) => Promise<void>`
519
+
520
+
521
+
522
+ #### Returns
523
+
524
+ Type: `Promise<void>`
525
+
526
+
527
+
486
528
  ### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
487
529
 
488
530
  Exibe o diálogo de sucesso de acordo com os parâmetros passados.
@@ -548,6 +590,8 @@ SnkApplication carregado.
548
590
  ```mermaid
549
591
  graph TD;
550
592
  snk-application --> snk-pesquisa
593
+ snk-pesquisa --> pesquisa-grid
594
+ snk-pesquisa --> pesquisa-tree
551
595
  teste-pesquisa --> snk-application
552
596
  style snk-application fill:#f9f,stroke:#333,stroke-width:4px
553
597
  ```
package/components/snk-attach/readme.md CHANGED
@@ -42,9 +42,9 @@
42
42
  graph TD;
43
43
  snk-attach --> snk-simple-bar
44
44
  snk-attach --> snk-simple-crud
45
- snk-simple-crud --> snk-data-unit
46
45
  snk-simple-crud --> snk-taskbar
47
- snk-simple-crud --> snk-form-config
46
+ snk-simple-crud --> snk-data-unit
47
+ snk-simple-crud --> snk-simple-form-config
48
48
  snk-simple-crud --> snk-configurator
49
49
  snk-simple-crud --> snk-grid-config
50
50
  snk-simple-crud --> snk-data-exporter
@@ -54,9 +54,6 @@ graph TD;
54
54
  snk-taskbar --> snk-actions-button
55
55
  snk-taskbar --> taskbar-actions-button
56
56
  snk-data-exporter --> snk-exporter-email-sender
57
- snk-form-config --> snk-field-config
58
- snk-form-config --> snk-config-options
59
- snk-form-config --> snk-tab-config
60
57
  snk-grid-config --> snk-select-box
61
58
  snk-crud --> snk-attach
62
59
  snk-detail-view --> snk-attach
package/components/snk-crud/readme.md CHANGED
@@ -7,37 +7,43 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------- |
12
- | `actionsList` | -- | Ações a serem colocadas 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
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
- | `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` |
17
- | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
18
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
19
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
20
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
21
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
22
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
24
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
26
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
27
- | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
28
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
29
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
30
- | `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` | -- | Ações a serem colocadas 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
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
+ | `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` |
17
+ | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
18
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
19
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
20
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
21
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
22
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
23
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
24
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
25
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
26
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
27
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
28
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
29
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
30
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
31
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
32
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
33
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
34
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
35
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
31
36
 
32
37
 
33
38
  ## Events
34
39
 
35
- | Event | Description | Type |
36
- | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
37
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
38
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
39
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
40
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
40
+ | Event | Description | Type |
41
+ | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
42
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
43
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
44
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
45
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
46
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
41
47
 
42
48
 
43
49
  ## Methods
@@ -208,9 +214,9 @@ graph TD;
208
214
  snk-detail-view --> taskbar-actions-button
209
215
  snk-attach --> snk-simple-bar
210
216
  snk-attach --> snk-simple-crud
211
- snk-simple-crud --> snk-data-unit
212
217
  snk-simple-crud --> snk-taskbar
213
- snk-simple-crud --> snk-form-config
218
+ snk-simple-crud --> snk-data-unit
219
+ snk-simple-crud --> snk-simple-form-config
214
220
  snk-simple-crud --> snk-configurator
215
221
  snk-simple-crud --> snk-grid-config
216
222
  snk-simple-crud --> snk-data-exporter
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -15,8 +15,11 @@
15
15
  | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
16
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
17
  | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
18
19
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
20
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
21
+ | `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
22
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
20
23
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
21
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
25
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
@@ -162,9 +165,9 @@ graph TD;
162
165
  snk-grid-config --> snk-select-box
163
166
  snk-attach --> snk-simple-bar
164
167
  snk-attach --> snk-simple-crud
165
- snk-simple-crud --> snk-data-unit
166
168
  snk-simple-crud --> snk-taskbar
167
- snk-simple-crud --> snk-form-config
169
+ snk-simple-crud --> snk-data-unit
170
+ snk-simple-crud --> snk-simple-form-config
168
171
  snk-simple-crud --> snk-configurator
169
172
  snk-simple-crud --> snk-grid-config
170
173
  snk-simple-crud --> snk-data-exporter
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -142,17 +142,14 @@ graph TD;
142
142
  snk-form-view --> snk-form-summary
143
143
  snk-attach --> snk-simple-bar
144
144
  snk-attach --> snk-simple-crud
145
- snk-simple-crud --> snk-data-unit
146
145
  snk-simple-crud --> snk-taskbar
147
- snk-simple-crud --> snk-form-config
146
+ snk-simple-crud --> snk-data-unit
147
+ snk-simple-crud --> snk-simple-form-config
148
148
  snk-simple-crud --> snk-configurator
149
149
  snk-simple-crud --> snk-grid-config
150
150
  snk-simple-crud --> snk-data-exporter
151
151
  snk-simple-crud --> snk-actions-button
152
152
  snk-simple-crud --> taskbar-actions-button
153
- snk-form-config --> snk-field-config
154
- snk-form-config --> snk-config-options
155
- snk-form-config --> snk-tab-config
156
153
  snk-guides-viewer --> snk-detail-view
157
154
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
158
155
  ```
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,18 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
12
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
13
- | `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` |
14
- | `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` |
15
- | `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` |
16
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
17
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
18
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
- | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
20
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
21
- | `title` | `title` | Título que será apresentado na barra de filtros | `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` |
22
25
 
23
26
 
24
27
  ## Events
package/components/snk-form-config/readme.md CHANGED
@@ -7,11 +7,12 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | --------- | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
- | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
- | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
- | `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
+ | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
+ | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
15
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
16
 
16
17
 
17
18
  ## Events
@@ -28,7 +29,6 @@
28
29
 
29
30
  - [snk-form](../snk-form)
30
31
  - [snk-guides-viewer](../snk-crud/subcomponents)
31
- - [snk-simple-crud](../snk-simple-crud)
32
32
 
33
33
  ### Depends on
34
34
 
@@ -44,7 +44,6 @@ graph TD;
44
44
  snk-form-config --> snk-tab-config
45
45
  snk-form --> snk-form-config
46
46
  snk-guides-viewer --> snk-form-config
47
- snk-simple-crud --> snk-form-config
48
47
  style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
49
48
  ```
50
49
 
package/components/snk-grid/readme.md CHANGED
@@ -7,31 +7,35 @@
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
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
29
+ | `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` |
30
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
31
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
32
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
33
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
34
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
35
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
36
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
37
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
38
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
35
39
 
36
40
 
37
41
  ## Events
@@ -104,6 +108,16 @@ Type: `Promise<void>`
104
108
 
105
109
 
106
110
 
111
+ ### `reloadConfig() => Promise<void>`
112
+
113
+
114
+
115
+ #### Returns
116
+
117
+ Type: `Promise<void>`
118
+
119
+
120
+
107
121
  ### `reloadFilterBar() => Promise<void>`
108
122
 
109
123
  Faz o recarregamento da filter-bar da grade buscando o state no servidor.
package/components/snk-pesquisa/pesquisa-grid/readme.md ADDED
@@ -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
+
package/components/snk-pesquisa/pesquisa-tree/readme.md ADDED
@@ -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
+
package/components/snk-pesquisa/readme.md CHANGED
@@ -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
  ```
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,30 +7,34 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
12
- | `actionsList` | -- | Ações a serem colocadas 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
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
- | `dataState` | -- | | `DataState` | `undefined` |
17
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
- | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
19
- | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
20
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
21
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
22
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
23
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
24
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
25
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
26
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
27
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
28
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
29
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
30
- | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
31
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
32
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
33
- | `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` | -- | Ações a serem colocadas 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
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
+ | `dataState` | -- | | `DataState` | `undefined` |
17
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
+ | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `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
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
23
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
24
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
25
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
26
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
27
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
28
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
29
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
30
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `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
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
33
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
34
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
35
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
36
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
37
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
34
38
 
35
39
 
36
40
  ## Events
@@ -176,9 +180,9 @@ Type: `Promise<void>`
176
180
 
177
181
  ### Depends on
178
182
 
179
- - [snk-data-unit](../snk-data-unit)
180
183
  - [snk-taskbar](../snk-taskbar)
181
- - [snk-form-config](../snk-form-config)
184
+ - [snk-data-unit](../snk-data-unit)
185
+ - [snk-simple-form-config](../snk-simple-form-config)
182
186
  - [snk-configurator](../snk-configurator)
183
187
  - [snk-grid-config](../snk-grid-config)
184
188
  - [snk-data-exporter](../snk-data-exporter)
@@ -188,9 +192,9 @@ Type: `Promise<void>`
188
192
  ### Graph
189
193
  ```mermaid
190
194
  graph TD;
191
- snk-simple-crud --> snk-data-unit
192
195
  snk-simple-crud --> snk-taskbar
193
- snk-simple-crud --> snk-form-config
196
+ snk-simple-crud --> snk-data-unit
197
+ snk-simple-crud --> snk-simple-form-config
194
198
  snk-simple-crud --> snk-configurator
195
199
  snk-simple-crud --> snk-grid-config
196
200
  snk-simple-crud --> snk-data-exporter
@@ -200,9 +204,6 @@ graph TD;
200
204
  snk-taskbar --> snk-actions-button
201
205
  snk-taskbar --> taskbar-actions-button
202
206
  snk-data-exporter --> snk-exporter-email-sender
203
- snk-form-config --> snk-field-config
204
- snk-form-config --> snk-config-options
205
- snk-form-config --> snk-tab-config
206
207
  snk-grid-config --> snk-select-box
207
208
  snk-attach --> snk-simple-crud
208
209
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-simple-form-config/readme.md ADDED
@@ -0,0 +1,51 @@
1
+ # snk-simple-form-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ------------------------------------------------- | ---------- | ----------- |
12
+ | `configName` | `config-name` | Chave que representa a configuração do formulário | `string` | `undefined` |
13
+ | `dataUnit` | -- | Data unit responsável pelos campos disponíveis | `DataUnit` | `undefined` |
14
+
15
+
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | ---------------- | ----------- | ------------------- |
20
+ | `snkConfigSaved` | | `CustomEvent<void>` |
21
+
22
+
23
+ ## Methods
24
+
25
+ ### `show() => Promise<void>`
26
+
27
+ Responsável por abrir o configurador.
28
+
29
+ #### Returns
30
+
31
+ Type: `Promise<void>`
32
+
33
+
34
+
35
+
36
+ ## Dependencies
37
+
38
+ ### Used by
39
+
40
+ - [snk-simple-crud](../snk-simple-crud)
41
+
42
+ ### Graph
43
+ ```mermaid
44
+ graph TD;
45
+ snk-simple-crud --> snk-simple-form-config
46
+ style snk-simple-form-config fill:#f9f,stroke:#333,stroke-width:4px
47
+ ```
48
+
49
+ ----------------------------------------------
50
+
51
+
package/components/snk-taskbar/readme.md CHANGED
@@ -27,9 +27,11 @@
27
27
 
28
28
  ## Events
29
29
 
30
- | Event | Description | Type |
31
- | ------------- | ------------------------------------------------- | --------------------- |
32
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
30
+ | Event | Description | Type |
31
+ | --------------------- | ------------------------------------------------------------ | --------------------- |
32
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
33
+ | `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
34
+ | `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
33
35
 
34
36
 
35
37
  ## Dependencies
package/components/teste-pesquisa/readme.md CHANGED
@@ -16,6 +16,8 @@
16
16
  graph TD;
17
17
  teste-pesquisa --> snk-application
18
18
  snk-application --> snk-pesquisa
19
+ snk-pesquisa --> pesquisa-grid
20
+ snk-pesquisa --> pesquisa-tree
19
21
  style teste-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
20
22
  ```
21
23
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.16.0-dev.8",
3
+ "version": "8.16.0-dev.80",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [