@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-5693172.1 → 0.0.0-hotfix-ga-5726442.1

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 (20) hide show
  1. package/components/snk-application/readme.md +62 -8
  2. package/components/snk-attach/readme.md +4 -5
  3. package/components/snk-configurator/readme.md +7 -0
  4. package/components/snk-crud/readme.md +90 -26
  5. package/components/snk-crud/subcomponents/readme.md +37 -2
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +26 -5
  7. package/components/snk-data-unit/readme.md +53 -21
  8. package/components/snk-filter-bar/readme.md +15 -11
  9. package/components/snk-form/readme.md +20 -0
  10. package/components/snk-form-config/readme.md +6 -7
  11. package/components/snk-grid/readme.md +81 -23
  12. package/components/snk-layout-form-config/readme.md +41 -0
  13. package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
  14. package/components/snk-pesquisa/pesquisa-grid/readme.md +42 -0
  15. package/components/snk-pesquisa/pesquisa-tree/readme.md +53 -0
  16. package/components/snk-pesquisa/readme.md +16 -5
  17. package/components/snk-simple-crud/readme.md +87 -26
  18. package/components/snk-simple-form-config/readme.md +51 -0
  19. package/components/teste-pesquisa/readme.md +2 -0
  20. package/package.json +1 -1
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,25 +7,37 @@
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
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
22
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
24
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
26
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
28
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
29
+ | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
30
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
33
+ | `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` |
34
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
35
+ | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
36
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
37
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
38
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
39
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
40
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
29
41
 
30
42
 
31
43
  ## Events
@@ -42,6 +54,36 @@
42
54
 
43
55
  ## Methods
44
56
 
57
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
58
+
59
+ Registra um editor customizado para campos da grade e formulário.
60
+
61
+ #### Returns
62
+
63
+ Type: `Promise<void>`
64
+
65
+
66
+
67
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
68
+
69
+ Registra um formatador de valores para uma coluna da grid.
70
+
71
+ #### Returns
72
+
73
+ Type: `Promise<void>`
74
+
75
+
76
+
77
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
78
+
79
+ Registra um render customizado para colunas da grid.
80
+
81
+ #### Returns
82
+
83
+ Type: `Promise<void>`
84
+
85
+
86
+
45
87
  ### `closeConfigurator() => Promise<void>`
46
88
 
47
89
  Usado para fechar o configurator do CRUD
@@ -82,6 +124,26 @@ Type: `Promise<void>`
82
124
 
83
125
 
84
126
 
127
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
128
+
129
+ Remove o formatador de valores de uma coluna da grid.
130
+
131
+ #### Returns
132
+
133
+ Type: `Promise<void>`
134
+
135
+
136
+
137
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
138
+
139
+ Altera/adiciona uma propriedade nos metadados do campo.
140
+
141
+ #### Returns
142
+
143
+ Type: `Promise<void>`
144
+
145
+
146
+
85
147
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
86
148
 
87
149
 
@@ -121,9 +183,9 @@ Type: `Promise<void>`
121
183
 
122
184
  ### Depends on
123
185
 
124
- - [snk-data-unit](../snk-data-unit)
125
186
  - [snk-taskbar](../snk-taskbar)
126
- - [snk-form-config](../snk-form-config)
187
+ - [snk-data-unit](../snk-data-unit)
188
+ - [snk-simple-form-config](../snk-simple-form-config)
127
189
  - [snk-configurator](../snk-configurator)
128
190
  - [snk-grid-config](../snk-grid-config)
129
191
  - [snk-data-exporter](../snk-data-exporter)
@@ -133,9 +195,9 @@ Type: `Promise<void>`
133
195
  ### Graph
134
196
  ```mermaid
135
197
  graph TD;
136
- snk-simple-crud --> snk-data-unit
137
198
  snk-simple-crud --> snk-taskbar
138
- snk-simple-crud --> snk-form-config
199
+ snk-simple-crud --> snk-data-unit
200
+ snk-simple-crud --> snk-simple-form-config
139
201
  snk-simple-crud --> snk-configurator
140
202
  snk-simple-crud --> snk-grid-config
141
203
  snk-simple-crud --> snk-data-exporter
@@ -145,9 +207,8 @@ graph TD;
145
207
  snk-taskbar --> snk-actions-button
146
208
  snk-taskbar --> taskbar-actions-button
147
209
  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
210
+ snk-configurator --> snk-layout-form-config
211
+ snk-layout-form-config --> snk-view-representation
151
212
  snk-grid-config --> snk-select-box
152
213
  snk-attach --> snk-simple-crud
153
214
  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-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": "0.0.0-hotfix-ga-5693172.1",
3
+ "version": "0.0.0-hotfix-ga-5726442.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [