@sankhyalabs/sankhyablocks-docs 4.3.1 → 4.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 (6) hide show
  1. package/components/snk-data-exporter/readme.md +2 -0
  2. package/components/snk-data-unit/readme.md +2 -0
  3. package/components/snk-filter-field-search/readme.md +47 -0
  4. package/components/snk-simple-crud/readme.md +82 -0
  5. package/components/snk-taskbar/readme.md +2 -0
  6. package/package.json +1 -1
package/components/snk-data-exporter/readme.md CHANGED
@@ -19,6 +19,7 @@
19
19
  - [snk-crud](../snk-crud)
20
20
  - [snk-detail-view](../snk-crud/subcomponents)
21
21
  - [snk-guides-viewer](../snk-crud/subcomponents)
22
+ - [snk-simple-crud](../snk-simple-crud)
22
23
  - [snk-taskbar](../snk-taskbar)
23
24
 
24
25
  ### Depends on
@@ -32,6 +33,7 @@ graph TD;
32
33
  snk-crud --> snk-data-exporter
33
34
  snk-detail-view --> snk-data-exporter
34
35
  snk-guides-viewer --> snk-data-exporter
36
+ snk-simple-crud --> snk-data-exporter
35
37
  snk-taskbar --> snk-data-exporter
36
38
  style snk-data-exporter fill:#f9f,stroke:#333,stroke-width:4px
37
39
  ```
package/components/snk-data-unit/readme.md CHANGED
@@ -57,12 +57,14 @@ Retorna a lista de IDs dos registros selecionados.
57
57
 
58
58
  - [snk-detail-view](../snk-crud/subcomponents)
59
59
  - [snk-guides-viewer](../snk-crud/subcomponents)
60
+ - [snk-simple-crud](../snk-simple-crud)
60
61
 
61
62
  ### Graph
62
63
  ```mermaid
63
64
  graph TD;
64
65
  snk-detail-view --> snk-data-unit
65
66
  snk-guides-viewer --> snk-data-unit
67
+ snk-simple-crud --> snk-data-unit
66
68
  style snk-data-unit fill:#f9f,stroke:#333,stroke-width:4px
67
69
  ```
68
70
 
package/components/snk-filter-field-search/readme.md ADDED
@@ -0,0 +1,47 @@
1
+ # snk-filter-field-search
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------ | -------------------------------------------------------- | --------- | ------- |
12
+ | `searchable` | `searchable` | Define se o componente irá possuir um campo de pesquisa. | `boolean` | `true` |
13
+
14
+
15
+ ## Events
16
+
17
+ | Event | Description | Type |
18
+ | -------------------- | --------------------------------------------------- | ------------------------------------------ |
19
+ | `ezSelectFilterItem` | Emitido sempre que um item da lista for selecionado | `CustomEvent<IFilterField \| IFilterLink>` |
20
+
21
+
22
+ ## Methods
23
+
24
+ ### `filterDataSource(filterText: string) => Promise<void>`
25
+
26
+ Filtra a fonte de dados do componente.
27
+
28
+ #### Returns
29
+
30
+ Type: `Promise<void>`
31
+
32
+
33
+
34
+ ### `setDataSource(currentLink: IFilterLink, fetchData: DataFetcher) => Promise<void>`
35
+
36
+ Define a fonte de dados do componente.
37
+
38
+ #### Returns
39
+
40
+ Type: `Promise<void>`
41
+
42
+
43
+
44
+
45
+ ----------------------------------------------
46
+
47
+
package/components/snk-simple-crud/readme.md ADDED
@@ -0,0 +1,82 @@
1
+ # snk-simple-crud
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | --------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
12
+ | `dataState` | -- | | `DataState` | `undefined` |
13
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
14
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
15
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
16
+
17
+
18
+ ## Methods
19
+
20
+ ### `getRecords() => Promise<Array<Record>>`
21
+
22
+
23
+
24
+ #### Returns
25
+
26
+ Type: `Promise<Record[]>`
27
+
28
+
29
+
30
+ ### `goToView(view: VIEW_MODE) => Promise<void>`
31
+
32
+ Usado para alternar a visão entre GRID e FORM externamente.
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<void>`
37
+
38
+
39
+
40
+ ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
41
+
42
+
43
+
44
+ #### Returns
45
+
46
+ Type: `Promise<void>`
47
+
48
+
49
+
50
+ ### `setRecords(records: Array<Record>) => Promise<void>`
51
+
52
+
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<void>`
57
+
58
+
59
+
60
+
61
+ ## Dependencies
62
+
63
+ ### Depends on
64
+
65
+ - [snk-data-unit](../snk-data-unit)
66
+ - [snk-taskbar](../snk-taskbar)
67
+ - [snk-data-exporter](../snk-data-exporter)
68
+
69
+ ### Graph
70
+ ```mermaid
71
+ graph TD;
72
+ snk-simple-crud --> snk-data-unit
73
+ snk-simple-crud --> snk-taskbar
74
+ snk-simple-crud --> snk-data-exporter
75
+ snk-taskbar --> snk-data-exporter
76
+ snk-data-exporter --> snk-exporter-email-sender
77
+ style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
78
+ ```
79
+
80
+ ----------------------------------------------
81
+
82
+
package/components/snk-taskbar/readme.md CHANGED
@@ -33,6 +33,7 @@
33
33
  - [snk-detail-view](../snk-crud/subcomponents)
34
34
  - [snk-grid](../snk-grid)
35
35
  - [snk-guides-viewer](../snk-crud/subcomponents)
36
+ - [snk-simple-crud](../snk-simple-crud)
36
37
 
37
38
  ### Depends on
38
39
 
@@ -46,6 +47,7 @@ graph TD;
46
47
  snk-detail-view --> snk-taskbar
47
48
  snk-grid --> snk-taskbar
48
49
  snk-guides-viewer --> snk-taskbar
50
+ snk-simple-crud --> snk-taskbar
49
51
  style snk-taskbar fill:#f9f,stroke:#333,stroke-width:4px
50
52
  ```
51
53
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "4.3.1",
3
+ "version": "4.5.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [