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

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 (20) hide show
  1. package/components/snk-application/readme.md +93 -8
  2. package/components/snk-attach/readme.md +6 -5
  3. package/components/snk-configurator/readme.md +7 -0
  4. package/components/snk-crud/readme.md +40 -24
  5. package/components/snk-crud/subcomponents/readme.md +18 -17
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +27 -22
  7. package/components/snk-filter-bar/readme.md +15 -12
  8. package/components/snk-form-config/readme.md +6 -7
  9. package/components/snk-grid/readme.md +43 -33
  10. package/components/snk-layout-form-config/readme.md +41 -0
  11. package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
  12. package/components/snk-pesquisa/pesquisa-grid/readme.md +42 -0
  13. package/components/snk-pesquisa/pesquisa-tree/readme.md +53 -0
  14. package/components/snk-pesquisa/readme.md +16 -5
  15. package/components/snk-simple-crud/readme.md +40 -31
  16. package/components/snk-simple-form-config/readme.md +51 -0
  17. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
  18. package/components/snk-taskbar/readme.md +24 -19
  19. package/components/teste-pesquisa/readme.md +2 -0
  20. package/package.json +1 -1
package/components/snk-simple-form-config/readme.md ADDED
@@ -0,0 +1,51 @@
1
+ # snk-simple-form-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ------------------------------------------------- | ---------- | ----------- |
12
+ | `configName` | `config-name` | Chave que representa a configuração do formulário | `string` | `undefined` |
13
+ | `dataUnit` | -- | Data unit responsável pelos campos disponíveis | `DataUnit` | `undefined` |
14
+
15
+
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | ---------------- | ----------- | ------------------- |
20
+ | `snkConfigSaved` | | `CustomEvent<void>` |
21
+
22
+
23
+ ## Methods
24
+
25
+ ### `show() => Promise<void>`
26
+
27
+ Responsável por abrir o configurador.
28
+
29
+ #### Returns
30
+
31
+ Type: `Promise<void>`
32
+
33
+
34
+
35
+
36
+ ## Dependencies
37
+
38
+ ### Used by
39
+
40
+ - [snk-simple-crud](../snk-simple-crud)
41
+
42
+ ### Graph
43
+ ```mermaid
44
+ graph TD;
45
+ snk-simple-crud --> snk-simple-form-config
46
+ style snk-simple-form-config fill:#f9f,stroke:#333,stroke-width:4px
47
+ ```
48
+
49
+ ----------------------------------------------
50
+
51
+
package/components/snk-taskbar/elements/taskbar-split-button/readme.md ADDED
@@ -0,0 +1,47 @@
1
+ # taskbar-split-button
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ----------------- | -------------------------------------------------------------------------- | ------------------------ | ----------- |
12
+ | `action` | -- | Função de callback acionada ao clicar no botão principal. | `(name: string) => void` | `undefined` |
13
+ | `actions` | -- | Define a lista de ações disponíveis no dropdown do botão. | `Action[]` | `undefined` |
14
+ | `className` | `class-name` | Classe CSS personalizada para estilizar o botão. | `string` | `undefined` |
15
+ | `dataElementId` | `data-element-id` | Identificador de elemento para fins de rastreamento e automação de testes. | `string` | `undefined` |
16
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o componente. | `boolean` | `undefined` |
17
+ | `iconName` | `icon-name` | Nome do ícone a ser exibido no botão. | `string` | `undefined` |
18
+ | `name` | `name` | Nome identificador da ação do botão. | `string` | `undefined` |
19
+ | `title` | `title` | Texto que será exibido no botão. | `string` | `undefined` |
20
+
21
+
22
+ ## Dependencies
23
+
24
+ ### Used by
25
+
26
+ - [snk-crud](../../../snk-crud)
27
+ - [snk-detail-view](../../../snk-crud/subcomponents/snk-detail-view)
28
+ - [snk-grid](../../../snk-grid)
29
+ - [snk-guides-viewer](../../../snk-crud/subcomponents)
30
+ - [snk-simple-crud](../../../snk-simple-crud)
31
+ - [snk-taskbar](../..)
32
+
33
+ ### Graph
34
+ ```mermaid
35
+ graph TD;
36
+ snk-crud --> taskbar-split-button
37
+ snk-detail-view --> taskbar-split-button
38
+ snk-grid --> taskbar-split-button
39
+ snk-guides-viewer --> taskbar-split-button
40
+ snk-simple-crud --> taskbar-split-button
41
+ snk-taskbar --> taskbar-split-button
42
+ style taskbar-split-button fill:#f9f,stroke:#333,stroke-width:4px
43
+ ```
44
+
45
+ ----------------------------------------------
46
+
47
+
package/components/snk-taskbar/readme.md CHANGED
@@ -7,29 +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
- | `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
29
30
 
30
- | Event | Description | Type |
31
- | ------------- | ------------------------------------------------- | --------------------- |
32
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
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>` |
33
36
 
34
37
 
35
38
  ## Dependencies
@@ -45,6 +48,7 @@
45
48
 
46
49
  - [snk-data-exporter](../snk-data-exporter)
47
50
  - [snk-actions-button](../snk-actions-button)
51
+ - [taskbar-split-button](./elements/taskbar-split-button)
48
52
  - [taskbar-actions-button](./elements/taskbar-actions-button)
49
53
 
50
54
  ### Graph
@@ -52,6 +56,7 @@
52
56
  graph TD;
53
57
  snk-taskbar --> snk-data-exporter
54
58
  snk-taskbar --> snk-actions-button
59
+ snk-taskbar --> taskbar-split-button
55
60
  snk-taskbar --> taskbar-actions-button
56
61
  snk-data-exporter --> snk-exporter-email-sender
57
62
  snk-detail-view --> snk-taskbar
package/components/teste-pesquisa/readme.md CHANGED
@@ -16,6 +16,8 @@
16
16
  graph TD;
17
17
  teste-pesquisa --> snk-application
18
18
  snk-application --> snk-pesquisa
19
+ snk-pesquisa --> pesquisa-grid
20
+ snk-pesquisa --> pesquisa-tree
19
21
  style teste-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
20
22
  ```
21
23
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.16.0-dev.11",
3
+ "version": "8.16.0-dev.111",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [