@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-85226.0 → 0.0.0-bugfix-ms-KB-88585.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 (11) hide show
  1. package/components/snk-application/readme.md +0 -41
  2. package/components/snk-attach/readme.md +0 -2
  3. package/components/snk-configurator/readme.md +0 -7
  4. package/components/snk-crud/readme.md +0 -4
  5. package/components/snk-crud/subcomponents/readme.md +5 -8
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +17 -20
  7. package/components/snk-grid/readme.md +0 -1
  8. package/components/snk-simple-crud/readme.md +0 -4
  9. package/package.json +1 -1
  10. package/components/snk-layout-form-config/readme.md +0 -41
  11. package/components/snk-layout-form-config/snk-view-representation/readme.md +0 -30
package/components/snk-application/readme.md CHANGED
@@ -87,16 +87,6 @@ Type: `Promise<any>`
87
87
 
88
88
 
89
89
 
90
- ### `clearPopUpTitle() => Promise<void>`
91
-
92
-
93
-
94
- #### Returns
95
-
96
- Type: `Promise<void>`
97
-
98
-
99
-
100
90
  ### `closeModal() => Promise<void>`
101
91
 
102
92
  Fecha o Modal e limpa o conteúdo.
@@ -159,17 +149,6 @@ Type: `Promise<IOption | IOption[]>`
159
149
 
160
150
 
161
151
 
162
- ### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
163
-
164
- Realiza a pesquisa de registros
165
- Ex.: snk-config-options
166
-
167
- #### Returns
168
-
169
- Type: `Promise<IOption | IOption[]>`
170
-
171
-
172
-
173
152
  ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
174
153
 
175
154
  Obtém as opções em componentes de pesquisa
@@ -313,16 +292,6 @@ Type: `Promise<KeyboardManager>`
313
292
 
314
293
  the keyboard manager
315
294
 
316
- ### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
317
-
318
- Obtém o notificador de Layout de formulario.
319
-
320
- #### Returns
321
-
322
- Type: `Promise<LayoutFormConfig>`
323
-
324
- the Configurador de Layout do Formulario
325
-
326
295
  ### `getResourceID() => Promise<string>`
327
296
 
328
297
  Obtém o resourceID da tela em questão.
@@ -504,16 +473,6 @@ Type: `Promise<any>`
504
473
 
505
474
 
506
475
 
507
- ### `setPopUpTitle(title: string) => Promise<void>`
508
-
509
-
510
-
511
- #### Returns
512
-
513
- Type: `Promise<void>`
514
-
515
-
516
-
517
476
  ### `setSearchFilterContext(name: string, value: string) => Promise<void>`
518
477
 
519
478
  Atribui valor para parâmetros de contexto no componente de pesquisa.
package/components/snk-attach/readme.md CHANGED
@@ -54,8 +54,6 @@ graph TD;
54
54
  snk-taskbar --> snk-actions-button
55
55
  snk-taskbar --> taskbar-actions-button
56
56
  snk-data-exporter --> snk-exporter-email-sender
57
- snk-configurator --> snk-layout-form-config
58
- snk-layout-form-config --> snk-view-representation
59
57
  snk-grid-config --> snk-select-box
60
58
  snk-crud --> snk-attach
61
59
  snk-detail-view --> snk-attach
package/components/snk-configurator/readme.md CHANGED
@@ -11,7 +11,6 @@
11
11
  | ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
12
  | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
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` | `false` |
15
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
15
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
17
16
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
@@ -59,15 +58,9 @@ Type: `Promise<void>`
59
58
  - [snk-guides-viewer](../snk-crud/subcomponents)
60
59
  - [snk-simple-crud](../snk-simple-crud)
61
60
 
62
- ### Depends on
63
-
64
- - [snk-layout-form-config](../snk-layout-form-config)
65
-
66
61
  ### Graph
67
62
  ```mermaid
68
63
  graph TD;
69
- snk-configurator --> snk-layout-form-config
70
- snk-layout-form-config --> snk-view-representation
71
64
  snk-crud --> snk-configurator
72
65
  snk-guides-viewer --> snk-configurator
73
66
  snk-simple-crud --> snk-configurator
package/components/snk-crud/readme.md CHANGED
@@ -23,9 +23,7 @@
23
23
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
24
24
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
25
25
  | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
26
- | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
27
26
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
28
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
29
27
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
30
28
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
31
29
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
@@ -225,8 +223,6 @@ graph TD;
225
223
  snk-simple-crud --> snk-data-exporter
226
224
  snk-simple-crud --> snk-actions-button
227
225
  snk-simple-crud --> taskbar-actions-button
228
- snk-configurator --> snk-layout-form-config
229
- snk-layout-form-config --> snk-view-representation
230
226
  snk-form-config --> snk-field-config
231
227
  snk-form-config --> snk-config-options
232
228
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -31,12 +31,11 @@
31
31
 
32
32
  ## Events
33
33
 
34
- | Event | Description | Type |
35
- | --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
36
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
37
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
38
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
39
- | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
34
+ | Event | Description | Type |
35
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
36
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
37
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
38
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
40
39
 
41
40
 
42
41
  ## Methods
@@ -174,8 +173,6 @@ graph TD;
174
173
  snk-simple-crud --> snk-data-exporter
175
174
  snk-simple-crud --> snk-actions-button
176
175
  snk-simple-crud --> taskbar-actions-button
177
- snk-configurator --> snk-layout-form-config
178
- snk-layout-form-config --> snk-view-representation
179
176
  snk-form-config --> snk-field-config
180
177
  snk-form-config --> snk-config-options
181
178
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -7,24 +7,23 @@
7
7
 
8
8
  ## Properties
9
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
- | `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
15
- | `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
16
- | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
17
- | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
18
- | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
19
- | `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
20
- | `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
21
- | `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
22
- | `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
23
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
24
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.SECONDARY` |
25
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
26
- | `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
27
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
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
+ | `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
15
+ | `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
16
+ | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
17
+ | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
18
+ | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
19
+ | `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
20
+ | `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
21
+ | `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
22
+ | `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
23
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
24
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
+ | `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
26
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
28
27
 
29
28
 
30
29
  ## Events
@@ -151,8 +150,6 @@ graph TD;
151
150
  snk-simple-crud --> snk-data-exporter
152
151
  snk-simple-crud --> snk-actions-button
153
152
  snk-simple-crud --> taskbar-actions-button
154
- snk-configurator --> snk-layout-form-config
155
- snk-layout-form-config --> snk-view-representation
156
153
  snk-guides-viewer --> snk-detail-view
157
154
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
158
155
  ```
package/components/snk-grid/readme.md CHANGED
@@ -25,7 +25,6 @@
25
25
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
26
26
  | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
27
27
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
28
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
29
28
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
30
29
  | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
31
30
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
package/components/snk-simple-crud/readme.md CHANGED
@@ -26,10 +26,8 @@
26
26
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
27
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
28
28
  | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
29
- | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
30
29
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
30
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
33
31
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
34
32
  | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
35
33
  | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
@@ -207,8 +205,6 @@ graph TD;
207
205
  snk-taskbar --> snk-actions-button
208
206
  snk-taskbar --> taskbar-actions-button
209
207
  snk-data-exporter --> snk-exporter-email-sender
210
- snk-configurator --> snk-layout-form-config
211
- snk-layout-form-config --> snk-view-representation
212
208
  snk-grid-config --> snk-select-box
213
209
  snk-attach --> snk-simple-crud
214
210
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-bugfix-dev-KB-85226.0",
3
+ "version": "0.0.0-bugfix-ms-KB-88585.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/components/snk-layout-form-config/readme.md DELETED
@@ -1,41 +0,0 @@
1
- # snk-layout-form-config
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Methods
9
-
10
- ### `save() => Promise<void>`
11
-
12
- Salva o tipo de layout escolhido. Sem retorno.
13
-
14
- #### Returns
15
-
16
- Type: `Promise<void>`
17
-
18
-
19
-
20
-
21
- ## Dependencies
22
-
23
- ### Used by
24
-
25
- - [snk-configurator](../snk-configurator)
26
-
27
- ### Depends on
28
-
29
- - [snk-view-representation](snk-view-representation)
30
-
31
- ### Graph
32
- ```mermaid
33
- graph TD;
34
- snk-layout-form-config --> snk-view-representation
35
- snk-configurator --> snk-layout-form-config
36
- style snk-layout-form-config fill:#f9f,stroke:#333,stroke-width:4px
37
- ```
38
-
39
- ----------------------------------------------
40
-
41
-
package/components/snk-layout-form-config/snk-view-representation/readme.md DELETED
@@ -1,30 +0,0 @@
1
- # snk-view-representation
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | -------- | --------- | ---------------------------------------------------------- | ------------ | ------------------------- |
12
- | `mode` | `mode` | Define o layout do componente: 'CASCADE' ou 'SIDE_BY_SIDE' | `FormLayout` | `FormLayout.SIDE_BY_SIDE` |
13
-
14
-
15
- ## Dependencies
16
-
17
- ### Used by
18
-
19
- - [snk-layout-form-config](..)
20
-
21
- ### Graph
22
- ```mermaid
23
- graph TD;
24
- snk-layout-form-config --> snk-view-representation
25
- style snk-view-representation fill:#f9f,stroke:#333,stroke-width:4px
26
- ```
27
-
28
- ----------------------------------------------
29
-
30
-