@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-KB-5632748.0 → 0.0.0-hotfix-rc-KB-83760.0

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 (17) hide show
  1. package/components/snk-application/readme.md +21 -8
  2. package/components/snk-attach/readme.md +2 -5
  3. package/components/snk-crud/readme.md +66 -8
  4. package/components/snk-crud/subcomponents/readme.md +35 -2
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +24 -5
  6. package/components/snk-data-unit/readme.md +53 -21
  7. package/components/snk-filter-bar/readme.md +14 -11
  8. package/components/snk-form/readme.md +20 -0
  9. package/components/snk-form-config/readme.md +6 -7
  10. package/components/snk-grid/readme.md +79 -23
  11. package/components/snk-pesquisa/pesquisa-grid/readme.md +41 -0
  12. package/components/snk-pesquisa/pesquisa-tree/readme.md +52 -0
  13. package/components/snk-pesquisa/readme.md +16 -5
  14. package/components/snk-simple-crud/readme.md +82 -26
  15. package/components/snk-simple-form-config/readme.md +51 -0
  16. package/components/teste-pesquisa/readme.md +2 -0
  17. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -7,13 +7,13 @@
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>; }) => 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
+ | `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: any; }, redirectFrom?: string) => void` | `undefined` |
16
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
17
17
 
18
18
 
19
19
  ## Events
@@ -138,7 +138,7 @@ Type: `Promise<IOption | IOption[]>`
138
138
 
139
139
 
140
140
 
141
- ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>`
141
+ ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
142
142
 
143
143
  Obtém as opções em componentes de pesquisa
144
144
  Ex.: snk-config-options
@@ -421,6 +421,17 @@ Type: `Promise<void>`
421
421
 
422
422
 
423
423
 
424
+ ### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
425
+
426
+ Remove registro do cache do PreLoader do dataunit.
427
+ Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
428
+
429
+ #### Returns
430
+
431
+ Type: `Promise<void>`
432
+
433
+
434
+
424
435
  ### `removeClientEvent(eventID: String) => Promise<void>`
425
436
 
426
437
  Remove um client event para o DataFetcher da aplicação.
@@ -548,6 +559,8 @@ SnkApplication carregado.
548
559
  ```mermaid
549
560
  graph TD;
550
561
  snk-application --> snk-pesquisa
562
+ snk-pesquisa --> pesquisa-tree
563
+ snk-pesquisa --> pesquisa-grid
551
564
  teste-pesquisa --> snk-application
552
565
  style snk-application fill:#f9f,stroke:#333,stroke-width:4px
553
566
  ```
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
@@ -10,17 +10,24 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------- |
12
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` |
13
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
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
+ | `enableLockManger` | `enable-lock-manger` | Ativa o gerenciamento de locks na grade. | `boolean` | `false` |
15
20
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
21
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
22
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
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` | `undefined` |
19
25
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
26
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
21
27
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
22
28
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
29
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
30
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
24
31
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
25
32
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
26
33
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -29,16 +36,47 @@
29
36
 
30
37
  ## Events
31
38
 
32
- | Event | Description | Type |
33
- | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
34
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
35
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
36
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
37
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
39
+ | Event | Description | Type |
40
+ | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
41
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
42
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
43
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
44
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
45
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
38
46
 
39
47
 
40
48
  ## Methods
41
49
 
50
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
51
+
52
+ Registra um editor customizado para campos da grade e formulário.
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<void>`
57
+
58
+
59
+
60
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
61
+
62
+ Registra um formatador de valores para uma coluna da grid.
63
+
64
+ #### Returns
65
+
66
+ Type: `Promise<void>`
67
+
68
+
69
+
70
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
71
+
72
+ Registra um render customizado para colunas da grid.
73
+
74
+ #### Returns
75
+
76
+ Type: `Promise<void>`
77
+
78
+
79
+
42
80
  ### `closeConfigurator() => Promise<void>`
43
81
 
44
82
  Usado para fechar o configurator do CRUD
@@ -89,6 +127,26 @@ Type: `Promise<void>`
89
127
 
90
128
 
91
129
 
130
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
131
+
132
+ Remove o formatador de valores de uma coluna da grid.
133
+
134
+ #### Returns
135
+
136
+ Type: `Promise<void>`
137
+
138
+
139
+
140
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
141
+
142
+ Altera/adiciona uma propriedade nos metadados do campo.
143
+
144
+ #### Returns
145
+
146
+ Type: `Promise<void>`
147
+
148
+
149
+
92
150
 
93
151
  ## Dependencies
94
152
 
@@ -155,9 +213,9 @@ graph TD;
155
213
  snk-detail-view --> taskbar-actions-button
156
214
  snk-attach --> snk-simple-bar
157
215
  snk-attach --> snk-simple-crud
158
- snk-simple-crud --> snk-data-unit
159
216
  snk-simple-crud --> snk-taskbar
160
- snk-simple-crud --> snk-form-config
217
+ snk-simple-crud --> snk-data-unit
218
+ snk-simple-crud --> snk-simple-form-config
161
219
  snk-simple-crud --> snk-configurator
162
220
  snk-simple-crud --> snk-grid-config
163
221
  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` |
@@ -37,6 +40,26 @@
37
40
 
38
41
  ## Methods
39
42
 
43
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
44
+
45
+ Registra um editor customizado para campos da grade e formulário
46
+
47
+ #### Returns
48
+
49
+ Type: `Promise<void>`
50
+
51
+
52
+
53
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
54
+
55
+ Registra um render customizado para colunas da grid.
56
+
57
+ #### Returns
58
+
59
+ Type: `Promise<void>`
60
+
61
+
62
+
40
63
  ### `findField() => Promise<void>`
41
64
 
42
65
  Abre o localizador de campos
@@ -47,6 +70,16 @@ Type: `Promise<void>`
47
70
 
48
71
 
49
72
 
73
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
74
+
75
+ Altera/adiciona uma propriedade nos metadados do campo.
76
+
77
+ #### Returns
78
+
79
+ Type: `Promise<void>`
80
+
81
+
82
+
50
83
  ### `setFocus() => Promise<void>`
51
84
 
52
85
  Atribui o foco para o componente.
@@ -132,9 +165,9 @@ graph TD;
132
165
  snk-grid-config --> snk-select-box
133
166
  snk-attach --> snk-simple-bar
134
167
  snk-attach --> snk-simple-crud
135
- snk-simple-crud --> snk-data-unit
136
168
  snk-simple-crud --> snk-taskbar
137
- snk-simple-crud --> snk-form-config
169
+ snk-simple-crud --> snk-data-unit
170
+ snk-simple-crud --> snk-simple-form-config
138
171
  snk-simple-crud --> snk-configurator
139
172
  snk-simple-crud --> snk-grid-config
140
173
  snk-simple-crud --> snk-data-exporter
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -11,6 +11,8 @@
11
11
  | -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ---------------------- | ----------- |
12
12
  | `branchGuide` | -- | | `IGuideItem` | `undefined` |
13
13
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
15
+ | `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
14
16
  | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
15
17
  | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
16
18
  | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
@@ -35,6 +37,26 @@
35
37
 
36
38
  ## Methods
37
39
 
40
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
41
+
42
+ Registra um editor customizado para campos da grade e formulário.
43
+
44
+ #### Returns
45
+
46
+ Type: `Promise<void>`
47
+
48
+
49
+
50
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
51
+
52
+ Registra um render customizado para colunas da grid.
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<void>`
57
+
58
+
59
+
38
60
  ### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
39
61
 
40
62
  Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
@@ -120,17 +142,14 @@ graph TD;
120
142
  snk-form-view --> snk-form-summary
121
143
  snk-attach --> snk-simple-bar
122
144
  snk-attach --> snk-simple-crud
123
- snk-simple-crud --> snk-data-unit
124
145
  snk-simple-crud --> snk-taskbar
125
- snk-simple-crud --> snk-form-config
146
+ snk-simple-crud --> snk-data-unit
147
+ snk-simple-crud --> snk-simple-form-config
126
148
  snk-simple-crud --> snk-configurator
127
149
  snk-simple-crud --> snk-grid-config
128
150
  snk-simple-crud --> snk-data-exporter
129
151
  snk-simple-crud --> snk-actions-button
130
152
  snk-simple-crud --> taskbar-actions-button
131
- snk-form-config --> snk-field-config
132
- snk-form-config --> snk-config-options
133
- snk-form-config --> snk-tab-config
134
153
  snk-guides-viewer --> snk-detail-view
135
154
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
136
155
  ```
package/components/snk-data-unit/readme.md CHANGED
@@ -7,31 +7,33 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
12
- | `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
13
- | `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
14
- | `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
15
- | `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
16
- | `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
17
- | `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
18
- | `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
19
- | `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
20
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
22
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
- | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
12
+ | `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
13
+ | `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
14
+ | `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
15
+ | `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
17
+ | `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `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` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
20
+ | `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
21
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
24
25
 
25
26
 
26
27
  ## Events
27
28
 
28
- | Event | Description | Type |
29
- | ------------------------ | --------------------------------------------------------- | -------------------------------- |
30
- | `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
31
- | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
32
- | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
33
- | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
34
- | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
29
+ | Event | Description | Type |
30
+ | ------------------------ | ------------------------------------------------------------- | -------------------------------- |
31
+ | `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
32
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
33
+ | `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
34
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
35
+ | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
36
+ | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
35
37
 
36
38
 
37
39
  ## Methods
@@ -46,6 +48,36 @@ Type: `Promise<DataUnit>`
46
48
 
47
49
 
48
50
 
51
+ ### `getFieldsWithRmPrecision() => Promise<string[]>`
52
+
53
+ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<string[]>`
58
+
59
+
60
+
61
+ ### `getFieldsWithRmp() => Promise<string[]>`
62
+
63
+ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
64
+
65
+ #### Returns
66
+
67
+ Type: `Promise<string[]>`
68
+
69
+
70
+
71
+ ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
72
+
73
+ Busca os metadados da linha selecionada.
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<RowMetadata>`
78
+
79
+
80
+
49
81
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
50
82
 
51
83
  Método que retorna a lista de IDs dos registros selecionados.
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,17 +7,20 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
12
- | `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` |
13
- | `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` |
14
- | `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` |
15
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
17
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
- | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
19
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
20
- | `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
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
19
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
21
24
 
22
25
 
23
26
  ## Events
package/components/snk-form/readme.md CHANGED
@@ -27,6 +27,16 @@
27
27
 
28
28
  ## Methods
29
29
 
30
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
31
+
32
+ Registra um editor customizado para campos da grade e formulário.
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<void>`
37
+
38
+
39
+
30
40
  ### `hideConfig() => Promise<void>`
31
41
 
32
42
  Fecha a janela de configurações do formulário.
@@ -37,6 +47,16 @@ Type: `Promise<void>`
37
47
 
38
48
 
39
49
 
50
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
51
+
52
+ Altera/adiciona uma propriedade nos metadados do campo.
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<void>`
57
+
58
+
59
+
40
60
  ### `showConfig() => Promise<void>`
41
61
 
42
62
  Exibe a janela de configurações do formulário.
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,29 +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
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuraçã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
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
18
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
19
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
20
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
21
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `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. | `boolean` | `undefined` |
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
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
27
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
28
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
29
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
30
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
31
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
32
- | `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
+ | `enableLockManger` | `enable-lock-manger` | Ativa o gerenciamento de locks na grade. | `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
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
24
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
25
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `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. | `boolean` | `undefined` |
28
+ | `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` |
29
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
30
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
31
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
32
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
33
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
34
+ | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
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` |
33
39
 
34
40
 
35
41
  ## Events
@@ -42,6 +48,36 @@
42
48
 
43
49
  ## Methods
44
50
 
51
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
52
+
53
+ Registra um editor customizado para campos da grade e formulário
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<void>`
58
+
59
+
60
+
61
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
62
+
63
+ Registra um formatador de valores para uma coluna da grid.
64
+
65
+ #### Returns
66
+
67
+ Type: `Promise<void>`
68
+
69
+
70
+
71
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
72
+
73
+ Registra um render customizado para colunas da grid.
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
45
81
  ### `findColumn() => Promise<void>`
46
82
 
47
83
  Abre o localizador de colunas
@@ -72,6 +108,16 @@ Type: `Promise<void>`
72
108
 
73
109
 
74
110
 
111
+ ### `reloadConfig() => Promise<void>`
112
+
113
+
114
+
115
+ #### Returns
116
+
117
+ Type: `Promise<void>`
118
+
119
+
120
+
75
121
  ### `reloadFilterBar() => Promise<void>`
76
122
 
77
123
  Faz o recarregamento da filter-bar da grade buscando o state no servidor.
@@ -82,6 +128,16 @@ Type: `Promise<void>`
82
128
 
83
129
 
84
130
 
131
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
132
+
133
+ Remove o formatador de valores de uma coluna da grid.
134
+
135
+ #### Returns
136
+
137
+ Type: `Promise<void>`
138
+
139
+
140
+
85
141
  ### `setConfig(config: IGridConfig) => Promise<void>`
86
142
 
87
143
  Atribui o valor da configuração da grade.
package/components/snk-pesquisa/pesquisa-grid/readme.md ADDED
@@ -0,0 +1,41 @@
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
+
18
+
19
+ ## Events
20
+
21
+ | Event | Description | Type |
22
+ | ------------------------ | ----------- | ---------------------- |
23
+ | `pesquisaGridSelectItem` | | `CustomEvent<IOption>` |
24
+
25
+
26
+ ## Dependencies
27
+
28
+ ### Used by
29
+
30
+ - [snk-pesquisa](..)
31
+
32
+ ### Graph
33
+ ```mermaid
34
+ graph TD;
35
+ snk-pesquisa --> pesquisa-grid
36
+ style pesquisa-grid fill:#f9f,stroke:#333,stroke-width:4px
37
+ ```
38
+
39
+ ----------------------------------------------
40
+
41
+
package/components/snk-pesquisa/pesquisa-tree/readme.md ADDED
@@ -0,0 +1,52 @@
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
+ | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<ITreeItem[]>` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ------------------------ | ----------- | ---------------------- |
21
+ | `pesquisaTreeSelectItem` | | `CustomEvent<IOption>` |
22
+
23
+
24
+ ## Methods
25
+
26
+ ### `applyFilter() => Promise<void>`
27
+
28
+
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+
35
+
36
+
37
+ ## Dependencies
38
+
39
+ ### Used by
40
+
41
+ - [snk-pesquisa](..)
42
+
43
+ ### Graph
44
+ ```mermaid
45
+ graph TD;
46
+ snk-pesquisa --> pesquisa-tree
47
+ style pesquisa-tree fill:#f9f,stroke:#333,stroke-width:4px
48
+ ```
49
+
50
+ ----------------------------------------------
51
+
52
+
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-tree](pesquisa-tree)
30
+ - [pesquisa-grid](pesquisa-grid)
31
+
23
32
  ### Graph
24
33
  ```mermaid
25
34
  graph TD;
35
+ snk-pesquisa --> pesquisa-tree
36
+ snk-pesquisa --> pesquisa-grid
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,25 +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
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
- | `dataState` | -- | | `DataState` | `undefined` |
15
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
16
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
17
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
19
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
20
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
21
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
23
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
24
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
- | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
26
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
27
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
28
- | `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
+ | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
20
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
21
+ | `enableLockManger` | `enable-lock-manger` | | `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` |
29
38
 
30
39
 
31
40
  ## Events
@@ -42,6 +51,36 @@
42
51
 
43
52
  ## Methods
44
53
 
54
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
55
+
56
+ Registra um editor customizado para campos da grade e formulário.
57
+
58
+ #### Returns
59
+
60
+ Type: `Promise<void>`
61
+
62
+
63
+
64
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
65
+
66
+ Registra um formatador de valores para uma coluna da grid.
67
+
68
+ #### Returns
69
+
70
+ Type: `Promise<void>`
71
+
72
+
73
+
74
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
75
+
76
+ Registra um render customizado para colunas da grid.
77
+
78
+ #### Returns
79
+
80
+ Type: `Promise<void>`
81
+
82
+
83
+
45
84
  ### `closeConfigurator() => Promise<void>`
46
85
 
47
86
  Usado para fechar o configurator do CRUD
@@ -82,6 +121,26 @@ Type: `Promise<void>`
82
121
 
83
122
 
84
123
 
124
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
125
+
126
+ Remove o formatador de valores de uma coluna da grid.
127
+
128
+ #### Returns
129
+
130
+ Type: `Promise<void>`
131
+
132
+
133
+
134
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
135
+
136
+ Altera/adiciona uma propriedade nos metadados do campo.
137
+
138
+ #### Returns
139
+
140
+ Type: `Promise<void>`
141
+
142
+
143
+
85
144
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
86
145
 
87
146
 
@@ -121,9 +180,9 @@ Type: `Promise<void>`
121
180
 
122
181
  ### Depends on
123
182
 
124
- - [snk-data-unit](../snk-data-unit)
125
183
  - [snk-taskbar](../snk-taskbar)
126
- - [snk-form-config](../snk-form-config)
184
+ - [snk-data-unit](../snk-data-unit)
185
+ - [snk-simple-form-config](../snk-simple-form-config)
127
186
  - [snk-configurator](../snk-configurator)
128
187
  - [snk-grid-config](../snk-grid-config)
129
188
  - [snk-data-exporter](../snk-data-exporter)
@@ -133,9 +192,9 @@ Type: `Promise<void>`
133
192
  ### Graph
134
193
  ```mermaid
135
194
  graph TD;
136
- snk-simple-crud --> snk-data-unit
137
195
  snk-simple-crud --> snk-taskbar
138
- snk-simple-crud --> snk-form-config
196
+ snk-simple-crud --> snk-data-unit
197
+ snk-simple-crud --> snk-simple-form-config
139
198
  snk-simple-crud --> snk-configurator
140
199
  snk-simple-crud --> snk-grid-config
141
200
  snk-simple-crud --> snk-data-exporter
@@ -145,9 +204,6 @@ graph TD;
145
204
  snk-taskbar --> snk-actions-button
146
205
  snk-taskbar --> taskbar-actions-button
147
206
  snk-data-exporter --> snk-exporter-email-sender
148
- snk-form-config --> snk-field-config
149
- snk-form-config --> snk-config-options
150
- snk-form-config --> snk-tab-config
151
207
  snk-grid-config --> snk-select-box
152
208
  snk-attach --> snk-simple-crud
153
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/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-tree
20
+ snk-pesquisa --> pesquisa-grid
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": "0.0.0-hotfix-ga-KB-5632748.0",
3
+ "version": "0.0.0-hotfix-rc-KB-83760.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [