@sankhyalabs/sankhyablocks-docs 9.2.0-ms.12 → 9.2.0-ms.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 (19) hide show
  1. package/components/snk-application/readme.md +26 -90
  2. package/components/snk-configurator/readme.md +1 -1
  3. package/components/snk-crud/readme.md +9 -9
  4. package/components/snk-crud/subcomponents/readme.md +4 -4
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -4
  6. package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
  7. package/components/snk-data-unit/readme.md +2 -10
  8. package/components/snk-filter-bar/filter-item/readme.md +1 -1
  9. package/components/snk-filter-bar/readme.md +24 -42
  10. package/components/snk-filter-field-search/readme.md +1 -1
  11. package/components/snk-form/readme.md +10 -20
  12. package/components/snk-grid/readme.md +50 -79
  13. package/components/snk-personalized-filter/readme.md +11 -11
  14. package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
  15. package/components/snk-simple-bar/readme.md +6 -6
  16. package/components/snk-simple-crud/readme.md +58 -60
  17. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
  18. package/components/snk-taskbar/readme.md +22 -22
  19. package/package.json +1 -1
package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md CHANGED
@@ -22,7 +22,7 @@ Fecha o modal de configuração de valor variável
22
22
 
23
23
  Type: `Promise<IExpressionItem>`
24
24
 
25
- ---
25
+
26
26
 
27
27
  ### `open(expressionItem: IExpressionItem) => Promise<IExpressionItem>`
28
28
 
package/components/snk-simple-bar/readme.md CHANGED
@@ -9,17 +9,17 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `breadcrumbItens` | -- | Define os itens que serão apresentados no breadcrumb. | `IBreadcrumbItem[]` | `undefined` |
13
- | `label` | `label` | Define o título do header. | `string` | `undefined` |
12
+ | `breadcrumbItens` | -- | Define os itens que serão apresentados pelo breadcrumb | `IBreadcrumbItem[]` | `undefined` |
13
+ | `label` | `label` | Define o título do header | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
 
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | --------------------- | -------------------------------------------------- | ------------------------------ |
21
- | `clickBreadcrumbItem` | Emitido quando algum item do breadcrumb é clicado. | `CustomEvent<IBreadcrumbItem>` |
22
- | `exit` | Emitido quando o botão "voltar" é acionado. | `CustomEvent<void>` |
19
+ | Event | Description | Type |
20
+ | --------------------- | ------------------------------------------------- | ------------------------------ |
21
+ | `clickBreadcrumbItem` | Emitido quando algum item do breadcrumb é clicado | `CustomEvent<IBreadcrumbItem>` |
22
+ | `exit` | Emitido quando o botão voltar é acionado | `CustomEvent<void>` |
23
23
 
24
24
 
25
25
  ## Dependencies
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,93 +7,93 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------- | ----------------------------------- | ----------- | ------------------------------------------------------- | ------------------------- |
12
- | `actionsList` | -- | | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
15
- | `configName` | `config-name` | | `string` | `undefined` |
16
- | `dataState` | -- | | `DataState` | `undefined` |
17
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
- | `domainMessagesBuilder` | `domain-messages-builder` | | `string` | `undefined` |
19
- | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
20
- | `enableGridInsert` | `enable-grid-insert` | | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | | `boolean` | `false` |
23
- | `entityName` | `entity-name` | | `string` | `undefined` |
24
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
- | `formLegacyConfigName` | `form-legacy-config-name` | | `string` | `undefined` |
26
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
- | `gridLegacyConfigName` | `grid-legacy-config-name` | | `string` | `undefined` |
28
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | | `boolean` | `false` |
29
- | `layoutFormConfig` | `layout-form-config` | | `boolean` | `false` |
30
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
31
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
- | `multipleEditionEnabled` | `multiple-edition-enabled` | | `boolean` | `true` |
33
- | `multipleSelection` | `multiple-selection` | | `boolean` | `undefined` |
34
- | `outlineMode` | `outline-mode` | | `boolean` | `false` |
35
- | `pageSize` | `page-size` | | `number` | `150` |
36
- | `paginationCounterMode` | `pagination-counter-mode` | | `"auto" \| "hidden" \| "show"` | `'auto'` |
37
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
38
- | `showConfiguratorButtons` | `show-configurator-buttons` | | `boolean` | `false` |
39
- | `taskbarManager` | -- | | `TaskbarManager` | `undefined` |
40
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
41
- | `useEnterLikeTab` | `use-enter-like-tab` | | `boolean` | `false` |
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
+ | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
+ | `dataState` | -- | | `DataState` | `undefined` |
17
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
+ | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
19
+ | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
20
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
21
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
22
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
24
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
26
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
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
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
+ | `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
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
34
+ | `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
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
36
+ | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
37
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
38
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `false` |
39
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
40
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
41
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
42
42
 
43
43
 
44
44
  ## Events
45
45
 
46
- | Event | Description | Type |
47
- | -------------------- | ----------- | ---------------------------- |
48
- | `actionClick` | | `CustomEvent<string>` |
49
- | `configuratorCancel` | | `CustomEvent<any>` |
50
- | `configuratorSave` | | `CustomEvent<any>` |
51
- | `dataStateChange` | | `CustomEvent<DataState>` |
52
- | `dataUnitReady` | | `CustomEvent<DataUnit>` |
53
- | `formItemsReady` | | `CustomEvent<HTMLElement[]>` |
46
+ | Event | Description | Type |
47
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
48
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
49
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
50
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
51
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
52
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
53
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
54
54
 
55
55
 
56
56
  ## Methods
57
57
 
58
58
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
59
59
 
60
-
60
+ Registra um editor customizado para campos da grade e formulário.
61
61
 
62
62
  #### Returns
63
63
 
64
64
  Type: `Promise<void>`
65
65
 
66
- ---
67
66
 
68
- ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
69
67
 
68
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
70
69
 
70
+ Registra um formatador de valores para uma coluna da grid.
71
71
 
72
72
  #### Returns
73
73
 
74
74
  Type: `Promise<void>`
75
75
 
76
- ---
77
76
 
78
- ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
79
77
 
78
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
80
79
 
80
+ Registra um render customizado para colunas da grid.
81
81
 
82
82
  #### Returns
83
83
 
84
84
  Type: `Promise<void>`
85
85
 
86
- ---
87
86
 
88
- ### `closeConfigurator() => Promise<void>`
89
87
 
88
+ ### `closeConfigurator() => Promise<void>`
90
89
 
90
+ Usado para fechar o configurator do CRUD
91
91
 
92
92
  #### Returns
93
93
 
94
94
  Type: `Promise<void>`
95
95
 
96
- ---
96
+
97
97
 
98
98
  ### `getRecords() => Promise<Array<Record>>`
99
99
 
@@ -103,49 +103,47 @@ Type: `Promise<void>`
103
103
 
104
104
  Type: `Promise<Record[]>`
105
105
 
106
- Uma promessa que resolve com a lista de registros.
107
106
 
108
- ---
109
107
 
110
108
  ### `goToView(view: VIEW_MODE) => Promise<void>`
111
109
 
112
-
110
+ Usado para alternar a visão entre GRID e FORM externamente.
113
111
 
114
112
  #### Returns
115
113
 
116
114
  Type: `Promise<void>`
117
115
 
118
- ---
119
116
 
120
- ### `openConfigurator() => Promise<void>`
121
117
 
118
+ ### `openConfigurator() => Promise<void>`
122
119
 
120
+ Usado para abrir o configurator do CRUD
123
121
 
124
122
  #### Returns
125
123
 
126
124
  Type: `Promise<void>`
127
125
 
128
- ---
129
126
 
130
- ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
131
127
 
128
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
132
129
 
130
+ Remove o formatador de valores de uma coluna da grid.
133
131
 
134
132
  #### Returns
135
133
 
136
134
  Type: `Promise<void>`
137
135
 
138
- ---
139
136
 
140
- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
141
137
 
138
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
142
139
 
140
+ Altera/adiciona uma propriedade nos metadados do campo.
143
141
 
144
142
  #### Returns
145
143
 
146
144
  Type: `Promise<void>`
147
145
 
148
- ---
146
+
149
147
 
150
148
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
151
149
 
@@ -155,7 +153,7 @@ Type: `Promise<void>`
155
153
 
156
154
  Type: `Promise<void>`
157
155
 
158
- ---
156
+
159
157
 
160
158
  ### `setRecords(records: Array<Record>) => Promise<void>`
161
159
 
@@ -165,7 +163,7 @@ Type: `Promise<void>`
165
163
 
166
164
  Type: `Promise<void>`
167
165
 
168
- ---
166
+
169
167
 
170
168
  ### `updateConfig() => Promise<void>`
171
169
 
package/components/snk-taskbar/elements/taskbar-actions-button/readme.md CHANGED
@@ -33,7 +33,7 @@ Esaconde a lista de ações.
33
33
 
34
34
  Type: `Promise<void>`
35
35
 
36
- ---
36
+
37
37
 
38
38
  ### `isOpened() => Promise<boolean>`
39
39
 
@@ -43,7 +43,7 @@ Informa se a lista de ações está aberta.
43
43
 
44
44
  Type: `Promise<boolean>`
45
45
 
46
- ---
46
+
47
47
 
48
48
  ### `showActions() => Promise<void>`
49
49
 
package/components/snk-taskbar/readme.md CHANGED
@@ -7,32 +7,32 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
- | `actionsList` | -- | | `Action[]` | `undefined` |
13
- | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
- | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
- | `buttons` | `buttons` | | `string` | `undefined` |
16
- | `configName` | `config-name` | | `string` | `undefined` |
17
- | `customButtons` | -- | | `Map<string, CustomButton>` | `undefined` |
18
- | `customContainerId` | `custom-container-id` | | `string` | `undefined` |
19
- | `customSlotId` | `custom-slot-id` | | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
21
- | `disabledButtons` | -- | | `string[]` | `undefined` |
22
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
23
- | `overflowStrategy` | `overflow-strategy` | | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
- | `presentationMode` | `presentation-mode` | | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
- | `primaryButton` | `primary-button` | | `string` | `undefined` |
26
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | --------------------------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
+ | `actionsSettingsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
+ | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
15
+ | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
16
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
17
+ | `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
18
+ | `customContainerId` | `custom-container-id` | Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes. | `string` | `undefined` |
19
+ | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
+ | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
21
+ | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
22
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
+ | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
+ | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
27
27
 
28
28
 
29
29
  ## Events
30
30
 
31
- | Event | Description | Type |
32
- | --------------------- | ----------- | --------------------- |
33
- | `actionClick` | | `CustomEvent<string>` |
34
- | `taskbarSaveLocker` | | `CustomEvent<void>` |
35
- | `taskbarSaveUnlocker` | | `CustomEvent<void>` |
31
+ | Event | Description | Type |
32
+ | --------------------- | ------------------------------------------------------------ | --------------------- |
33
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
34
+ | `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
35
+ | `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
36
36
 
37
37
 
38
38
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.2.0-ms.12",
3
+ "version": "9.2.0-ms.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [