@sankhyalabs/sankhyablocks-docs 8.15.0-dev.30 → 8.15.0-dev.32

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