@sankhyalabs/sankhyablocks-docs 0.0.0-feat-dev-KB-41953.1 → 0.0.0-feat-dev-KB-41953.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-attach/readme.md +7 -0
- package/components/snk-configurator/readme.md +2 -0
- package/components/snk-crud/readme.md +3 -0
- package/components/snk-crud/subcomponents/readme.md +4 -1
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +6 -0
- package/components/snk-form/readme.md +1 -1
- package/components/{snk-form/subcomponents/snk-form-config → snk-form-config}/readme.md +7 -5
- package/components/{snk-form → snk-form-config}/subcomponents/snk-config-options/readme.md +1 -1
- package/components/{snk-form → snk-form-config}/subcomponents/snk-field-config/readme.md +1 -1
- package/components/{snk-form → snk-form-config}/subcomponents/snk-tab-config/readme.md +1 -1
- package/components/snk-grid/readme.md +1 -1
- package/components/{snk-grid/subcomponents/snk-grid-config → snk-grid-config}/readme.md +4 -3
- package/components/{snk-grid/subcomponents → snk-grid-config}/snk-select-box/readme.md +1 -1
- package/components/snk-simple-crud/readme.md +55 -20
- package/package.json +1 -1
|
@@ -44,6 +44,9 @@ graph TD;
|
|
|
44
44
|
snk-attach --> snk-simple-crud
|
|
45
45
|
snk-simple-crud --> snk-data-unit
|
|
46
46
|
snk-simple-crud --> snk-taskbar
|
|
47
|
+
snk-simple-crud --> snk-form-config
|
|
48
|
+
snk-simple-crud --> snk-configurator
|
|
49
|
+
snk-simple-crud --> snk-grid-config
|
|
47
50
|
snk-simple-crud --> snk-data-exporter
|
|
48
51
|
snk-simple-crud --> snk-actions-button
|
|
49
52
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -51,6 +54,10 @@ graph TD;
|
|
|
51
54
|
snk-taskbar --> snk-actions-button
|
|
52
55
|
snk-taskbar --> taskbar-actions-button
|
|
53
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
|
+
snk-grid-config --> snk-select-box
|
|
54
61
|
snk-crud --> snk-attach
|
|
55
62
|
snk-detail-view --> snk-attach
|
|
56
63
|
style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
|
|
@@ -56,12 +56,14 @@ Type: `Promise<void>`
|
|
|
56
56
|
|
|
57
57
|
- [snk-crud](../snk-crud)
|
|
58
58
|
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
59
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
59
60
|
|
|
60
61
|
### Graph
|
|
61
62
|
```mermaid
|
|
62
63
|
graph TD;
|
|
63
64
|
snk-crud --> snk-configurator
|
|
64
65
|
snk-guides-viewer --> snk-configurator
|
|
66
|
+
snk-simple-crud --> snk-configurator
|
|
65
67
|
style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
|
|
66
68
|
```
|
|
67
69
|
|
|
@@ -157,6 +157,9 @@ graph TD;
|
|
|
157
157
|
snk-attach --> snk-simple-crud
|
|
158
158
|
snk-simple-crud --> snk-data-unit
|
|
159
159
|
snk-simple-crud --> snk-taskbar
|
|
160
|
+
snk-simple-crud --> snk-form-config
|
|
161
|
+
snk-simple-crud --> snk-configurator
|
|
162
|
+
snk-simple-crud --> snk-grid-config
|
|
160
163
|
snk-simple-crud --> snk-data-exporter
|
|
161
164
|
snk-simple-crud --> snk-actions-button
|
|
162
165
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -70,7 +70,7 @@ Type: `Promise<void>`
|
|
|
70
70
|
- [snk-data-unit](../../snk-data-unit)
|
|
71
71
|
- [snk-detail-view](snk-detail-view)
|
|
72
72
|
- [snk-taskbar](../../snk-taskbar)
|
|
73
|
-
- [snk-form-config](../../snk-form
|
|
73
|
+
- [snk-form-config](../../snk-form-config)
|
|
74
74
|
- [snk-configurator](../../snk-configurator)
|
|
75
75
|
- [snk-data-exporter](../../snk-data-exporter)
|
|
76
76
|
- [snk-actions-button](../../snk-actions-button)
|
|
@@ -124,6 +124,9 @@ graph TD;
|
|
|
124
124
|
snk-attach --> snk-simple-crud
|
|
125
125
|
snk-simple-crud --> snk-data-unit
|
|
126
126
|
snk-simple-crud --> snk-taskbar
|
|
127
|
+
snk-simple-crud --> snk-form-config
|
|
128
|
+
snk-simple-crud --> snk-configurator
|
|
129
|
+
snk-simple-crud --> snk-grid-config
|
|
127
130
|
snk-simple-crud --> snk-data-exporter
|
|
128
131
|
snk-simple-crud --> snk-actions-button
|
|
129
132
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -122,9 +122,15 @@ graph TD;
|
|
|
122
122
|
snk-attach --> snk-simple-crud
|
|
123
123
|
snk-simple-crud --> snk-data-unit
|
|
124
124
|
snk-simple-crud --> snk-taskbar
|
|
125
|
+
snk-simple-crud --> snk-form-config
|
|
126
|
+
snk-simple-crud --> snk-configurator
|
|
127
|
+
snk-simple-crud --> snk-grid-config
|
|
125
128
|
snk-simple-crud --> snk-data-exporter
|
|
126
129
|
snk-simple-crud --> snk-actions-button
|
|
127
130
|
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
|
|
128
134
|
snk-guides-viewer --> snk-detail-view
|
|
129
135
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
130
136
|
```
|
|
@@ -26,14 +26,15 @@
|
|
|
26
26
|
|
|
27
27
|
### Used by
|
|
28
28
|
|
|
29
|
-
- [snk-form](
|
|
30
|
-
- [snk-guides-viewer](
|
|
29
|
+
- [snk-form](../snk-form)
|
|
30
|
+
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
31
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
31
32
|
|
|
32
33
|
### Depends on
|
|
33
34
|
|
|
34
|
-
- [snk-field-config](
|
|
35
|
-
- [snk-config-options](
|
|
36
|
-
- [snk-tab-config](
|
|
35
|
+
- [snk-field-config](./subcomponents/snk-field-config)
|
|
36
|
+
- [snk-config-options](./subcomponents/snk-config-options)
|
|
37
|
+
- [snk-tab-config](./subcomponents/snk-tab-config)
|
|
37
38
|
|
|
38
39
|
### Graph
|
|
39
40
|
```mermaid
|
|
@@ -43,6 +44,7 @@ graph TD;
|
|
|
43
44
|
snk-form-config --> snk-tab-config
|
|
44
45
|
snk-form --> snk-form-config
|
|
45
46
|
snk-guides-viewer --> snk-form-config
|
|
47
|
+
snk-simple-crud --> snk-form-config
|
|
46
48
|
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
47
49
|
```
|
|
48
50
|
|
|
@@ -114,7 +114,7 @@ Type: `Promise<void>`
|
|
|
114
114
|
|
|
115
115
|
- [snk-filter-bar](../snk-filter-bar)
|
|
116
116
|
- [snk-taskbar](../snk-taskbar)
|
|
117
|
-
- [snk-grid-config](
|
|
117
|
+
- [snk-grid-config](../snk-grid-config)
|
|
118
118
|
- [snk-data-exporter](../snk-data-exporter)
|
|
119
119
|
- [snk-actions-button](../snk-actions-button)
|
|
120
120
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
|
|
12
|
-
| `application` | -- | Referência para o SnkApplication | `SnkApplication` | `undefined` |
|
|
13
12
|
| `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
|
|
14
13
|
| `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
|
|
15
14
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
@@ -29,17 +28,19 @@
|
|
|
29
28
|
|
|
30
29
|
### Used by
|
|
31
30
|
|
|
32
|
-
- [snk-grid](
|
|
31
|
+
- [snk-grid](../snk-grid)
|
|
32
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
33
33
|
|
|
34
34
|
### Depends on
|
|
35
35
|
|
|
36
|
-
- [snk-select-box](
|
|
36
|
+
- [snk-select-box](snk-select-box)
|
|
37
37
|
|
|
38
38
|
### Graph
|
|
39
39
|
```mermaid
|
|
40
40
|
graph TD;
|
|
41
41
|
snk-grid-config --> snk-select-box
|
|
42
42
|
snk-grid --> snk-grid-config
|
|
43
|
+
snk-simple-crud --> snk-grid-config
|
|
43
44
|
style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
44
45
|
```
|
|
45
46
|
|
|
@@ -7,34 +7,49 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `configName`
|
|
14
|
-
| `dataState`
|
|
15
|
-
| `dataUnit`
|
|
16
|
-
| `formConfig`
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
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
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
21
|
+
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
|
22
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
|
23
|
+
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
|
|
24
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
25
|
+
| `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
|
|
26
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
24
27
|
|
|
25
28
|
|
|
26
29
|
## Events
|
|
27
30
|
|
|
28
|
-
| Event
|
|
29
|
-
|
|
|
30
|
-
| `actionClick`
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
31
|
+
| Event | Description | Type |
|
|
32
|
+
| -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
33
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
34
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
35
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
36
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
|
37
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
|
38
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
34
39
|
|
|
35
40
|
|
|
36
41
|
## Methods
|
|
37
42
|
|
|
43
|
+
### `closeConfigurator() => Promise<void>`
|
|
44
|
+
|
|
45
|
+
Usado para fechar o configurator do CRUD
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
Type: `Promise<void>`
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
38
53
|
### `getRecords() => Promise<Array<Record>>`
|
|
39
54
|
|
|
40
55
|
|
|
@@ -55,6 +70,16 @@ Type: `Promise<void>`
|
|
|
55
70
|
|
|
56
71
|
|
|
57
72
|
|
|
73
|
+
### `openConfigurator() => Promise<void>`
|
|
74
|
+
|
|
75
|
+
Usado para abrir o configurator do CRUD
|
|
76
|
+
|
|
77
|
+
#### Returns
|
|
78
|
+
|
|
79
|
+
Type: `Promise<void>`
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
58
83
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
59
84
|
|
|
60
85
|
|
|
@@ -86,6 +111,9 @@ Type: `Promise<void>`
|
|
|
86
111
|
|
|
87
112
|
- [snk-data-unit](../snk-data-unit)
|
|
88
113
|
- [snk-taskbar](../snk-taskbar)
|
|
114
|
+
- [snk-form-config](../snk-form-config)
|
|
115
|
+
- [snk-configurator](../snk-configurator)
|
|
116
|
+
- [snk-grid-config](../snk-grid-config)
|
|
89
117
|
- [snk-data-exporter](../snk-data-exporter)
|
|
90
118
|
- [snk-actions-button](../snk-actions-button)
|
|
91
119
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
@@ -95,6 +123,9 @@ Type: `Promise<void>`
|
|
|
95
123
|
graph TD;
|
|
96
124
|
snk-simple-crud --> snk-data-unit
|
|
97
125
|
snk-simple-crud --> snk-taskbar
|
|
126
|
+
snk-simple-crud --> snk-form-config
|
|
127
|
+
snk-simple-crud --> snk-configurator
|
|
128
|
+
snk-simple-crud --> snk-grid-config
|
|
98
129
|
snk-simple-crud --> snk-data-exporter
|
|
99
130
|
snk-simple-crud --> snk-actions-button
|
|
100
131
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -102,6 +133,10 @@ graph TD;
|
|
|
102
133
|
snk-taskbar --> snk-actions-button
|
|
103
134
|
snk-taskbar --> taskbar-actions-button
|
|
104
135
|
snk-data-exporter --> snk-exporter-email-sender
|
|
136
|
+
snk-form-config --> snk-field-config
|
|
137
|
+
snk-form-config --> snk-config-options
|
|
138
|
+
snk-form-config --> snk-tab-config
|
|
139
|
+
snk-grid-config --> snk-select-box
|
|
105
140
|
snk-attach --> snk-simple-crud
|
|
106
141
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|
|
107
142
|
```
|