@sankhyalabs/sankhyablocks-docs 8.16.0-dev.6 → 8.16.0-rc.1
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.
@@ -14,6 +14,7 @@
|
|
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
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
|
+
| `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
|
17
18
|
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
18
19
|
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
19
20
|
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
@@ -7,20 +7,21 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `afterSave`
|
13
|
-
| `beforeSave`
|
14
|
-
| `configName`
|
15
|
-
| `dataState`
|
16
|
-
| `dataUnit`
|
17
|
-
| `dataUnitName`
|
18
|
-
| `
|
19
|
-
| `
|
20
|
-
| `
|
21
|
-
| `
|
22
|
-
| `
|
23
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
|
12
|
+
| `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
|
13
|
+
| `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
|
14
|
+
| `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
|
15
|
+
| `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
|
16
|
+
| `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
|
17
|
+
| `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
|
18
|
+
| `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
|
19
|
+
| `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
|
20
|
+
| `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
|
21
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
22
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
23
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
24
|
+
| `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
|
24
25
|
|
25
26
|
|
26
27
|
## Events
|
@@ -7,29 +7,30 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| -------------------------- | ------------------------------ |
|
12
|
-
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
|
13
|
-
| `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada.
|
14
|
-
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado.
|
15
|
-
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção.
|
16
|
-
| `dataState` | -- |
|
17
|
-
| `dataUnit` | -- |
|
18
|
-
| `
|
19
|
-
| `
|
20
|
-
| `
|
21
|
-
| `
|
22
|
-
| `
|
23
|
-
| `
|
24
|
-
| `
|
25
|
-
| `
|
26
|
-
| `
|
27
|
-
| `
|
28
|
-
| `
|
29
|
-
| `
|
30
|
-
| `
|
31
|
-
| `
|
32
|
-
| `
|
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` |
|
33
34
|
|
34
35
|
|
35
36
|
## Events
|