@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-11997.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 +492 -0
  4. package/components/snk-attach/readme.md +55 -0
  5. package/components/snk-configurator/readme.md +69 -0
  6. package/components/snk-crud/readme.md +149 -0
  7. package/components/snk-crud/subcomponents/readme.md +122 -0
  8. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +129 -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 +79 -0
  12. package/components/snk-entity-list/readme.md +39 -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 +41 -0
  19. package/components/snk-filter-bar/readme.md +64 -0
  20. package/components/snk-filter-field-search/readme.md +65 -0
  21. package/components/snk-form/readme.md +68 -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 +128 -0
  27. package/components/snk-grid/subcomponents/snk-grid-config/readme.md +48 -0
  28. package/components/snk-grid/subcomponents/snk-select-box/readme.md +37 -0
  29. package/components/snk-personalized-filter/readme.md +71 -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 +106 -0
  39. package/components/snk-taskbar/readme.md +17 -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,149 @@
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
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
+
24
+
25
+ ## Events
26
+
27
+ | Event | Description | Type |
28
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
29
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
30
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
31
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
32
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
33
+
34
+
35
+ ## Methods
36
+
37
+ ### `closeConfigurator() => Promise<void>`
38
+
39
+ Usado para fechar o configurator do CRUD
40
+
41
+ #### Returns
42
+
43
+ Type: `Promise<void>`
44
+
45
+
46
+
47
+ ### `goToView(mode: string) => Promise<void>`
48
+
49
+ Usado para alternar a visão entre GRID e FORM externamente.
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
57
+ ### `openConfigurator() => Promise<void>`
58
+
59
+ Usado para abrir o configurator do CRUD
60
+
61
+ #### Returns
62
+
63
+ Type: `Promise<void>`
64
+
65
+
66
+
67
+ ### `reloadFilterBar() => Promise<void>`
68
+
69
+ Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
70
+
71
+ #### Returns
72
+
73
+ Type: `Promise<void>`
74
+
75
+
76
+
77
+
78
+ ## Dependencies
79
+
80
+ ### Depends on
81
+
82
+ - [snk-grid](../snk-grid)
83
+ - [snk-guides-viewer](subcomponents)
84
+ - [snk-attach](../snk-attach)
85
+ - [snk-configurator](../snk-configurator)
86
+ - [snk-data-exporter](../snk-data-exporter)
87
+ - [snk-actions-button](../snk-actions-button)
88
+
89
+ ### Graph
90
+ ```mermaid
91
+ graph TD;
92
+ snk-crud --> snk-grid
93
+ snk-crud --> snk-guides-viewer
94
+ snk-crud --> snk-attach
95
+ snk-crud --> snk-configurator
96
+ snk-crud --> snk-data-exporter
97
+ snk-crud --> snk-actions-button
98
+ snk-grid --> snk-filter-bar
99
+ snk-grid --> snk-taskbar
100
+ snk-grid --> snk-grid-config
101
+ snk-grid --> snk-data-exporter
102
+ snk-grid --> snk-actions-button
103
+ snk-filter-bar --> snk-filter-item
104
+ snk-filter-bar --> snk-personalized-filter
105
+ snk-filter-item --> snk-filter-detail
106
+ snk-personalized-filter --> snk-filter-field-search
107
+ snk-personalized-filter --> snk-filter-assistent-mode
108
+ snk-personalized-filter --> snk-filter-advanced-mode
109
+ snk-personalized-filter --> snk-simple-bar
110
+ snk-filter-assistent-mode --> snk-expression-group
111
+ snk-expression-group --> snk-expression-item
112
+ snk-expression-group --> snk-expression-group
113
+ snk-expression-item --> snk-filter-field-search
114
+ snk-expression-item --> snk-filter-param-config
115
+ snk-taskbar --> snk-data-exporter
116
+ snk-taskbar --> snk-actions-button
117
+ snk-data-exporter --> snk-exporter-email-sender
118
+ snk-grid-config --> snk-select-box
119
+ snk-guides-viewer --> snk-form-view
120
+ snk-guides-viewer --> snk-data-unit
121
+ snk-guides-viewer --> snk-detail-view
122
+ snk-guides-viewer --> snk-taskbar
123
+ snk-guides-viewer --> snk-form-config
124
+ snk-guides-viewer --> snk-configurator
125
+ snk-guides-viewer --> snk-data-exporter
126
+ snk-guides-viewer --> snk-actions-button
127
+ snk-form-view --> snk-form-summary
128
+ snk-detail-view --> snk-data-unit
129
+ snk-detail-view --> snk-grid
130
+ snk-detail-view --> snk-form-view
131
+ snk-detail-view --> snk-taskbar
132
+ snk-detail-view --> snk-attach
133
+ snk-detail-view --> snk-data-exporter
134
+ snk-detail-view --> snk-actions-button
135
+ snk-attach --> snk-simple-bar
136
+ snk-attach --> snk-simple-crud
137
+ snk-simple-crud --> snk-data-unit
138
+ snk-simple-crud --> snk-taskbar
139
+ snk-simple-crud --> snk-data-exporter
140
+ snk-simple-crud --> snk-actions-button
141
+ snk-form-config --> snk-field-config
142
+ snk-form-config --> snk-config-options
143
+ snk-form-config --> snk-tab-config
144
+ style snk-crud fill:#f9f,stroke:#333,stroke-width:4px
145
+ ```
146
+
147
+ ----------------------------------------------
148
+
149
+
package/components/snk-crud/subcomponents/readme.md ADDED
@@ -0,0 +1,122 @@
1
+ # snk-guides-viewer
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
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
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
+ | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
+ | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
+ | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
22
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
25
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
26
+
27
+
28
+ ## Events
29
+
30
+ | Event | Description | Type |
31
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
32
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
33
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
34
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
35
+
36
+
37
+ ## Methods
38
+
39
+ ### `showFormConfig(detail?: boolean) => Promise<void>`
40
+
41
+ Abre o configurador do formulário
42
+
43
+ #### Returns
44
+
45
+ Type: `Promise<void>`
46
+
47
+
48
+
49
+
50
+ ## Dependencies
51
+
52
+ ### Used by
53
+
54
+ - [snk-crud](..)
55
+
56
+ ### Depends on
57
+
58
+ - [snk-form-view](.)
59
+ - [snk-data-unit](../../snk-data-unit)
60
+ - [snk-detail-view](snk-detail-view)
61
+ - [snk-taskbar](../../snk-taskbar)
62
+ - [snk-form-config](../../snk-form/subcomponents/snk-form-config)
63
+ - [snk-configurator](../../snk-configurator)
64
+ - [snk-data-exporter](../../snk-data-exporter)
65
+ - [snk-actions-button](../../snk-actions-button)
66
+
67
+ ### Graph
68
+ ```mermaid
69
+ graph TD;
70
+ snk-guides-viewer --> snk-form-view
71
+ snk-guides-viewer --> snk-data-unit
72
+ snk-guides-viewer --> snk-detail-view
73
+ snk-guides-viewer --> snk-taskbar
74
+ snk-guides-viewer --> snk-form-config
75
+ snk-guides-viewer --> snk-configurator
76
+ snk-guides-viewer --> snk-data-exporter
77
+ snk-guides-viewer --> snk-actions-button
78
+ snk-form-view --> snk-form-summary
79
+ snk-detail-view --> snk-data-unit
80
+ snk-detail-view --> snk-grid
81
+ snk-detail-view --> snk-form-view
82
+ snk-detail-view --> snk-taskbar
83
+ snk-detail-view --> snk-attach
84
+ snk-detail-view --> snk-data-exporter
85
+ snk-detail-view --> snk-actions-button
86
+ snk-grid --> snk-filter-bar
87
+ snk-grid --> snk-taskbar
88
+ snk-grid --> snk-grid-config
89
+ snk-grid --> snk-data-exporter
90
+ snk-grid --> snk-actions-button
91
+ snk-filter-bar --> snk-filter-item
92
+ snk-filter-bar --> snk-personalized-filter
93
+ snk-filter-item --> snk-filter-detail
94
+ snk-personalized-filter --> snk-filter-field-search
95
+ snk-personalized-filter --> snk-filter-assistent-mode
96
+ snk-personalized-filter --> snk-filter-advanced-mode
97
+ snk-personalized-filter --> snk-simple-bar
98
+ snk-filter-assistent-mode --> snk-expression-group
99
+ snk-expression-group --> snk-expression-item
100
+ snk-expression-group --> snk-expression-group
101
+ snk-expression-item --> snk-filter-field-search
102
+ snk-expression-item --> snk-filter-param-config
103
+ snk-taskbar --> snk-data-exporter
104
+ snk-taskbar --> snk-actions-button
105
+ snk-data-exporter --> snk-exporter-email-sender
106
+ snk-grid-config --> snk-select-box
107
+ snk-attach --> snk-simple-bar
108
+ snk-attach --> snk-simple-crud
109
+ snk-simple-crud --> snk-data-unit
110
+ snk-simple-crud --> snk-taskbar
111
+ snk-simple-crud --> snk-data-exporter
112
+ snk-simple-crud --> snk-actions-button
113
+ snk-form-config --> snk-field-config
114
+ snk-form-config --> snk-config-options
115
+ snk-form-config --> snk-tab-config
116
+ snk-crud --> snk-guides-viewer
117
+ style snk-guides-viewer fill:#f9f,stroke:#333,stroke-width:4px
118
+ ```
119
+
120
+ ----------------------------------------------
121
+
122
+
package/components/snk-crud/subcomponents/snk-detail-view/readme.md ADDED
@@ -0,0 +1,129 @@
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
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
15
+ | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
16
+ | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
17
+ | `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
18
+ | `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
19
+ | `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
20
+ | `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
21
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
24
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
25
+
26
+
27
+ ## Events
28
+
29
+ | Event | Description | Type |
30
+ | ----------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
31
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
32
+ | `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias. | `CustomEvent<GuideBuilder>` |
33
+ | `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
34
+
35
+
36
+ ## Methods
37
+
38
+ ### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
39
+
40
+ Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
41
+
42
+ #### Returns
43
+
44
+ Type: `Promise<void>`
45
+
46
+
47
+
48
+ ### `configGrid() => Promise<void>`
49
+
50
+ Abre o configurador de grid.
51
+
52
+ #### Returns
53
+
54
+ Type: `Promise<void>`
55
+
56
+
57
+
58
+ ### `showUp() => Promise<void>`
59
+
60
+
61
+
62
+ #### Returns
63
+
64
+ Type: `Promise<void>`
65
+
66
+
67
+
68
+
69
+ ## Dependencies
70
+
71
+ ### Used by
72
+
73
+ - [snk-guides-viewer](..)
74
+
75
+ ### Depends on
76
+
77
+ - [snk-data-unit](../../../snk-data-unit)
78
+ - [snk-grid](../../../snk-grid)
79
+ - [snk-form-view](..)
80
+ - [snk-taskbar](../../../snk-taskbar)
81
+ - [snk-attach](../../../snk-attach)
82
+ - [snk-data-exporter](../../../snk-data-exporter)
83
+ - [snk-actions-button](../../../snk-actions-button)
84
+
85
+ ### Graph
86
+ ```mermaid
87
+ graph TD;
88
+ snk-detail-view --> snk-data-unit
89
+ snk-detail-view --> snk-grid
90
+ snk-detail-view --> snk-form-view
91
+ snk-detail-view --> snk-taskbar
92
+ snk-detail-view --> snk-attach
93
+ snk-detail-view --> snk-data-exporter
94
+ snk-detail-view --> snk-actions-button
95
+ snk-grid --> snk-filter-bar
96
+ snk-grid --> snk-taskbar
97
+ snk-grid --> snk-grid-config
98
+ snk-grid --> snk-data-exporter
99
+ snk-grid --> snk-actions-button
100
+ snk-filter-bar --> snk-filter-item
101
+ snk-filter-bar --> snk-personalized-filter
102
+ snk-filter-item --> snk-filter-detail
103
+ snk-personalized-filter --> snk-filter-field-search
104
+ snk-personalized-filter --> snk-filter-assistent-mode
105
+ snk-personalized-filter --> snk-filter-advanced-mode
106
+ snk-personalized-filter --> snk-simple-bar
107
+ snk-filter-assistent-mode --> snk-expression-group
108
+ snk-expression-group --> snk-expression-item
109
+ snk-expression-group --> snk-expression-group
110
+ snk-expression-item --> snk-filter-field-search
111
+ snk-expression-item --> snk-filter-param-config
112
+ snk-taskbar --> snk-data-exporter
113
+ snk-taskbar --> snk-actions-button
114
+ snk-data-exporter --> snk-exporter-email-sender
115
+ snk-grid-config --> snk-select-box
116
+ snk-form-view --> snk-form-summary
117
+ snk-attach --> snk-simple-bar
118
+ snk-attach --> snk-simple-crud
119
+ snk-simple-crud --> snk-data-unit
120
+ snk-simple-crud --> snk-taskbar
121
+ snk-simple-crud --> snk-data-exporter
122
+ snk-simple-crud --> snk-actions-button
123
+ snk-guides-viewer --> snk-detail-view
124
+ style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
125
+ ```
126
+
127
+ ----------------------------------------------
128
+
129
+
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,79 @@
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
+ | `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
15
+ | `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
17
+ | `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
18
+ | `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
19
+ | `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
24
+
25
+
26
+ ## Events
27
+
28
+ | Event | Description | Type |
29
+ | ------------------------ | --------------------------------------------------------- | -------------------------------- |
30
+ | `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
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
+ | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
34
+ | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
35
+
36
+
37
+ ## Methods
38
+
39
+ ### `getDataUnit() => Promise<DataUnit>`
40
+
41
+ Obtém o dataUnit.
42
+
43
+ #### Returns
44
+
45
+ Type: `Promise<DataUnit>`
46
+
47
+
48
+
49
+ ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
50
+
51
+ Método que retorna a lista de IDs dos registros selecionados.
52
+
53
+ #### Returns
54
+
55
+ Type: `Promise<IRecordID[]>`
56
+
57
+ Retorna a lista de IDs dos registros selecionados.
58
+
59
+
60
+ ## Dependencies
61
+
62
+ ### Used by
63
+
64
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
65
+ - [snk-guides-viewer](../snk-crud/subcomponents)
66
+ - [snk-simple-crud](../snk-simple-crud)
67
+
68
+ ### Graph
69
+ ```mermaid
70
+ graph TD;
71
+ snk-detail-view --> snk-data-unit
72
+ snk-guides-viewer --> snk-data-unit
73
+ snk-simple-crud --> snk-data-unit
74
+ style snk-data-unit fill:#f9f,stroke:#333,stroke-width:4px
75
+ ```
76
+
77
+ ----------------------------------------------
78
+
79
+
package/components/snk-entity-list/readme.md ADDED
@@ -0,0 +1,39 @@
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
+ | `valueChanged` | Emite um evento customizado ao realizar alteração nos valores do componente | `CustomEvent<CustomEvent<any>>` |
22
+
23
+
24
+ ## Methods
25
+
26
+ ### `reloadList() => Promise<void>`
27
+
28
+
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+
35
+
36
+
37
+ ----------------------------------------------
38
+
39
+
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
+