@sankhyalabs/sankhyablocks-docs 5.4.2 → 5.5.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.
Files changed (10) hide show
  1. package/components/snk-attach/readme.md +51 -0
  2. package/components/snk-configurator/readme.md +9 -9
  3. package/components/snk-crud/readme.md +8 -0
  4. package/components/snk-crud/subcomponents/readme.md +1 -0
  5. package/components/snk-data-exporter/readme.md +2 -0
  6. package/components/snk-data-unit/readme.md +11 -10
  7. package/components/snk-grid/readme.md +2 -0
  8. package/components/snk-simple-bar/readme.md +18 -4
  9. package/components/snk-simple-crud/readme.md +15 -7
  10. package/package.json +1 -1
package/components/snk-attach/readme.md ADDED
@@ -0,0 +1,51 @@
1
+ # snk-attach
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `entityName` _(required)_ | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
13
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
+ | `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ------ | -------------------------------------------------------- | ------------------- |
21
+ | `back` | Evento disparado quando o usuário clica no botão voltar. | `CustomEvent<void>` |
22
+
23
+
24
+ ## Dependencies
25
+
26
+ ### Used by
27
+
28
+ - [snk-crud](../snk-crud)
29
+
30
+ ### Depends on
31
+
32
+ - [snk-simple-bar](../snk-simple-bar)
33
+ - [snk-simple-crud](../snk-simple-crud)
34
+
35
+ ### Graph
36
+ ```mermaid
37
+ graph TD;
38
+ snk-attach --> snk-simple-bar
39
+ snk-attach --> snk-simple-crud
40
+ snk-simple-crud --> snk-data-unit
41
+ snk-simple-crud --> snk-taskbar
42
+ snk-simple-crud --> snk-data-exporter
43
+ snk-taskbar --> snk-data-exporter
44
+ snk-data-exporter --> snk-exporter-email-sender
45
+ snk-crud --> snk-attach
46
+ style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
47
+ ```
48
+
49
+ ----------------------------------------------
50
+
51
+
package/components/snk-configurator/readme.md CHANGED
@@ -7,19 +7,19 @@
7
7
 
8
8
  ## Properties
9
9
 
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` |
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.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
15
15
 
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | ---------------- | ------------------------------------------------ | ----------------------------------------------- |
21
- | `configSelected` | Emitido quando seleciona o modo de visualização. | `CustomEvent<VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
22
- | `openConfig` | Emitido quando clica para abrir a configuração. | `CustomEvent<VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
19
+ | Event | Description | Type |
20
+ | ---------------- | ------------------------------------------------ | ----------------------------------------------------------------------- |
21
+ | `configSelected` | Emitido quando seleciona o modo de visualização. | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
22
+ | `openConfig` | Emitido quando clica para abrir a configuração. | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
23
23
 
24
24
 
25
25
  ## Methods
package/components/snk-crud/readme.md CHANGED
@@ -45,6 +45,7 @@ Type: `Promise<void>`
45
45
 
46
46
  - [snk-grid](../snk-grid)
47
47
  - [snk-guides-viewer](subcomponents)
48
+ - [snk-attach](../snk-attach)
48
49
  - [snk-configurator](../snk-configurator)
49
50
  - [snk-data-exporter](../snk-data-exporter)
50
51
 
@@ -53,11 +54,13 @@ Type: `Promise<void>`
53
54
  graph TD;
54
55
  snk-crud --> snk-grid
55
56
  snk-crud --> snk-guides-viewer
57
+ snk-crud --> snk-attach
56
58
  snk-crud --> snk-configurator
57
59
  snk-crud --> snk-data-exporter
58
60
  snk-grid --> snk-filter-bar
59
61
  snk-grid --> snk-taskbar
60
62
  snk-grid --> snk-grid-config
63
+ snk-grid --> snk-data-exporter
61
64
  snk-filter-bar --> snk-filter-item
62
65
  snk-filter-bar --> snk-filter-modal
63
66
  snk-filter-bar --> snk-filter-list
@@ -81,6 +84,11 @@ graph TD;
81
84
  snk-form-config --> snk-field-config
82
85
  snk-form-config --> snk-config-options
83
86
  snk-form-config --> snk-tab-config
87
+ snk-attach --> snk-simple-bar
88
+ snk-attach --> snk-simple-crud
89
+ snk-simple-crud --> snk-data-unit
90
+ snk-simple-crud --> snk-taskbar
91
+ snk-simple-crud --> snk-data-exporter
84
92
  style snk-crud fill:#f9f,stroke:#333,stroke-width:4px
85
93
  ```
86
94
 
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -79,6 +79,7 @@ graph TD;
79
79
  snk-grid --> snk-filter-bar
80
80
  snk-grid --> snk-taskbar
81
81
  snk-grid --> snk-grid-config
82
+ snk-grid --> snk-data-exporter
82
83
  snk-filter-bar --> snk-filter-item
83
84
  snk-filter-bar --> snk-filter-modal
84
85
  snk-filter-bar --> snk-filter-list
package/components/snk-data-exporter/readme.md CHANGED
@@ -19,6 +19,7 @@
19
19
 
20
20
  - [snk-crud](../snk-crud)
21
21
  - [snk-detail-view](../snk-crud/subcomponents)
22
+ - [snk-grid](../snk-grid)
22
23
  - [snk-guides-viewer](../snk-crud/subcomponents)
23
24
  - [snk-simple-crud](../snk-simple-crud)
24
25
  - [snk-taskbar](../snk-taskbar)
@@ -33,6 +34,7 @@ graph TD;
33
34
  snk-data-exporter --> snk-exporter-email-sender
34
35
  snk-crud --> snk-data-exporter
35
36
  snk-detail-view --> snk-data-exporter
37
+ snk-grid --> snk-data-exporter
36
38
  snk-guides-viewer --> snk-data-exporter
37
39
  snk-simple-crud --> snk-data-exporter
38
40
  snk-taskbar --> snk-data-exporter
package/components/snk-data-unit/readme.md CHANGED
@@ -7,16 +7,17 @@
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
- | `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` |
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` |
20
+ | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
20
21
 
21
22
 
22
23
  ## Events
package/components/snk-grid/readme.md CHANGED
@@ -72,6 +72,7 @@ Type: `Promise<void>`
72
72
  - [snk-filter-bar](../snk-filter-bar)
73
73
  - [snk-taskbar](../snk-taskbar)
74
74
  - [snk-grid-config](./subcomponents/snk-grid-config)
75
+ - [snk-data-exporter](../snk-data-exporter)
75
76
 
76
77
  ### Graph
77
78
  ```mermaid
@@ -79,6 +80,7 @@ graph TD;
79
80
  snk-grid --> snk-filter-bar
80
81
  snk-grid --> snk-taskbar
81
82
  snk-grid --> snk-grid-config
83
+ snk-grid --> snk-data-exporter
82
84
  snk-filter-bar --> snk-filter-item
83
85
  snk-filter-bar --> snk-filter-modal
84
86
  snk-filter-bar --> snk-filter-list
package/components/snk-simple-bar/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | --------- | ------------------------------------------------------ | ------------------- | ----------- |
12
- | `breadcrumbItens` | -- | Define os itens que serão apresentados pelo breadcrumb | `IBreadcrumbItem[]` | `undefined` |
13
- | `label` | `label` | Define o título do header | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `breadcrumbItens` | -- | Define os itens que serão apresentados pelo breadcrumb | `IBreadcrumbItem[]` | `undefined` |
13
+ | `label` | `label` | Define o título do header | `string` | `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
@@ -21,6 +22,19 @@
21
22
  | `exit` | Emitido quando o botão voltar é acionado | `CustomEvent<void>` |
22
23
 
23
24
 
25
+ ## Dependencies
26
+
27
+ ### Used by
28
+
29
+ - [snk-attach](../snk-attach)
30
+
31
+ ### Graph
32
+ ```mermaid
33
+ graph TD;
34
+ snk-attach --> snk-simple-bar
35
+ style snk-simple-bar fill:#f9f,stroke:#333,stroke-width:4px
36
+ ```
37
+
24
38
  ----------------------------------------------
25
39
 
26
40
 
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,13 +7,16 @@
7
7
 
8
8
  ## Properties
9
9
 
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` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
12
+ | `dataState` | -- | | `DataState` | `undefined` |
13
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
14
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
15
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
18
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
19
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
17
20
 
18
21
 
19
22
  ## Events
@@ -69,6 +72,10 @@ Type: `Promise<void>`
69
72
 
70
73
  ## Dependencies
71
74
 
75
+ ### Used by
76
+
77
+ - [snk-attach](../snk-attach)
78
+
72
79
  ### Depends on
73
80
 
74
81
  - [snk-data-unit](../snk-data-unit)
@@ -83,6 +90,7 @@ graph TD;
83
90
  snk-simple-crud --> snk-data-exporter
84
91
  snk-taskbar --> snk-data-exporter
85
92
  snk-data-exporter --> snk-exporter-email-sender
93
+ snk-attach --> snk-simple-crud
86
94
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
87
95
  ```
88
96
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "5.4.2",
3
+ "version": "5.5.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [