@sankhyalabs/sankhyablocks-docs 8.16.0-rc.2 → 8.16.0-rc.20

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 (10) hide show
  1. package/components/snk-attach/readme.md +1 -1
  2. package/components/snk-crud/readme.md +11 -7
  3. package/components/snk-crud/subcomponents/readme.md +4 -1
  4. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -1
  5. package/components/snk-filter-bar/readme.md +14 -12
  6. package/components/snk-form-config/readme.md +6 -5
  7. package/components/snk-grid/readme.md +1 -0
  8. package/components/snk-simple-crud/readme.md +3 -2
  9. package/components/snk-taskbar/readme.md +5 -3
  10. package/package.json +1 -1
package/components/snk-attach/readme.md CHANGED
@@ -42,8 +42,8 @@
42
42
  graph TD;
43
43
  snk-attach --> snk-simple-bar
44
44
  snk-attach --> snk-simple-crud
45
- snk-simple-crud --> snk-data-unit
46
45
  snk-simple-crud --> snk-taskbar
46
+ snk-simple-crud --> snk-data-unit
47
47
  snk-simple-crud --> snk-form-config
48
48
  snk-simple-crud --> snk-configurator
49
49
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/readme.md CHANGED
@@ -15,15 +15,18 @@
15
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
16
  | `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
17
  | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
18
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
18
19
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
19
20
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
20
21
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
21
22
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
23
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
22
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
25
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
24
26
  | `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
27
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
26
28
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
29
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
27
30
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
28
31
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
29
32
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -32,12 +35,13 @@
32
35
 
33
36
  ## Events
34
37
 
35
- | Event | Description | Type |
36
- | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
37
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
38
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
39
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
40
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
38
+ | Event | Description | Type |
39
+ | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
40
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
41
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
42
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
43
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
44
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
41
45
 
42
46
 
43
47
  ## Methods
@@ -208,8 +212,8 @@ graph TD;
208
212
  snk-detail-view --> taskbar-actions-button
209
213
  snk-attach --> snk-simple-bar
210
214
  snk-attach --> snk-simple-crud
211
- snk-simple-crud --> snk-data-unit
212
215
  snk-simple-crud --> snk-taskbar
216
+ snk-simple-crud --> snk-data-unit
213
217
  snk-simple-crud --> snk-form-config
214
218
  snk-simple-crud --> snk-configurator
215
219
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -15,8 +15,11 @@
15
15
  | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
16
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
17
  | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
18
19
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
20
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
21
+ | `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
22
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
20
23
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
21
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
25
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
@@ -162,8 +165,8 @@ graph TD;
162
165
  snk-grid-config --> snk-select-box
163
166
  snk-attach --> snk-simple-bar
164
167
  snk-attach --> snk-simple-crud
165
- snk-simple-crud --> snk-data-unit
166
168
  snk-simple-crud --> snk-taskbar
169
+ snk-simple-crud --> snk-data-unit
167
170
  snk-simple-crud --> snk-form-config
168
171
  snk-simple-crud --> snk-configurator
169
172
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -142,8 +142,8 @@ graph TD;
142
142
  snk-form-view --> snk-form-summary
143
143
  snk-attach --> snk-simple-bar
144
144
  snk-attach --> snk-simple-crud
145
- snk-simple-crud --> snk-data-unit
146
145
  snk-simple-crud --> snk-taskbar
146
+ snk-simple-crud --> snk-data-unit
147
147
  snk-simple-crud --> snk-form-config
148
148
  snk-simple-crud --> snk-configurator
149
149
  snk-simple-crud --> snk-grid-config
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,18 +7,20 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
12
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
13
- | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
14
- | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
15
- | `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` |
16
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
17
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
18
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
- | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
20
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
21
- | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
12
+ | `afterFilterModalApply` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
13
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
14
+ | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
15
+ | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
+ | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
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` |
18
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
19
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
22
24
 
23
25
 
24
26
  ## Events
package/components/snk-form-config/readme.md CHANGED
@@ -7,11 +7,12 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | --------- | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
- | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
- | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
+ | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
+ | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
15
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
16
 
16
17
 
17
18
  ## Events
package/components/snk-grid/readme.md CHANGED
@@ -16,6 +16,7 @@
16
16
  | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
17
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
18
18
  | `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` |
19
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
19
20
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
20
21
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
21
22
  | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
package/components/snk-simple-crud/readme.md CHANGED
@@ -16,6 +16,7 @@
16
16
  | `dataState` | -- | | `DataState` | `undefined` |
17
17
  | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
18
  | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
19
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
19
20
  | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
20
21
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
21
22
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
@@ -176,8 +177,8 @@ Type: `Promise<void>`
176
177
 
177
178
  ### Depends on
178
179
 
179
- - [snk-data-unit](../snk-data-unit)
180
180
  - [snk-taskbar](../snk-taskbar)
181
+ - [snk-data-unit](../snk-data-unit)
181
182
  - [snk-form-config](../snk-form-config)
182
183
  - [snk-configurator](../snk-configurator)
183
184
  - [snk-grid-config](../snk-grid-config)
@@ -188,8 +189,8 @@ Type: `Promise<void>`
188
189
  ### Graph
189
190
  ```mermaid
190
191
  graph TD;
191
- snk-simple-crud --> snk-data-unit
192
192
  snk-simple-crud --> snk-taskbar
193
+ snk-simple-crud --> snk-data-unit
193
194
  snk-simple-crud --> snk-form-config
194
195
  snk-simple-crud --> snk-configurator
195
196
  snk-simple-crud --> snk-grid-config
package/components/snk-taskbar/readme.md CHANGED
@@ -27,9 +27,11 @@
27
27
 
28
28
  ## Events
29
29
 
30
- | Event | Description | Type |
31
- | ------------- | ------------------------------------------------- | --------------------- |
32
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
30
+ | Event | Description | Type |
31
+ | --------------------- | ------------------------------------------------------------ | --------------------- |
32
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
33
+ | `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
34
+ | `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
33
35
 
34
36
 
35
37
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.16.0-rc.2",
3
+ "version": "8.16.0-rc.20",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [