@sankhyalabs/sankhyablocks-docs 8.16.0-rc.32 → 8.16.0-rc.34

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-application/readme.md +3 -1
  2. package/components/snk-pesquisa/pesquisa-grid/readme.md +41 -0
  3. package/components/snk-pesquisa/pesquisa-tree/readme.md +52 -0
  4. package/components/snk-pesquisa/readme.md +16 -5
  5. package/components/teste-pesquisa/readme.md +2 -0
  6. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -138,7 +138,7 @@ Type: `Promise<IOption | IOption[]>`
138
138
 
139
139
 
140
140
 
141
- ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>`
141
+ ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
142
142
 
143
143
  Obtém as opções em componentes de pesquisa
144
144
  Ex.: snk-config-options
@@ -559,6 +559,8 @@ SnkApplication carregado.
559
559
  ```mermaid
560
560
  graph TD;
561
561
  snk-application --> snk-pesquisa
562
+ snk-pesquisa --> pesquisa-tree
563
+ snk-pesquisa --> pesquisa-grid
562
564
  teste-pesquisa --> snk-application
563
565
  style snk-application fill:#f9f,stroke:#333,stroke-width:4px
564
566
  ```
package/components/snk-pesquisa/pesquisa-grid/readme.md ADDED
@@ -0,0 +1,41 @@
1
+ # pesquisa-grid
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ------------------- | ------------------------------------------------- | -------------- | ----------- |
12
+ | `dataSource` | -- | Registros da grade | `Record[]` | `[]` |
13
+ | `descriptionField` | `description-field` | Campo que representa a descrição do registro | `string` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade representada na grade | `string` | `undefined` |
15
+ | `metadata` | -- | Campos que representam as colunas da grade. | `UnitMetadata` | `undefined` |
16
+ | `pkField` | `pk-field` | Campo que representa a chave primária do registro | `string` | `undefined` |
17
+
18
+
19
+ ## Events
20
+
21
+ | Event | Description | Type |
22
+ | ------------------------ | ----------- | ---------------------- |
23
+ | `pesquisaGridSelectItem` | | `CustomEvent<IOption>` |
24
+
25
+
26
+ ## Dependencies
27
+
28
+ ### Used by
29
+
30
+ - [snk-pesquisa](..)
31
+
32
+ ### Graph
33
+ ```mermaid
34
+ graph TD;
35
+ snk-pesquisa --> pesquisa-grid
36
+ style pesquisa-grid fill:#f9f,stroke:#333,stroke-width:4px
37
+ ```
38
+
39
+ ----------------------------------------------
40
+
41
+
package/components/snk-pesquisa/pesquisa-tree/readme.md ADDED
@@ -0,0 +1,52 @@
1
+ # pesquisa-tree
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ------------------------------------------------------------------ | ---------------------------------------- | ----------- |
12
+ | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
13
+ | `argument` | `argument` | Argumentos que serão usados ao chamar a função treeLoader. | `string` | `undefined` |
14
+ | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<ITreeItem[]>` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ------------------------ | ----------- | ---------------------- |
21
+ | `pesquisaTreeSelectItem` | | `CustomEvent<IOption>` |
22
+
23
+
24
+ ## Methods
25
+
26
+ ### `applyFilter() => Promise<void>`
27
+
28
+
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+
35
+
36
+
37
+ ## Dependencies
38
+
39
+ ### Used by
40
+
41
+ - [snk-pesquisa](..)
42
+
43
+ ### Graph
44
+ ```mermaid
45
+ graph TD;
46
+ snk-pesquisa --> pesquisa-tree
47
+ style pesquisa-tree fill:#f9f,stroke:#333,stroke-width:4px
48
+ ```
49
+
50
+ ----------------------------------------------
51
+
52
+
package/components/snk-pesquisa/readme.md CHANGED
@@ -7,11 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | ---------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
12
- | `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
13
- | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
14
- | `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
13
+ | `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade onde a pesquisa é aplicada. | `string` | `undefined` |
15
+ | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa possuirá ou não modo Hierarquico. | `boolean` | `false` |
16
+ | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
17
+ | `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
18
+ | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<any>` | `undefined` |
15
19
 
16
20
 
17
21
  ## Dependencies
@@ -20,9 +24,16 @@
20
24
 
21
25
  - [snk-application](../snk-application)
22
26
 
27
+ ### Depends on
28
+
29
+ - [pesquisa-tree](pesquisa-tree)
30
+ - [pesquisa-grid](pesquisa-grid)
31
+
23
32
  ### Graph
24
33
  ```mermaid
25
34
  graph TD;
35
+ snk-pesquisa --> pesquisa-tree
36
+ snk-pesquisa --> pesquisa-grid
26
37
  snk-application --> snk-pesquisa
27
38
  style snk-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
28
39
  ```
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-tree
20
+ snk-pesquisa --> pesquisa-grid
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-rc.32",
3
+ "version": "8.16.0-rc.34",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [