@sankhyalabs/sankhyablocks-docs 10.0.1 → 10.1.0-dev.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.
Files changed (8) hide show
  1. package/components/snk-attach/readme.md +1 -0
  2. package/components/snk-configurator/readme.md +13 -9
  3. package/components/snk-crud/readme.md +30 -7
  4. package/components/snk-crud/subcomponents/readme.md +11 -0
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -0
  6. package/components/snk-numbering-config/readme.md +45 -0
  7. package/components/snk-simple-crud/readme.md +1 -0
  8. package/package.json +1 -1
package/components/snk-attach/readme.md CHANGED
@@ -58,6 +58,7 @@ graph TD;
58
58
  snk-taskbar --> taskbar-actions-button
59
59
  snk-data-exporter --> snk-exporter-email-sender
60
60
  snk-configurator --> snk-layout-form-config
61
+ snk-configurator --> snk-numbering-config
61
62
  snk-layout-form-config --> snk-view-representation
62
63
  snk-grid-config --> snk-select-box
63
64
  snk-crud --> snk-attach
package/components/snk-configurator/readme.md CHANGED
@@ -7,15 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator. | `string` | `undefined` |
14
- | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `true` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
17
- | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
18
- | `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------ | -------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator. | `string` | `undefined` |
14
+ | `disableNumberingConfig` | `disable-numbering-config` | Define se a configuração de numeração será desabilitada. | `boolean` | `false` |
15
+ | `entityName` | `entity-name` | Nome da entidade que está sendo configurada. | `string` | `undefined` |
16
+ | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `true` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
19
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
20
+ | `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
19
21
 
20
22
 
21
23
  ## Events
@@ -62,11 +64,13 @@ Type: `Promise<void>`
62
64
  ### Depends on
63
65
 
64
66
  - [snk-layout-form-config](../snk-layout-form-config)
67
+ - [snk-numbering-config](../snk-numbering-config)
65
68
 
66
69
  ### Graph
67
70
  ```mermaid
68
71
  graph TD;
69
72
  snk-configurator --> snk-layout-form-config
73
+ snk-configurator --> snk-numbering-config
70
74
  snk-layout-form-config --> snk-view-representation
71
75
  snk-crud --> snk-configurator
72
76
  snk-guides-viewer --> snk-configurator
package/components/snk-crud/readme.md CHANGED
@@ -13,6 +13,7 @@
13
13
  | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
14
  | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
+ | `disableNumberingConfig` | `disable-numbering-config` | Define se a configuração de numeração será desabilitada. | `boolean` | `false` |
16
17
  | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
17
18
  | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
18
19
  | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
@@ -41,13 +42,14 @@
41
42
 
42
43
  ## Events
43
44
 
44
- | Event | Description | Type |
45
- | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
46
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
47
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
48
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
49
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
50
- | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
45
+ | Event | Description | Type |
46
+ | ------------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
47
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
48
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
49
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
50
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
51
+ | `numberingConfigChanged` | Emitido quando a configuração de numeração é alterada. | `CustomEvent<ResponseGetConfig>` |
52
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
51
53
 
52
54
 
53
55
  ## Methods
@@ -102,6 +104,16 @@ Type: `Promise<HTMLSnkFilterBarElement>`
102
104
 
103
105
  ---
104
106
 
107
+ ### `getNumberingConfig() => Promise<ResponseGetConfig>`
108
+
109
+ Retorna a configuração de numeração atual.
110
+
111
+ #### Returns
112
+
113
+ Type: `Promise<ResponseGetConfig>`
114
+
115
+ ---
116
+
105
117
  ### `goToView(mode: string) => Promise<void>`
106
118
 
107
119
  Usado para alternar a visão entre GRID e FORM externamente.
@@ -150,6 +162,16 @@ Altera/adiciona uma propriedade nos metadados do campo.
150
162
 
151
163
  Type: `Promise<void>`
152
164
 
165
+ ---
166
+
167
+ ### `updateNumberingConfig(config: ResponseGetConfig) => Promise<void>`
168
+
169
+ Atualiza a configuração de numeração.
170
+
171
+ #### Returns
172
+
173
+ Type: `Promise<void>`
174
+
153
175
 
154
176
 
155
177
 
@@ -237,6 +259,7 @@ graph TD;
237
259
  snk-simple-crud --> taskbar-split-button
238
260
  snk-simple-crud --> taskbar-actions-button
239
261
  snk-configurator --> snk-layout-form-config
262
+ snk-configurator --> snk-numbering-config
240
263
  snk-layout-form-config --> snk-view-representation
241
264
  snk-form-config --> config-header
242
265
  snk-form-config --> guides-configurator
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -61,6 +61,16 @@ Type: `Promise<void>`
61
61
 
62
62
  ---
63
63
 
64
+ ### `reloadGuides() => Promise<void>`
65
+
66
+ Recarrega os guias baseada nos metadados atuais.
67
+
68
+ #### Returns
69
+
70
+ Type: `Promise<void>`
71
+
72
+ ---
73
+
64
74
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
65
75
 
66
76
  Altera/adiciona uma propriedade nos metadados do campo.
@@ -174,6 +184,7 @@ graph TD;
174
184
  snk-simple-crud --> taskbar-split-button
175
185
  snk-simple-crud --> taskbar-actions-button
176
186
  snk-configurator --> snk-layout-form-config
187
+ snk-configurator --> snk-numbering-config
177
188
  snk-layout-form-config --> snk-view-representation
178
189
  snk-form-config --> config-header
179
190
  snk-form-config --> guides-configurator
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -160,6 +160,7 @@ graph TD;
160
160
  snk-simple-crud --> taskbar-split-button
161
161
  snk-simple-crud --> taskbar-actions-button
162
162
  snk-configurator --> snk-layout-form-config
163
+ snk-configurator --> snk-numbering-config
163
164
  snk-layout-form-config --> snk-view-representation
164
165
  snk-guides-viewer --> snk-detail-view
165
166
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-numbering-config/readme.md ADDED
@@ -0,0 +1,45 @@
1
+ # snk-numbering-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | -------------- | ------------------------------------------------------ | ------------------- | ----------- |
12
+ | `entityName` | `entity-name` | Nome da entidade que está sendo configurada. | `string` | `undefined` |
13
+ | `messagesBuilder` | -- | Usado para exibir os mensagens de configuração. | `SnkMessageBuilder` | `undefined` |
14
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
15
+
16
+
17
+ ## Methods
18
+
19
+ ### `save() => Promise<boolean>`
20
+
21
+ Salva ou recupera as configurações de numeração.
22
+
23
+ #### Returns
24
+
25
+ Type: `Promise<boolean>`
26
+
27
+
28
+
29
+
30
+ ## Dependencies
31
+
32
+ ### Used by
33
+
34
+ - [snk-configurator](../snk-configurator)
35
+
36
+ ### Graph
37
+ ```mermaid
38
+ graph TD;
39
+ snk-configurator --> snk-numbering-config
40
+ style snk-numbering-config fill:#f9f,stroke:#333,stroke-width:4px
41
+ ```
42
+
43
+ ----------------------------------------------
44
+
45
+
package/components/snk-simple-crud/readme.md CHANGED
@@ -214,6 +214,7 @@ graph TD;
214
214
  snk-taskbar --> taskbar-actions-button
215
215
  snk-data-exporter --> snk-exporter-email-sender
216
216
  snk-configurator --> snk-layout-form-config
217
+ snk-configurator --> snk-numbering-config
217
218
  snk-layout-form-config --> snk-view-representation
218
219
  snk-grid-config --> snk-select-box
219
220
  snk-attach --> snk-simple-crud
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "10.0.1",
3
+ "version": "10.1.0-dev.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [