@sankhyalabs/sankhyablocks-docs 8.16.0-rc.1 → 8.16.0-rc.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. package/components/snk-attach/readme.md +1 -1
  2. package/components/snk-crud/readme.md +10 -7
  3. package/components/snk-crud/subcomponents/readme.md +3 -1
  4. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -1
  5. package/components/snk-filter-bar/readme.md +13 -12
  6. package/components/snk-grid/readme.md +1 -0
  7. package/components/snk-simple-crud/readme.md +27 -26
  8. package/components/snk-taskbar/readme.md +5 -3
  9. 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,6 +15,7 @@
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` |
@@ -24,6 +25,7 @@
24
25
  | `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
26
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
26
27
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
28
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
27
29
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
28
30
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
29
31
  | `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 +34,13 @@
32
34
 
33
35
  ## Events
34
36
 
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[]>` |
37
+ | Event | Description | Type |
38
+ | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
39
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
40
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
41
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
42
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
43
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
41
44
 
42
45
 
43
46
  ## Methods
@@ -208,8 +211,8 @@ graph TD;
208
211
  snk-detail-view --> taskbar-actions-button
209
212
  snk-attach --> snk-simple-bar
210
213
  snk-attach --> snk-simple-crud
211
- snk-simple-crud --> snk-data-unit
212
214
  snk-simple-crud --> snk-taskbar
215
+ snk-simple-crud --> snk-data-unit
213
216
  snk-simple-crud --> snk-form-config
214
217
  snk-simple-crud --> snk-configurator
215
218
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -15,8 +15,10 @@
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` |
20
22
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
21
23
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
24
  | `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 +164,8 @@ graph TD;
162
164
  snk-grid-config --> snk-select-box
163
165
  snk-attach --> snk-simple-bar
164
166
  snk-attach --> snk-simple-crud
165
- snk-simple-crud --> snk-data-unit
166
167
  snk-simple-crud --> snk-taskbar
168
+ snk-simple-crud --> snk-data-unit
167
169
  snk-simple-crud --> snk-form-config
168
170
  snk-simple-crud --> snk-configurator
169
171
  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,19 @@
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
+ | `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
+ | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
15
+ | `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` |
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
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
18
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
19
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
21
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
22
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
22
23
 
23
24
 
24
25
  ## 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
@@ -7,30 +7,31 @@
7
7
 
8
8
  ## Properties
9
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
- | `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` | Ignora os campos "somente leitura" no modo de inserção. Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `'InMemoryDomain'` |
19
- | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
20
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
21
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
22
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
23
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
24
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
25
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
26
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
27
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
28
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
29
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
30
- | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
31
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
32
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
33
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `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
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
20
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
21
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
22
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
23
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
24
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
25
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
26
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
27
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
28
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
29
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
30
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
31
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
32
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
33
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
34
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
34
35
 
35
36
 
36
37
  ## Events
@@ -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.1",
3
+ "version": "8.16.0-rc.11",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [