@sankhyalabs/sankhyablocks-docs 5.1.3 → 5.2.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.
- package/components/snk-application/readme.md +4 -4
- package/components/snk-configurator/readme.md +5 -4
- package/components/snk-crud/readme.md +1 -0
- package/components/snk-crud/subcomponents/readme.md +1 -0
- package/components/snk-data-exporter/readme.md +4 -3
- package/components/snk-data-unit/readme.md +17 -15
- package/components/snk-filter-bar/readme.md +6 -5
- package/components/snk-form/readme.md +5 -4
- package/components/snk-form/subcomponents/snk-config-options/readme.md +6 -5
- package/components/snk-form/subcomponents/snk-field-config/readme.md +7 -6
- package/components/snk-form/subcomponents/snk-form-config/readme.md +5 -4
- package/components/snk-form/subcomponents/snk-tab-config/readme.md +6 -5
- package/components/snk-grid/readme.md +1 -0
- package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +7 -0
- package/components/snk-simple-crud/readme.md +7 -6
- package/components/snk-taskbar/readme.md +1 -0
- package/package.json +1 -1
@@ -7,10 +7,10 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| ----------------- | ------------- |
|
12
|
-
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção.
|
13
|
-
| `messagesBuilder` | -- |
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ------------- | ------------------------------------------------------------ | ------------------- | ----------- |
|
12
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
13
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
14
14
|
|
15
15
|
|
16
16
|
## Events
|
@@ -7,10 +7,11 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `configName`
|
13
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ------------- | -------------------------------------------------------------------------------------- | ---------------------------------- | ---------------- |
|
12
|
+
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
13
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
14
|
+
| `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
|
14
15
|
|
15
16
|
|
16
17
|
## Events
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------- |
|
12
12
|
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
13
|
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
14
15
|
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
15
16
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
|
16
17
|
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
@@ -16,6 +16,7 @@
|
|
16
16
|
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
|
17
17
|
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
|
18
18
|
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
19
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
19
20
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
|
20
21
|
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
21
22
|
| `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
|
@@ -7,9 +7,10 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
13
|
+
| `provider` | -- | Provedor das informações para exportação dos dados. | `IExporterProvider` | `null` |
|
13
14
|
|
14
15
|
|
15
16
|
## Dependencies
|
@@ -7,25 +7,27 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `afterSave`
|
13
|
-
| `beforeSave`
|
14
|
-
| `dataState`
|
15
|
-
| `dataUnit`
|
16
|
-
| `dataUnitName`
|
17
|
-
| `entityName`
|
18
|
-
| `
|
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
|
+
| `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
|
15
|
+
| `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
|
16
|
+
| `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
|
17
|
+
| `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
|
18
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
19
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
19
20
|
|
20
21
|
|
21
22
|
## Events
|
22
23
|
|
23
|
-
| Event
|
24
|
-
|
|
25
|
-
| `cancelEdition`
|
26
|
-
| `dataStateChange`
|
27
|
-
| `dataUnitReady`
|
28
|
-
| `insertionMode`
|
24
|
+
| Event | Description | Type |
|
25
|
+
| ------------------------ | --------------------------------------------------------- | -------------------------------- |
|
26
|
+
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
|
27
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
28
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
29
|
+
| `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
|
30
|
+
| `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
|
29
31
|
|
30
32
|
|
31
33
|
## Methods
|
@@ -7,11 +7,12 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `configName`
|
13
|
-
| `dataUnit`
|
14
|
-
| `filterConfig`
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
|
12
|
+
| `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` |
|
13
|
+
| `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` |
|
14
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `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
|
## Dependencies
|
@@ -7,10 +7,11 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| ------------------ | ------------- |
|
12
|
-
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário.
|
13
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------------ | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
13
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
14
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
14
15
|
|
15
16
|
|
16
17
|
## Events
|
@@ -7,11 +7,12 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `dataUnit`
|
13
|
-
| `fieldConfig`
|
14
|
-
| `idConfig`
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ----------- | -------------------------------------------------------------------------------------- | ------------------- | -------------------- |
|
12
|
+
| `dataUnit` | -- | Repositório de dados responsável por controlar a manipulação dos dados. | `DataUnit` | `undefined` |
|
13
|
+
| `fieldConfig` | -- | Armazena as propriedades do campo. | `IFieldConfig` | `{} as IFieldConfig` |
|
14
|
+
| `idConfig` | `id-config` | Armazena a chave de opções de configuração. | `string` | `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
|
@@ -7,12 +7,13 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `dataUnit`
|
13
|
-
| `fieldConfig`
|
14
|
-
| `isConfigActive`
|
15
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ---------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
13
|
+
| `fieldConfig` | -- | Armazena as propriedades do campo. | `IFieldConfig` | `undefined` |
|
14
|
+
| `isConfigActive` | -- | Define se o popover de configuração está ativo. | `Boolean` | `false` |
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
16
|
+
| `modeInsertion` | `mode-insertion` | Define se o componente está em modo de inserção. | `boolean` | `true` |
|
16
17
|
|
17
18
|
|
18
19
|
## Events
|
@@ -7,10 +7,11 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `configManager`
|
13
|
-
| `dataUnit`
|
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` |
|
14
15
|
|
15
16
|
|
16
17
|
## Events
|
@@ -7,11 +7,12 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `
|
13
|
-
| `
|
14
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ---------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
13
|
+
| `selectedIndex` | `selected-index` | Define o index da aba selecionada. | `number` | `undefined` |
|
14
|
+
| `selectedTab` | `selected-tab` | Define a aba selecionada. | `string` | `undefined` |
|
15
|
+
| `tabs` | `tabs` | Define o nome das abas do componente separadas por vírgulas ",". | `string` | `undefined` |
|
15
16
|
|
16
17
|
|
17
18
|
## Events
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
13
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
14
14
|
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
15
16
|
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
16
17
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
|
17
18
|
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `IStatusResolver` | `undefined` |
|
@@ -5,6 +5,13 @@
|
|
5
5
|
<!-- Auto Generated Below -->
|
6
6
|
|
7
7
|
|
8
|
+
## Properties
|
9
|
+
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
13
|
+
|
14
|
+
|
8
15
|
## Methods
|
9
16
|
|
10
17
|
### `close() => Promise<IExpressionItem>`
|
@@ -7,12 +7,13 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `dataState`
|
13
|
-
| `dataUnit`
|
14
|
-
| `
|
15
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
|
12
|
+
| `dataState` | -- | | `DataState` | `undefined` |
|
13
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
15
|
+
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
16
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
16
17
|
|
17
18
|
|
18
19
|
## Events
|
@@ -15,6 +15,7 @@
|
|
15
15
|
| `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` |
|
16
16
|
| `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
|
17
17
|
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
|
18
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
18
19
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
|
19
20
|
| `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
|
20
21
|
|