@sankhyalabs/sankhyablocks-docs 8.16.0-dev.99 → 8.16.0-ms.2
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.
- package/components/snk-application/readme.md +0 -10
- package/components/snk-attach/readme.md +0 -2
- package/components/snk-configurator/readme.md +0 -7
- package/components/snk-crud/readme.md +0 -3
- package/components/snk-crud/subcomponents/readme.md +0 -2
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +17 -20
- package/components/snk-simple-crud/readme.md +0 -3
- package/package.json +1 -1
- package/components/snk-layout-form-config/readme.md +0 -41
- package/components/snk-layout-form-config/snk-view-representation/readme.md +0 -30
@@ -292,16 +292,6 @@ 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
|
-
|
305
295
|
### `getResourceID() => Promise<string>`
|
306
296
|
|
307
297
|
Obtém o resourceID da tela em questão.
|
@@ -54,8 +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-configurator --> snk-layout-form-config
|
58
|
-
snk-layout-form-config --> snk-view-representation
|
59
57
|
snk-grid-config --> snk-select-box
|
60
58
|
snk-crud --> snk-attach
|
61
59
|
snk-detail-view --> snk-attach
|
@@ -11,7 +11,6 @@
|
|
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` |
|
15
14
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
16
15
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
17
16
|
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
|
@@ -59,15 +58,9 @@ Type: `Promise<void>`
|
|
59
58
|
- [snk-guides-viewer](../snk-crud/subcomponents)
|
60
59
|
- [snk-simple-crud](../snk-simple-crud)
|
61
60
|
|
62
|
-
### Depends on
|
63
|
-
|
64
|
-
- [snk-layout-form-config](../snk-layout-form-config)
|
65
|
-
|
66
61
|
### Graph
|
67
62
|
```mermaid
|
68
63
|
graph TD;
|
69
|
-
snk-configurator --> snk-layout-form-config
|
70
|
-
snk-layout-form-config --> snk-view-representation
|
71
64
|
snk-crud --> snk-configurator
|
72
65
|
snk-guides-viewer --> snk-configurator
|
73
66
|
snk-simple-crud --> snk-configurator
|
@@ -23,7 +23,6 @@
|
|
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` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
|
27
26
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
28
27
|
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
29
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` |
|
@@ -224,8 +223,6 @@ graph TD;
|
|
224
223
|
snk-simple-crud --> snk-data-exporter
|
225
224
|
snk-simple-crud --> snk-actions-button
|
226
225
|
snk-simple-crud --> taskbar-actions-button
|
227
|
-
snk-configurator --> snk-layout-form-config
|
228
|
-
snk-layout-form-config --> snk-view-representation
|
229
226
|
snk-form-config --> snk-field-config
|
230
227
|
snk-form-config --> snk-config-options
|
231
228
|
snk-form-config --> snk-tab-config
|
@@ -173,8 +173,6 @@ 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
|
178
176
|
snk-form-config --> snk-field-config
|
179
177
|
snk-form-config --> snk-config-options
|
180
178
|
snk-form-config --> snk-tab-config
|
@@ -7,24 +7,23 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- |
|
12
|
-
| `branchGuide` | -- | | `IGuideItem`
|
13
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
14
|
-
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor`
|
15
|
-
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender`
|
16
|
-
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState`
|
17
|
-
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit`
|
18
|
-
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string`
|
19
|
-
| `entityName` | `entity-name` | Nome da entidade detail. | `string`
|
20
|
-
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager`
|
21
|
-
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]`
|
22
|
-
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string`
|
23
|
-
| `messagesBuilder` | -- | | `SnkMessageBuilder`
|
24
|
-
| `
|
25
|
-
| `
|
26
|
-
| `
|
27
|
-
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ---------------------- | ----------- |
|
12
|
+
| `branchGuide` | -- | | `IGuideItem` | `undefined` |
|
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` |
|
16
|
+
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
|
17
|
+
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
|
18
|
+
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
|
19
|
+
| `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
|
20
|
+
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
|
21
|
+
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
|
22
|
+
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
|
23
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
24
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
25
|
+
| `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
|
26
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
28
27
|
|
29
28
|
|
30
29
|
## Events
|
@@ -151,8 +150,6 @@ graph TD;
|
|
151
150
|
snk-simple-crud --> snk-data-exporter
|
152
151
|
snk-simple-crud --> snk-actions-button
|
153
152
|
snk-simple-crud --> taskbar-actions-button
|
154
|
-
snk-configurator --> snk-layout-form-config
|
155
|
-
snk-layout-form-config --> snk-view-representation
|
156
153
|
snk-guides-viewer --> snk-detail-view
|
157
154
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
158
155
|
```
|
@@ -26,7 +26,6 @@
|
|
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` |
|
30
29
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
31
30
|
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
32
31
|
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
@@ -206,8 +205,6 @@ graph TD;
|
|
206
205
|
snk-taskbar --> snk-actions-button
|
207
206
|
snk-taskbar --> taskbar-actions-button
|
208
207
|
snk-data-exporter --> snk-exporter-email-sender
|
209
|
-
snk-configurator --> snk-layout-form-config
|
210
|
-
snk-layout-form-config --> snk-view-representation
|
211
208
|
snk-grid-config --> snk-select-box
|
212
209
|
snk-attach --> snk-simple-crud
|
213
210
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|
package/package.json
CHANGED
@@ -1,41 +0,0 @@
|
|
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
|
-
|
@@ -1,30 +0,0 @@
|
|
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
|
-
|