@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-KB-5516.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 (41) hide show
  1. package/components/snk-actions-button/readme.md +33 -0
  2. package/components/snk-actions-button/subcomponents/readme.md +33 -0
  3. package/components/snk-application/readme.md +482 -0
  4. package/components/snk-attach/readme.md +55 -0
  5. package/components/snk-configurator/readme.md +68 -0
  6. package/components/snk-crud/readme.md +147 -0
  7. package/components/snk-crud/subcomponents/readme.md +119 -0
  8. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +125 -0
  9. package/components/snk-data-exporter/exporter-email-sender/readme.md +53 -0
  10. package/components/snk-data-exporter/readme.md +46 -0
  11. package/components/snk-data-unit/readme.md +76 -0
  12. package/components/snk-entity-list/readme.md +40 -0
  13. package/components/snk-filter-bar/filter-item/editors/readme.md +25 -0
  14. package/components/snk-filter-bar/filter-item/editors/snk-personalized-filter-editor/readme.md +43 -0
  15. package/components/snk-filter-bar/filter-item/readme.md +67 -0
  16. package/components/snk-filter-bar/filter-list/readme.md +43 -0
  17. package/components/snk-filter-bar/filter-modal/readme.md +36 -0
  18. package/components/snk-filter-bar/filter-modal/subcomponents/readme.md +40 -0
  19. package/components/snk-filter-bar/readme.md +63 -0
  20. package/components/snk-filter-field-search/readme.md +65 -0
  21. package/components/snk-form/readme.md +66 -0
  22. package/components/snk-form/subcomponents/snk-config-options/readme.md +40 -0
  23. package/components/snk-form/subcomponents/snk-field-config/readme.md +41 -0
  24. package/components/snk-form/subcomponents/snk-form-config/readme.md +51 -0
  25. package/components/snk-form/subcomponents/snk-tab-config/readme.md +46 -0
  26. package/components/snk-grid/readme.md +120 -0
  27. package/components/snk-grid/subcomponents/snk-grid-config/readme.md +47 -0
  28. package/components/snk-grid/subcomponents/snk-select-box/readme.md +37 -0
  29. package/components/snk-personalized-filter/readme.md +70 -0
  30. package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +65 -0
  31. package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +48 -0
  32. package/components/snk-personalized-filter/subcomponents/snk-filter-advanced-mode/readme.md +38 -0
  33. package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +50 -0
  34. package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +53 -0
  35. package/components/snk-pesquisa/readme.md +32 -0
  36. package/components/snk-print-selector/readme.md +23 -0
  37. package/components/snk-simple-bar/readme.md +42 -0
  38. package/components/snk-simple-crud/readme.md +104 -0
  39. package/components/snk-taskbar/readme.md +59 -0
  40. package/components/teste-pesquisa/readme.md +24 -0
  41. package/package.json +14 -0
package/components/snk-crud/readme.md ADDED
@@ -0,0 +1,147 @@
1
+ # snk-crud
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
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
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
16
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
17
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
18
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
19
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
20
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `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
+
23
+
24
+ ## Events
25
+
26
+ | Event | Description | Type |
27
+ | -------------------- | ---------------------------------------------------------------------------- | --------------------- |
28
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
29
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
30
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
31
+
32
+
33
+ ## Methods
34
+
35
+ ### `closeConfigurator() => Promise<void>`
36
+
37
+ Usado para fechar o configurator do CRUD
38
+
39
+ #### Returns
40
+
41
+ Type: `Promise<void>`
42
+
43
+
44
+
45
+ ### `goToView(mode: string) => Promise<void>`
46
+
47
+ Usado para alternar a visão entre GRID e FORM externamente.
48
+
49
+ #### Returns
50
+
51
+ Type: `Promise<void>`
52
+
53
+
54
+
55
+ ### `openConfigurator() => Promise<void>`
56
+
57
+ Usado para abrir o configurator do CRUD
58
+
59
+ #### Returns
60
+
61
+ Type: `Promise<void>`
62
+
63
+
64
+
65
+ ### `reloadFilterBar() => Promise<void>`
66
+
67
+ Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
68
+
69
+ #### Returns
70
+
71
+ Type: `Promise<void>`
72
+
73
+
74
+
75
+
76
+ ## Dependencies
77
+
78
+ ### Depends on
79
+
80
+ - [snk-grid](../snk-grid)
81
+ - [snk-guides-viewer](subcomponents)
82
+ - [snk-attach](../snk-attach)
83
+ - [snk-configurator](../snk-configurator)
84
+ - [snk-data-exporter](../snk-data-exporter)
85
+ - [snk-actions-button](../snk-actions-button)
86
+
87
+ ### Graph
88
+ ```mermaid
89
+ graph TD;
90
+ snk-crud --> snk-grid
91
+ snk-crud --> snk-guides-viewer
92
+ snk-crud --> snk-attach
93
+ snk-crud --> snk-configurator
94
+ snk-crud --> snk-data-exporter
95
+ snk-crud --> snk-actions-button
96
+ snk-grid --> snk-filter-bar
97
+ snk-grid --> snk-taskbar
98
+ snk-grid --> snk-grid-config
99
+ snk-grid --> snk-data-exporter
100
+ snk-grid --> snk-actions-button
101
+ snk-filter-bar --> snk-filter-item
102
+ snk-filter-bar --> snk-personalized-filter
103
+ snk-filter-item --> snk-filter-detail
104
+ snk-personalized-filter --> snk-filter-field-search
105
+ snk-personalized-filter --> snk-filter-assistent-mode
106
+ snk-personalized-filter --> snk-filter-advanced-mode
107
+ snk-personalized-filter --> snk-simple-bar
108
+ snk-filter-assistent-mode --> snk-expression-group
109
+ snk-expression-group --> snk-expression-item
110
+ snk-expression-group --> snk-expression-group
111
+ snk-expression-item --> snk-filter-field-search
112
+ snk-expression-item --> snk-filter-param-config
113
+ snk-taskbar --> snk-data-exporter
114
+ snk-taskbar --> snk-actions-button
115
+ snk-data-exporter --> snk-exporter-email-sender
116
+ snk-grid-config --> snk-select-box
117
+ snk-guides-viewer --> snk-form-view
118
+ snk-guides-viewer --> snk-data-unit
119
+ snk-guides-viewer --> snk-detail-view
120
+ snk-guides-viewer --> snk-taskbar
121
+ snk-guides-viewer --> snk-form-config
122
+ snk-guides-viewer --> snk-configurator
123
+ snk-guides-viewer --> snk-data-exporter
124
+ snk-guides-viewer --> snk-actions-button
125
+ snk-form-view --> snk-form-summary
126
+ snk-detail-view --> snk-data-unit
127
+ snk-detail-view --> snk-grid
128
+ snk-detail-view --> snk-form-view
129
+ snk-detail-view --> snk-taskbar
130
+ snk-detail-view --> snk-attach
131
+ snk-detail-view --> snk-data-exporter
132
+ snk-detail-view --> snk-actions-button
133
+ snk-attach --> snk-simple-bar
134
+ snk-attach --> snk-simple-crud
135
+ snk-simple-crud --> snk-data-unit
136
+ snk-simple-crud --> snk-taskbar
137
+ snk-simple-crud --> snk-data-exporter
138
+ snk-simple-crud --> snk-actions-button
139
+ snk-form-config --> snk-field-config
140
+ snk-form-config --> snk-config-options
141
+ snk-form-config --> snk-tab-config
142
+ style snk-crud fill:#f9f,stroke:#333,stroke-width:4px
143
+ ```
144
+
145
+ ----------------------------------------------
146
+
147
+
package/components/snk-crud/subcomponents/readme.md ADDED
@@ -0,0 +1,119 @@
1
+ # snk-guides-viewer
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----------- |
12
+ | `_guideBuilders` | -- | | `Map<string, GuideBuilder>` | `new Map()` |
13
+ | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
+ | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
+ | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
18
+ | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
19
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
21
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
22
+ | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
23
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
24
+
25
+
26
+ ## Events
27
+
28
+ | Event | Description | Type |
29
+ | ------------- | ------------------------------------------------- | --------------------- |
30
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
31
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
32
+
33
+
34
+ ## Methods
35
+
36
+ ### `showFormConfig(detail?: boolean) => Promise<void>`
37
+
38
+ Abre o configurador do formulário
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<void>`
43
+
44
+
45
+
46
+
47
+ ## Dependencies
48
+
49
+ ### Used by
50
+
51
+ - [snk-crud](..)
52
+
53
+ ### Depends on
54
+
55
+ - [snk-form-view](.)
56
+ - [snk-data-unit](../../snk-data-unit)
57
+ - [snk-detail-view](snk-detail-view)
58
+ - [snk-taskbar](../../snk-taskbar)
59
+ - [snk-form-config](../../snk-form/subcomponents/snk-form-config)
60
+ - [snk-configurator](../../snk-configurator)
61
+ - [snk-data-exporter](../../snk-data-exporter)
62
+ - [snk-actions-button](../../snk-actions-button)
63
+
64
+ ### Graph
65
+ ```mermaid
66
+ graph TD;
67
+ snk-guides-viewer --> snk-form-view
68
+ snk-guides-viewer --> snk-data-unit
69
+ snk-guides-viewer --> snk-detail-view
70
+ snk-guides-viewer --> snk-taskbar
71
+ snk-guides-viewer --> snk-form-config
72
+ snk-guides-viewer --> snk-configurator
73
+ snk-guides-viewer --> snk-data-exporter
74
+ snk-guides-viewer --> snk-actions-button
75
+ snk-form-view --> snk-form-summary
76
+ snk-detail-view --> snk-data-unit
77
+ snk-detail-view --> snk-grid
78
+ snk-detail-view --> snk-form-view
79
+ snk-detail-view --> snk-taskbar
80
+ snk-detail-view --> snk-attach
81
+ snk-detail-view --> snk-data-exporter
82
+ snk-detail-view --> snk-actions-button
83
+ snk-grid --> snk-filter-bar
84
+ snk-grid --> snk-taskbar
85
+ snk-grid --> snk-grid-config
86
+ snk-grid --> snk-data-exporter
87
+ snk-grid --> snk-actions-button
88
+ snk-filter-bar --> snk-filter-item
89
+ snk-filter-bar --> snk-personalized-filter
90
+ snk-filter-item --> snk-filter-detail
91
+ snk-personalized-filter --> snk-filter-field-search
92
+ snk-personalized-filter --> snk-filter-assistent-mode
93
+ snk-personalized-filter --> snk-filter-advanced-mode
94
+ snk-personalized-filter --> snk-simple-bar
95
+ snk-filter-assistent-mode --> snk-expression-group
96
+ snk-expression-group --> snk-expression-item
97
+ snk-expression-group --> snk-expression-group
98
+ snk-expression-item --> snk-filter-field-search
99
+ snk-expression-item --> snk-filter-param-config
100
+ snk-taskbar --> snk-data-exporter
101
+ snk-taskbar --> snk-actions-button
102
+ snk-data-exporter --> snk-exporter-email-sender
103
+ snk-grid-config --> snk-select-box
104
+ snk-attach --> snk-simple-bar
105
+ snk-attach --> snk-simple-crud
106
+ snk-simple-crud --> snk-data-unit
107
+ snk-simple-crud --> snk-taskbar
108
+ snk-simple-crud --> snk-data-exporter
109
+ snk-simple-crud --> snk-actions-button
110
+ snk-form-config --> snk-field-config
111
+ snk-form-config --> snk-config-options
112
+ snk-form-config --> snk-tab-config
113
+ snk-crud --> snk-guides-viewer
114
+ style snk-guides-viewer fill:#f9f,stroke:#333,stroke-width:4px
115
+ ```
116
+
117
+ ----------------------------------------------
118
+
119
+
package/components/snk-crud/subcomponents/snk-detail-view/readme.md ADDED
@@ -0,0 +1,125 @@
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
+ - [snk-actions-button](../../../snk-actions-button)
80
+
81
+ ### Graph
82
+ ```mermaid
83
+ graph TD;
84
+ snk-detail-view --> snk-data-unit
85
+ snk-detail-view --> snk-grid
86
+ snk-detail-view --> snk-form-view
87
+ snk-detail-view --> snk-taskbar
88
+ snk-detail-view --> snk-attach
89
+ snk-detail-view --> snk-data-exporter
90
+ snk-detail-view --> snk-actions-button
91
+ snk-grid --> snk-filter-bar
92
+ snk-grid --> snk-taskbar
93
+ snk-grid --> snk-grid-config
94
+ snk-grid --> snk-data-exporter
95
+ snk-grid --> snk-actions-button
96
+ snk-filter-bar --> snk-filter-item
97
+ snk-filter-bar --> snk-personalized-filter
98
+ snk-filter-item --> snk-filter-detail
99
+ snk-personalized-filter --> snk-filter-field-search
100
+ snk-personalized-filter --> snk-filter-assistent-mode
101
+ snk-personalized-filter --> snk-filter-advanced-mode
102
+ snk-personalized-filter --> snk-simple-bar
103
+ snk-filter-assistent-mode --> snk-expression-group
104
+ snk-expression-group --> snk-expression-item
105
+ snk-expression-group --> snk-expression-group
106
+ snk-expression-item --> snk-filter-field-search
107
+ snk-expression-item --> snk-filter-param-config
108
+ snk-taskbar --> snk-data-exporter
109
+ snk-taskbar --> snk-actions-button
110
+ snk-data-exporter --> snk-exporter-email-sender
111
+ snk-grid-config --> snk-select-box
112
+ snk-form-view --> snk-form-summary
113
+ snk-attach --> snk-simple-bar
114
+ snk-attach --> snk-simple-crud
115
+ snk-simple-crud --> snk-data-unit
116
+ snk-simple-crud --> snk-taskbar
117
+ snk-simple-crud --> snk-data-exporter
118
+ snk-simple-crud --> snk-actions-button
119
+ snk-guides-viewer --> snk-detail-view
120
+ style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
121
+ ```
122
+
123
+ ----------------------------------------------
124
+
125
+
package/components/snk-data-exporter/exporter-email-sender/readme.md ADDED
@@ -0,0 +1,53 @@
1
+ # snk-exporter-email-sender
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | --------- | ----------- | --------------------------------------- | ----------- |
12
+ | `getMessage` | -- | | `(key: string, params?: any) => string` | `undefined` |
13
+
14
+
15
+ ## Methods
16
+
17
+ ### `close() => Promise<IExportResult>`
18
+
19
+
20
+
21
+ #### Returns
22
+
23
+ Type: `Promise<IExportResult>`
24
+
25
+
26
+
27
+ ### `open(config: IExportConfig) => Promise<IExportResult>`
28
+
29
+
30
+
31
+ #### Returns
32
+
33
+ Type: `Promise<IExportResult>`
34
+
35
+
36
+
37
+
38
+ ## Dependencies
39
+
40
+ ### Used by
41
+
42
+ - [snk-data-exporter](..)
43
+
44
+ ### Graph
45
+ ```mermaid
46
+ graph TD;
47
+ snk-data-exporter --> snk-exporter-email-sender
48
+ style snk-exporter-email-sender fill:#f9f,stroke:#333,stroke-width:4px
49
+ ```
50
+
51
+ ----------------------------------------------
52
+
53
+
package/components/snk-data-exporter/readme.md ADDED
@@ -0,0 +1,46 @@
1
+ # snk-data-exporter
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
13
+ | `provider` | -- | Provedor das informações para exportação dos dados. | `IExporterProvider` | `null` |
14
+
15
+
16
+ ## Dependencies
17
+
18
+ ### Used by
19
+
20
+ - [snk-crud](../snk-crud)
21
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
22
+ - [snk-grid](../snk-grid)
23
+ - [snk-guides-viewer](../snk-crud/subcomponents)
24
+ - [snk-simple-crud](../snk-simple-crud)
25
+ - [snk-taskbar](../snk-taskbar)
26
+
27
+ ### Depends on
28
+
29
+ - [snk-exporter-email-sender](exporter-email-sender)
30
+
31
+ ### Graph
32
+ ```mermaid
33
+ graph TD;
34
+ snk-data-exporter --> snk-exporter-email-sender
35
+ snk-crud --> snk-data-exporter
36
+ snk-detail-view --> snk-data-exporter
37
+ snk-grid --> snk-data-exporter
38
+ snk-guides-viewer --> snk-data-exporter
39
+ snk-simple-crud --> snk-data-exporter
40
+ snk-taskbar --> snk-data-exporter
41
+ style snk-data-exporter fill:#f9f,stroke:#333,stroke-width:4px
42
+ ```
43
+
44
+ ----------------------------------------------
45
+
46
+
package/components/snk-data-unit/readme.md ADDED
@@ -0,0 +1,76 @@
1
+ # snk-data-unit
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
12
+ | `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
13
+ | `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
14
+ | `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
15
+ | `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
16
+ | `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
17
+ | `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
18
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
20
+ | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
21
+
22
+
23
+ ## Events
24
+
25
+ | Event | Description | Type |
26
+ | ------------------------ | --------------------------------------------------------- | -------------------------------- |
27
+ | `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
28
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
29
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
30
+ | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
31
+ | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
32
+
33
+
34
+ ## Methods
35
+
36
+ ### `getDataUnit() => Promise<DataUnit>`
37
+
38
+ Obtém o dataUnit.
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<DataUnit>`
43
+
44
+
45
+
46
+ ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
47
+
48
+ Método que retorna a lista de IDs dos registros selecionados.
49
+
50
+ #### Returns
51
+
52
+ Type: `Promise<IRecordID[]>`
53
+
54
+ Retorna a lista de IDs dos registros selecionados.
55
+
56
+
57
+ ## Dependencies
58
+
59
+ ### Used by
60
+
61
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
62
+ - [snk-guides-viewer](../snk-crud/subcomponents)
63
+ - [snk-simple-crud](../snk-simple-crud)
64
+
65
+ ### Graph
66
+ ```mermaid
67
+ graph TD;
68
+ snk-detail-view --> snk-data-unit
69
+ snk-guides-viewer --> snk-data-unit
70
+ snk-simple-crud --> snk-data-unit
71
+ style snk-data-unit fill:#f9f,stroke:#333,stroke-width:4px
72
+ ```
73
+
74
+ ----------------------------------------------
75
+
76
+
package/components/snk-entity-list/readme.md ADDED
@@ -0,0 +1,40 @@
1
+ # snk-entity-list
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
12
+ | `config` | -- | Configurações para carregar os dados do componente | `SnkFilterItemConfig` | `undefined` |
13
+ | `maxHeightList` | `max-height-list` | Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida | `string` | `""` |
14
+ | `rightListSlotBuilder` | -- | Método que possibilita alterar como o item da lista vai ser apresentado. Observação: No React ele se transforma em VNode e não HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | -------------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
21
+ | `saveConfig` | Evento emitido ao realizar alguma ação que altera os dados do config.value permitindo salvar estas informações | `CustomEvent<SnkFilterItemConfig>` |
22
+ | `valueChanged` | Emite um evento customizado ao realizar alteração nos valores do componente | `CustomEvent<CustomEvent<any>>` |
23
+
24
+
25
+ ## Methods
26
+
27
+ ### `reloadList() => Promise<void>`
28
+
29
+
30
+
31
+ #### Returns
32
+
33
+ Type: `Promise<void>`
34
+
35
+
36
+
37
+
38
+ ----------------------------------------------
39
+
40
+
package/components/snk-filter-bar/filter-item/editors/readme.md ADDED
@@ -0,0 +1,25 @@
1
+ # snk-filter-text
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | ------------------------------------------------------ | --------------------- | ----------- |
12
+ | `config` | -- | Define as configurações do componente snk-filter-text. | `SnkFilterItemConfig` | `undefined` |
13
+ | `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
14
+
15
+
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | -------------- | -------------------------------------------- | ------------------ |
20
+ | `valueChanged` | Emitido quando o valor do filtro é alterado. | `CustomEvent<any>` |
21
+
22
+
23
+ ----------------------------------------------
24
+
25
+