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

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 (5) hide show
  1. package/components/snk-crud/readme.md +9 -6
  2. package/components/snk-crud/subcomponents/readme.md +1 -0
  3. package/components/snk-data-unit/readme.md +15 -14
  4. package/components/snk-simple-crud/readme.md +1 -0
  5. package/package.json +1 -1
package/components/snk-crud/readme.md CHANGED
@@ -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` |
@@ -23,6 +24,7 @@
23
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` |
24
25
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
25
26
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
27
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
26
28
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
27
29
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
28
30
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -31,12 +33,13 @@
31
33
 
32
34
  ## Events
33
35
 
34
- | Event | Description | Type |
35
- | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
36
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
37
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
38
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
39
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
36
+ | Event | Description | Type |
37
+ | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
38
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
39
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
40
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
41
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
42
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
40
43
 
41
44
 
42
45
  ## Methods
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -17,6 +17,7 @@
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
18
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
19
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
20
+ | `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
20
21
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
21
22
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
23
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
package/components/snk-data-unit/readme.md CHANGED
@@ -7,20 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
19
- | `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
20
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
22
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
- | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
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
package/components/snk-simple-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
  | `dataState` | -- | | `DataState` | `undefined` |
17
17
  | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
+ | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
18
19
  | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
19
20
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
20
21
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.16.0-dev.1",
3
+ "version": "8.16.0-dev.11",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [