@sankhyalabs/sankhyablocks-docs 9.0.2 → 9.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/components/snk-application/readme.md +10 -0
  2. package/components/snk-attach/readme.md +2 -0
  3. package/components/snk-configurator/readme.md +7 -0
  4. package/components/snk-crud/readme.md +3 -0
  5. package/components/snk-crud/subcomponents/readme.md +2 -0
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +2 -0
  7. package/components/snk-layout-form-config/readme.md +41 -0
  8. package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
  9. package/components/snk-simple-crud/readme.md +3 -0
  10. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -292,6 +292,16 @@ Type: `Promise<KeyboardManager>`
292
292
 
293
293
  the keyboard manager
294
294
 
295
+ ### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
296
+
297
+ Obtém o notificador de Layout de formulario.
298
+
299
+ #### Returns
300
+
301
+ Type: `Promise<LayoutFormConfig>`
302
+
303
+ the Configurador de Layout do Formulario
304
+
295
305
  ### `getResourceID() => Promise<string>`
296
306
 
297
307
  Obtém o resourceID da tela em questão.
package/components/snk-attach/readme.md CHANGED
@@ -54,6 +54,8 @@ 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-configurator --> snk-layout-form-config
58
+ snk-layout-form-config --> snk-view-representation
57
59
  snk-grid-config --> snk-select-box
58
60
  snk-crud --> snk-attach
59
61
  snk-detail-view --> snk-attach
package/components/snk-configurator/readme.md CHANGED
@@ -11,6 +11,7 @@
11
11
  | ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
12
  | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
13
  | `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator. | `string` | `undefined` |
14
+ | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
14
15
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
16
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
16
17
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
@@ -58,9 +59,15 @@ Type: `Promise<void>`
58
59
  - [snk-guides-viewer](../snk-crud/subcomponents)
59
60
  - [snk-simple-crud](../snk-simple-crud)
60
61
 
62
+ ### Depends on
63
+
64
+ - [snk-layout-form-config](../snk-layout-form-config)
65
+
61
66
  ### Graph
62
67
  ```mermaid
63
68
  graph TD;
69
+ snk-configurator --> snk-layout-form-config
70
+ snk-layout-form-config --> snk-view-representation
64
71
  snk-crud --> snk-configurator
65
72
  snk-guides-viewer --> snk-configurator
66
73
  snk-simple-crud --> snk-configurator
package/components/snk-crud/readme.md CHANGED
@@ -23,6 +23,7 @@
23
23
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
24
24
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
25
25
  | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
26
+ | `layoutFormConfig` | `layout-form-config` | | `boolean` | `false` |
26
27
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
27
28
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
28
29
  | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
@@ -224,6 +225,8 @@ graph TD;
224
225
  snk-simple-crud --> snk-data-exporter
225
226
  snk-simple-crud --> snk-actions-button
226
227
  snk-simple-crud --> taskbar-actions-button
228
+ snk-configurator --> snk-layout-form-config
229
+ snk-layout-form-config --> snk-view-representation
227
230
  snk-form-config --> snk-field-config
228
231
  snk-form-config --> snk-config-options
229
232
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -173,6 +173,8 @@ graph TD;
173
173
  snk-simple-crud --> snk-data-exporter
174
174
  snk-simple-crud --> snk-actions-button
175
175
  snk-simple-crud --> taskbar-actions-button
176
+ snk-configurator --> snk-layout-form-config
177
+ snk-layout-form-config --> snk-view-representation
176
178
  snk-form-config --> snk-field-config
177
179
  snk-form-config --> snk-config-options
178
180
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -150,6 +150,8 @@ graph TD;
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-configurator --> snk-layout-form-config
154
+ snk-layout-form-config --> snk-view-representation
153
155
  snk-guides-viewer --> snk-detail-view
154
156
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
155
157
  ```
package/components/snk-layout-form-config/readme.md ADDED
@@ -0,0 +1,41 @@
1
+ # snk-layout-form-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Methods
9
+
10
+ ### `save() => Promise<void>`
11
+
12
+ Salva o tipo de layout escolhido. Sem retorno.
13
+
14
+ #### Returns
15
+
16
+ Type: `Promise<void>`
17
+
18
+
19
+
20
+
21
+ ## Dependencies
22
+
23
+ ### Used by
24
+
25
+ - [snk-configurator](../snk-configurator)
26
+
27
+ ### Depends on
28
+
29
+ - [snk-view-representation](snk-view-representation)
30
+
31
+ ### Graph
32
+ ```mermaid
33
+ graph TD;
34
+ snk-layout-form-config --> snk-view-representation
35
+ snk-configurator --> snk-layout-form-config
36
+ style snk-layout-form-config fill:#f9f,stroke:#333,stroke-width:4px
37
+ ```
38
+
39
+ ----------------------------------------------
40
+
41
+
package/components/snk-layout-form-config/snk-view-representation/readme.md ADDED
@@ -0,0 +1,30 @@
1
+ # snk-view-representation
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | ---------------------------------------------------------- | ------------ | ------------------------- |
12
+ | `mode` | `mode` | Define o layout do componente: 'CASCADE' ou 'SIDE_BY_SIDE' | `FormLayout` | `FormLayout.SIDE_BY_SIDE` |
13
+
14
+
15
+ ## Dependencies
16
+
17
+ ### Used by
18
+
19
+ - [snk-layout-form-config](..)
20
+
21
+ ### Graph
22
+ ```mermaid
23
+ graph TD;
24
+ snk-layout-form-config --> snk-view-representation
25
+ style snk-view-representation fill:#f9f,stroke:#333,stroke-width:4px
26
+ ```
27
+
28
+ ----------------------------------------------
29
+
30
+
package/components/snk-simple-crud/readme.md CHANGED
@@ -26,6 +26,7 @@
26
26
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
27
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
28
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` |
29
30
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
30
31
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
31
32
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
@@ -206,6 +207,8 @@ graph TD;
206
207
  snk-taskbar --> snk-actions-button
207
208
  snk-taskbar --> taskbar-actions-button
208
209
  snk-data-exporter --> snk-exporter-email-sender
210
+ snk-configurator --> snk-layout-form-config
211
+ snk-layout-form-config --> snk-view-representation
209
212
  snk-grid-config --> snk-select-box
210
213
  snk-attach --> snk-simple-crud
211
214
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.0.2",
3
+ "version": "9.0.3",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [