@sankhyalabs/sankhyablocks-docs 9.0.1 → 9.1.0-dev.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.
Files changed (31) hide show
  1. package/components/snk-application/readme.md +41 -0
  2. package/components/snk-attach/readme.md +4 -0
  3. package/components/snk-configurator/readme.md +7 -0
  4. package/components/snk-crud/readme.md +19 -3
  5. package/components/snk-crud/subcomponents/readme.md +22 -18
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +25 -17
  7. package/components/snk-filter-bar/filter-modal/readme.md +15 -12
  8. package/components/snk-filter-bar/filter-modal/subcomponents/snk-default-filter/readme.md +38 -0
  9. package/components/snk-form/readme.md +8 -3
  10. package/components/snk-form-config/config-header/configs-button/readme.md +40 -0
  11. package/components/snk-form-config/config-header/readme.md +47 -0
  12. package/components/snk-form-config/field-item/field-config/readme.md +53 -0
  13. package/components/snk-form-config/field-item/readme.md +48 -0
  14. package/components/snk-form-config/fields-layout/readme.md +64 -0
  15. package/components/snk-form-config/fields-selector/readme.md +44 -0
  16. package/components/snk-form-config/guides-configurator/readme.md +42 -0
  17. package/components/snk-form-config/readme.md +13 -7
  18. package/components/snk-grid/readme.md +6 -10
  19. package/components/snk-layout-form-config/readme.md +41 -0
  20. package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
  21. package/components/snk-personalized-filter/readme.md +8 -7
  22. package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +8 -7
  23. package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +7 -6
  24. package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +8 -7
  25. package/components/snk-simple-crud/readme.md +8 -1
  26. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
  27. package/components/snk-taskbar/readme.md +19 -16
  28. package/package.json +1 -1
  29. package/components/snk-form-config/subcomponents/snk-config-options/readme.md +0 -40
  30. package/components/snk-form-config/subcomponents/snk-field-config/readme.md +0 -41
  31. package/components/snk-form-config/subcomponents/snk-tab-config/readme.md +0 -46
package/components/snk-taskbar/readme.md CHANGED
@@ -7,22 +7,23 @@
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
- | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
14
- | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
15
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
16
- | `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` |
17
- | `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` |
18
- | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
19
- | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
20
- | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
21
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
- | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
23
- | `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
- | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
25
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
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` |
26
27
 
27
28
 
28
29
  ## Events
@@ -47,6 +48,7 @@
47
48
 
48
49
  - [snk-data-exporter](../snk-data-exporter)
49
50
  - [snk-actions-button](../snk-actions-button)
51
+ - [taskbar-split-button](./elements/taskbar-split-button)
50
52
  - [taskbar-actions-button](./elements/taskbar-actions-button)
51
53
 
52
54
  ### Graph
@@ -54,6 +56,7 @@
54
56
  graph TD;
55
57
  snk-taskbar --> snk-data-exporter
56
58
  snk-taskbar --> snk-actions-button
59
+ snk-taskbar --> taskbar-split-button
57
60
  snk-taskbar --> taskbar-actions-button
58
61
  snk-data-exporter --> snk-exporter-email-sender
59
62
  snk-detail-view --> snk-taskbar
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.0.1",
3
+ "version": "9.1.0-dev.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/components/snk-form-config/subcomponents/snk-config-options/readme.md DELETED
@@ -1,40 +0,0 @@
1
- # ez-config-options
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
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` |
16
-
17
-
18
- ## Events
19
-
20
- | Event | Description | Type |
21
- | ---------------------- | ------------------------------------------------ | ------------------ |
22
- | `configOptionsChanged` | Emitido ao realizar alguma alteração nos campos. | `CustomEvent<any>` |
23
-
24
-
25
- ## Dependencies
26
-
27
- ### Used by
28
-
29
- - [snk-form-config](../..)
30
-
31
- ### Graph
32
- ```mermaid
33
- graph TD;
34
- snk-form-config --> snk-config-options
35
- style snk-config-options fill:#f9f,stroke:#333,stroke-width:4px
36
- ```
37
-
38
- ----------------------------------------------
39
-
40
-
package/components/snk-form-config/subcomponents/snk-field-config/readme.md DELETED
@@ -1,41 +0,0 @@
1
- # ez-field-config
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
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` |
17
-
18
-
19
- ## Events
20
-
21
- | Event | Description | Type |
22
- | ------------- | ------------------------------------ | --------------------- |
23
- | `ezClickIcon` | Emitido ao clicar no ícone do botão. | `CustomEvent<Object>` |
24
-
25
-
26
- ## Dependencies
27
-
28
- ### Used by
29
-
30
- - [snk-form-config](../..)
31
-
32
- ### Graph
33
- ```mermaid
34
- graph TD;
35
- snk-form-config --> snk-field-config
36
- style snk-field-config fill:#f9f,stroke:#333,stroke-width:4px
37
- ```
38
-
39
- ----------------------------------------------
40
-
41
-
package/components/snk-form-config/subcomponents/snk-tab-config/readme.md DELETED
@@ -1,46 +0,0 @@
1
- # ez-tab-config
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
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
- | `selectedIndex` | `selected-index` | Define o index da aba selecionada. | `number` | `undefined` |
14
- | `selectedTab` | `selected-tab` | Define a aba selecionada. | `string` | `undefined` |
15
- | `tabItems` | -- | Define o nome das abas do componente separadas por vírgulas ",". | `ITab[]` | `undefined` |
16
- | `tabs` | `tabs` | Define o nome das abas do componente separadas por vírgulas ",". | `string` | `undefined` |
17
-
18
-
19
- ## Events
20
-
21
- | Event | Description | Type |
22
- | ----------------- | ----------------------------------------------------------- | --------------------- |
23
- | `canStartDrag` | Emitido ao ocultar uma aba. | `CustomEvent<any>` |
24
- | `deleteTab` | Emitido ao deletar uma aba. | `CustomEvent<any>` |
25
- | `editionTitleTab` | Emitido ao salvar uma alteração realizada no título da tab. | `CustomEvent<any>` |
26
- | `ezOrderChange` | Emitido ao mover a ordem da aba. | `CustomEvent<number>` |
27
- | `ezTabChange` | Emitido ao clicar para abrir o popup. | `CustomEvent<ITab>` |
28
- | `hideTab` | Emitido ao ocultar uma aba. | `CustomEvent<any>` |
29
-
30
-
31
- ## Dependencies
32
-
33
- ### Used by
34
-
35
- - [snk-form-config](../..)
36
-
37
- ### Graph
38
- ```mermaid
39
- graph TD;
40
- snk-form-config --> snk-tab-config
41
- style snk-tab-config fill:#f9f,stroke:#333,stroke-width:4px
42
- ```
43
-
44
- ----------------------------------------------
45
-
46
-