@sankhyalabs/sankhyablocks-docs 9.1.5 → 9.1.6

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 (3) hide show
  1. package/components/snk-form/readme.md +17 -7
  2. package/components/snk-taskbar/readme.md +22 -22
  3. package/package.json +1 -1
package/components/snk-form/readme.md CHANGED
@@ -10,7 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
12
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
16
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
@@ -18,18 +18,18 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
23
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
24
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
25
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
21
+ | Event | Description | Type |
22
+ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
23
+ | `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<string>` |
24
+ | `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
25
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view | `CustomEvent<HTMLElement[]>` |
26
26
 
27
27
 
28
28
  ## Methods
29
29
 
30
30
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
31
31
 
32
- Registra um editor customizado para campos da grade e formulário.
32
+ Registra um editor customizado para campos do formulário.
33
33
 
34
34
  #### Returns
35
35
 
@@ -65,6 +65,16 @@ Exibe a janela de configurações do formulário.
65
65
 
66
66
  Type: `Promise<void>`
67
67
 
68
+ ---
69
+
70
+ ### `validate() => Promise<void>`
71
+
72
+ Valida o formulário.
73
+
74
+ #### Returns
75
+
76
+ Type: `Promise<void>`
77
+
68
78
 
69
79
 
70
80
 
package/components/snk-taskbar/readme.md CHANGED
@@ -7,32 +7,32 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | --------------------------- |
12
- | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
- | `actionsSettingsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
- | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
15
- | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
16
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
17
- | `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` |
18
- | `customContainerId` | `custom-container-id` | Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes. | `string` | `undefined` |
19
- | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
- | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
21
- | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
22
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
- | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
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` |
25
- | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
26
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
+ | `actionsList` | -- | | `Action[]` | `undefined` |
13
+ | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
+ | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
+ | `buttons` | `buttons` | | `string` | `undefined` |
16
+ | `configName` | `config-name` | | `string` | `undefined` |
17
+ | `customButtons` | -- | | `Map<string, CustomButton>` | `undefined` |
18
+ | `customContainerId` | `custom-container-id` | | `string` | `undefined` |
19
+ | `customSlotId` | `custom-slot-id` | | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
21
+ | `disabledButtons` | -- | | `string[]` | `undefined` |
22
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
23
+ | `overflowStrategy` | `overflow-strategy` | | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
+ | `presentationMode` | `presentation-mode` | | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
+ | `primaryButton` | `primary-button` | | `string` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
27
27
 
28
28
 
29
29
  ## Events
30
30
 
31
- | Event | Description | Type |
32
- | --------------------- | ------------------------------------------------------------ | --------------------- |
33
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
34
- | `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
35
- | `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
31
+ | Event | Description | Type |
32
+ | --------------------- | ----------- | --------------------- |
33
+ | `actionClick` | | `CustomEvent<string>` |
34
+ | `taskbarSaveLocker` | | `CustomEvent<void>` |
35
+ | `taskbarSaveUnlocker` | | `CustomEvent<void>` |
36
36
 
37
37
 
38
38
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.1.5",
3
+ "version": "9.1.6",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [