@sankhyalabs/sankhyablocks-docs 5.8.1 → 5.9.0

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 (9) hide show
  1. package/components/snk-attach/readme.md +2 -0
  2. package/components/snk-crud/readme.md +4 -3
  3. package/components/snk-crud/subcomponents/readme.md +7 -1
  4. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +110 -0
  5. package/components/snk-data-exporter/readme.md +1 -1
  6. package/components/snk-data-unit/readme.md +1 -1
  7. package/components/snk-grid/readme.md +1 -1
  8. package/components/snk-taskbar/readme.md +1 -1
  9. package/package.json +1 -1
package/components/snk-attach/readme.md CHANGED
@@ -26,6 +26,7 @@
26
26
  ### Used by
27
27
 
28
28
  - [snk-crud](../snk-crud)
29
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
29
30
 
30
31
  ### Depends on
31
32
 
@@ -43,6 +44,7 @@ graph TD;
43
44
  snk-taskbar --> snk-data-exporter
44
45
  snk-data-exporter --> snk-exporter-email-sender
45
46
  snk-crud --> snk-attach
47
+ snk-detail-view --> snk-attach
46
48
  style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
47
49
  ```
48
50
 
package/components/snk-crud/readme.md CHANGED
@@ -78,15 +78,16 @@ graph TD;
78
78
  snk-detail-view --> snk-grid
79
79
  snk-detail-view --> snk-form-view
80
80
  snk-detail-view --> snk-taskbar
81
+ snk-detail-view --> snk-attach
81
82
  snk-detail-view --> snk-data-exporter
82
- snk-form-config --> snk-field-config
83
- snk-form-config --> snk-config-options
84
- snk-form-config --> snk-tab-config
85
83
  snk-attach --> snk-simple-bar
86
84
  snk-attach --> snk-simple-crud
87
85
  snk-simple-crud --> snk-data-unit
88
86
  snk-simple-crud --> snk-taskbar
89
87
  snk-simple-crud --> snk-data-exporter
88
+ snk-form-config --> snk-field-config
89
+ snk-form-config --> snk-config-options
90
+ snk-form-config --> snk-tab-config
90
91
  style snk-crud fill:#f9f,stroke:#333,stroke-width:4px
91
92
  ```
92
93
 
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -54,7 +54,7 @@ Type: `Promise<void>`
54
54
 
55
55
  - [snk-form-view](.)
56
56
  - [snk-data-unit](../../snk-data-unit)
57
- - [snk-detail-view](.)
57
+ - [snk-detail-view](snk-detail-view)
58
58
  - [snk-taskbar](../../snk-taskbar)
59
59
  - [snk-form-config](../../snk-form/subcomponents/snk-form-config)
60
60
  - [snk-configurator](../../snk-configurator)
@@ -75,6 +75,7 @@ graph TD;
75
75
  snk-detail-view --> snk-grid
76
76
  snk-detail-view --> snk-form-view
77
77
  snk-detail-view --> snk-taskbar
78
+ snk-detail-view --> snk-attach
78
79
  snk-detail-view --> snk-data-exporter
79
80
  snk-grid --> snk-filter-bar
80
81
  snk-grid --> snk-taskbar
@@ -85,6 +86,11 @@ graph TD;
85
86
  snk-taskbar --> snk-data-exporter
86
87
  snk-data-exporter --> snk-exporter-email-sender
87
88
  snk-grid-config --> snk-select-box
89
+ snk-attach --> snk-simple-bar
90
+ snk-attach --> snk-simple-crud
91
+ snk-simple-crud --> snk-data-unit
92
+ snk-simple-crud --> snk-taskbar
93
+ snk-simple-crud --> snk-data-exporter
88
94
  snk-form-config --> snk-field-config
89
95
  snk-form-config --> snk-config-options
90
96
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/snk-detail-view/readme.md ADDED
@@ -0,0 +1,110 @@
1
+ # snk-detail-view
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | ---------------- | ----------------------------------------------------------- | ---------------------- | ----------- |
12
+ | `branchGuide` | -- | | `IGuideItem` | `undefined` |
13
+ | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
14
+ | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
15
+ | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
16
+ | `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
17
+ | `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
18
+ | `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
19
+ | `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
20
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
21
+ | `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
22
+
23
+
24
+ ## Events
25
+
26
+ | Event | Description | Type |
27
+ | ----------------------- | ---------------------------------------------------------------- | --------------------------- |
28
+ | `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias. | `CustomEvent<GuideBuilder>` |
29
+ | `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
30
+
31
+
32
+ ## Methods
33
+
34
+ ### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
35
+
36
+ Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
37
+
38
+ #### Returns
39
+
40
+ Type: `Promise<void>`
41
+
42
+
43
+
44
+ ### `configGrid() => Promise<void>`
45
+
46
+ Abre o configurador de grid.
47
+
48
+ #### Returns
49
+
50
+ Type: `Promise<void>`
51
+
52
+
53
+
54
+ ### `showUp() => Promise<void>`
55
+
56
+
57
+
58
+ #### Returns
59
+
60
+ Type: `Promise<void>`
61
+
62
+
63
+
64
+
65
+ ## Dependencies
66
+
67
+ ### Used by
68
+
69
+ - [snk-guides-viewer](..)
70
+
71
+ ### Depends on
72
+
73
+ - [snk-data-unit](../../../snk-data-unit)
74
+ - [snk-grid](../../../snk-grid)
75
+ - [snk-form-view](..)
76
+ - [snk-taskbar](../../../snk-taskbar)
77
+ - [snk-attach](../../../snk-attach)
78
+ - [snk-data-exporter](../../../snk-data-exporter)
79
+
80
+ ### Graph
81
+ ```mermaid
82
+ graph TD;
83
+ snk-detail-view --> snk-data-unit
84
+ snk-detail-view --> snk-grid
85
+ snk-detail-view --> snk-form-view
86
+ snk-detail-view --> snk-taskbar
87
+ snk-detail-view --> snk-attach
88
+ snk-detail-view --> snk-data-exporter
89
+ snk-grid --> snk-filter-bar
90
+ snk-grid --> snk-taskbar
91
+ snk-grid --> snk-grid-config
92
+ snk-grid --> snk-data-exporter
93
+ snk-filter-bar --> snk-filter-item
94
+ snk-filter-item --> snk-filter-detail
95
+ snk-taskbar --> snk-data-exporter
96
+ snk-data-exporter --> snk-exporter-email-sender
97
+ snk-grid-config --> snk-select-box
98
+ snk-form-view --> snk-form-summary
99
+ snk-attach --> snk-simple-bar
100
+ snk-attach --> snk-simple-crud
101
+ snk-simple-crud --> snk-data-unit
102
+ snk-simple-crud --> snk-taskbar
103
+ snk-simple-crud --> snk-data-exporter
104
+ snk-guides-viewer --> snk-detail-view
105
+ style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
106
+ ```
107
+
108
+ ----------------------------------------------
109
+
110
+
package/components/snk-data-exporter/readme.md CHANGED
@@ -18,7 +18,7 @@
18
18
  ### Used by
19
19
 
20
20
  - [snk-crud](../snk-crud)
21
- - [snk-detail-view](../snk-crud/subcomponents)
21
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
22
22
  - [snk-grid](../snk-grid)
23
23
  - [snk-guides-viewer](../snk-crud/subcomponents)
24
24
  - [snk-simple-crud](../snk-simple-crud)
package/components/snk-data-unit/readme.md CHANGED
@@ -58,7 +58,7 @@ Retorna a lista de IDs dos registros selecionados.
58
58
 
59
59
  ### Used by
60
60
 
61
- - [snk-detail-view](../snk-crud/subcomponents)
61
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
62
62
  - [snk-guides-viewer](../snk-crud/subcomponents)
63
63
  - [snk-simple-crud](../snk-simple-crud)
64
64
 
package/components/snk-grid/readme.md CHANGED
@@ -65,7 +65,7 @@ Type: `Promise<void>`
65
65
  ### Used by
66
66
 
67
67
  - [snk-crud](../snk-crud)
68
- - [snk-detail-view](../snk-crud/subcomponents)
68
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
69
69
 
70
70
  ### Depends on
71
71
 
package/components/snk-taskbar/readme.md CHANGED
@@ -31,7 +31,7 @@
31
31
 
32
32
  ### Used by
33
33
 
34
- - [snk-detail-view](../snk-crud/subcomponents)
34
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
35
35
  - [snk-grid](../snk-grid)
36
36
  - [snk-guides-viewer](../snk-crud/subcomponents)
37
37
  - [snk-simple-crud](../snk-simple-crud)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "5.8.1",
3
+ "version": "5.9.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [