@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-74246.1 → 0.0.0-bugfix-dev-KB-76362.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 (4) hide show
  1. package/components/snk-distinct-search/readme.md +110 -0
  2. package/components/snk-distinct-search/subcomponents/input-distinct-search/readme.md +100 -0
  3. package/components/snk-distinct-search/subcomponents/search-modal/readme.md +122 -0
  4. package/package.json +1 -1
package/components/snk-distinct-search/readme.md ADDED
@@ -0,0 +1,110 @@
1
+ # snk-distinct-search
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `false` |
13
+ | `configSearch` | -- | Dados para busca ao serviço. | `IConfigSearch` | `undefined` |
14
+ | `debounceTime` | `debounce-time` | Tempo em milissegundos para debouncing das chamadas de busca de sugestões. | `number` | `300` |
15
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
+ | `label` | `label` | Label apresentada no input. | `string` | `""` |
17
+ | `maxItems` | `max-items` | Número máximo de itens na lista. | `number` | `100` |
18
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `'regular'` |
19
+ | `restrict` | `restrict` | Expressão que define os caracteres permitidos na entrada. | `string` | `undefined` |
20
+ | `value` | `value` | Valor inicial do campo. | `string` | `""` |
21
+
22
+
23
+ ## Events
24
+
25
+ | Event | Description | Type |
26
+ | ------------- | -------------------------------------------------- | ----------------------------- |
27
+ | `changeValue` | Emitido quando há uma alteração no valor do campo. | `CustomEvent<IDistinctValue>` |
28
+
29
+
30
+ ## Methods
31
+
32
+ ### `clearInput() => Promise<void>`
33
+
34
+ Método para limpa o campo de entrada de pesquisa
35
+
36
+ #### Returns
37
+
38
+ Type: `Promise<void>`
39
+
40
+
41
+
42
+ ### `closeModal() => Promise<void>`
43
+
44
+ Método para fechar o modal
45
+
46
+ #### Returns
47
+
48
+ Type: `Promise<void>`
49
+
50
+
51
+
52
+ ### `isInvalid() => Promise<boolean>`
53
+
54
+ Retorna se o conteúdo é inválido.
55
+
56
+ #### Returns
57
+
58
+ Type: `Promise<boolean>`
59
+
60
+
61
+
62
+ ### `openModal() => Promise<void>`
63
+
64
+ Método para abrir o modal
65
+
66
+ #### Returns
67
+
68
+ Type: `Promise<void>`
69
+
70
+
71
+
72
+ ### `setBlur() => Promise<void>`
73
+
74
+ Remove o foco do campo
75
+
76
+ #### Returns
77
+
78
+ Type: `Promise<void>`
79
+
80
+
81
+
82
+ ### `setFocus() => Promise<void>`
83
+
84
+ Aplica o foco do campo
85
+
86
+ #### Returns
87
+
88
+ Type: `Promise<void>`
89
+
90
+
91
+
92
+
93
+ ## Dependencies
94
+
95
+ ### Depends on
96
+
97
+ - [input-distinct-search](./subcomponents/input-distinct-search)
98
+ - [search-modal](./subcomponents/search-modal)
99
+
100
+ ### Graph
101
+ ```mermaid
102
+ graph TD;
103
+ snk-distinct-search --> input-distinct-search
104
+ snk-distinct-search --> search-modal
105
+ style snk-distinct-search fill:#f9f,stroke:#333,stroke-width:4px
106
+ ```
107
+
108
+ ----------------------------------------------
109
+
110
+
package/components/snk-distinct-search/subcomponents/input-distinct-search/readme.md ADDED
@@ -0,0 +1,100 @@
1
+ # input-distinct-search
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `application` | -- | SnkApplication | `SnkApplication` | `undefined` |
13
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `false` |
14
+ | `debounceTime` | `debounce-time` | Tempo em milissegundos para debouncing das chamadas de busca de sugestões. | `number` | `300` |
15
+ | `distinctItems` | -- | Lista completa de items distintos. | `string[]` | `[]` |
16
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
+ | `label` | `label` | Label apresentada no input. | `string` | `""` |
18
+ | `maxItems` | `max-items` | Número máximo de itens na lista. | `number` | `100` |
19
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `'regular'` |
20
+ | `restrict` | `restrict` | Expressão que define os caracteres permitidos na entrada. | `string` | `undefined` |
21
+ | `value` | `value` | Valor inicial do campo. | `string` | `""` |
22
+
23
+
24
+ ## Events
25
+
26
+ | Event | Description | Type |
27
+ | ------------- | -------------------------------------------------- | ----------------------------- |
28
+ | `changeValue` | Emitido quando há uma alteração no valor do campo. | `CustomEvent<IDistinctValue>` |
29
+ | `iconClick` | Emitido quando o icone de pesquisa é clicado. | `CustomEvent<void>` |
30
+
31
+
32
+ ## Methods
33
+
34
+ ### `clearInput() => Promise<void>`
35
+
36
+ Método para limpa o campo de entrada de pesquisa
37
+
38
+ #### Returns
39
+
40
+ Type: `Promise<void>`
41
+
42
+
43
+
44
+ ### `isInvalid() => Promise<boolean>`
45
+
46
+ Retorna se o conteúdo é inválido.
47
+
48
+ #### Returns
49
+
50
+ Type: `Promise<boolean>`
51
+
52
+
53
+
54
+ ### `selectValue(value: string, isNewItem?: boolean) => Promise<void>`
55
+
56
+ Seleciona um item
57
+
58
+ #### Returns
59
+
60
+ Type: `Promise<void>`
61
+
62
+
63
+
64
+ ### `setBlur() => Promise<void>`
65
+
66
+ Remove o foco do campo
67
+
68
+ #### Returns
69
+
70
+ Type: `Promise<void>`
71
+
72
+
73
+
74
+ ### `setFocus() => Promise<void>`
75
+
76
+ Aplica o foco do campo
77
+
78
+ #### Returns
79
+
80
+ Type: `Promise<void>`
81
+
82
+
83
+
84
+
85
+ ## Dependencies
86
+
87
+ ### Used by
88
+
89
+ - [snk-distinct-search](../..)
90
+
91
+ ### Graph
92
+ ```mermaid
93
+ graph TD;
94
+ snk-distinct-search --> input-distinct-search
95
+ style input-distinct-search fill:#f9f,stroke:#333,stroke-width:4px
96
+ ```
97
+
98
+ ----------------------------------------------
99
+
100
+
package/components/snk-distinct-search/subcomponents/search-modal/readme.md ADDED
@@ -0,0 +1,122 @@
1
+ # search-modal
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | ---------------- | --------------------------------------------------------------------------------- | ----------------------- | ------------- |
12
+ | `application` | -- | SnkApplication | `SnkApplication` | `undefined` |
13
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `false` |
14
+ | `debounceTime` | `debounce-time` | Tempo em milissegundos para debouncing das chamadas de busca de sugestões. | `number` | `300` |
15
+ | `emptyMessage` | `empty-message` | Recebe a mensagem de vazio ou personalizada | `HTMLElement \| string` | `undefined` |
16
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
+ | `label` | `label` | Texto exibido como placeholder no campo de pesquisa. | `string` | `'Pesquisar'` |
18
+ | `listItens` | -- | Lista de itens exibidas conforme o usuário digita. | `string[]` | `[]` |
19
+ | `maxItens` | `max-itens` | Limita a quantidade de registros apresentados na tela | `number` | `100` |
20
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `'regular'` |
21
+ | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
22
+ | `restrict` | `restrict` | Expressão que define os caracteres permitidos na entrada. | `string` | `undefined` |
23
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
24
+
25
+
26
+ ## Events
27
+
28
+ | Event | Description | Type |
29
+ | ------------- | -------------------------------------------------- | ----------------------------- |
30
+ | `changeValue` | Emitido quando há uma alteração no valor do campo. | `CustomEvent<IDistinctValue>` |
31
+ | `popupClose` | Emitido ao fechar o popup | `CustomEvent<boolean>` |
32
+
33
+
34
+ ## Methods
35
+
36
+ ### `addNewItem() => Promise<void>`
37
+
38
+ Método para adicionar a nova palavra e chamar o método closeModal() para fechar o modal
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<void>`
43
+
44
+
45
+
46
+ ### `clearInput() => Promise<void>`
47
+
48
+ Método para limpa o campo de entrada de pesquisa
49
+
50
+ #### Returns
51
+
52
+ Type: `Promise<void>`
53
+
54
+
55
+
56
+ ### `closeModal() => Promise<void>`
57
+
58
+ Método para fechar o modal
59
+
60
+ #### Returns
61
+
62
+ Type: `Promise<void>`
63
+
64
+
65
+
66
+ ### `isInvalid() => Promise<void>`
67
+
68
+ Retorna se o conteúdo é inválido.
69
+
70
+ #### Returns
71
+
72
+ Type: `Promise<void>`
73
+
74
+
75
+
76
+ ### `openModal() => Promise<void>`
77
+
78
+ Método para abrir o modal
79
+
80
+ #### Returns
81
+
82
+ Type: `Promise<void>`
83
+
84
+
85
+
86
+ ### `setBlur() => Promise<void>`
87
+
88
+ Remove o foco do campo
89
+
90
+ #### Returns
91
+
92
+ Type: `Promise<void>`
93
+
94
+
95
+
96
+ ### `setFocus() => Promise<void>`
97
+
98
+ Aplica o foco do campo
99
+
100
+ #### Returns
101
+
102
+ Type: `Promise<void>`
103
+
104
+
105
+
106
+
107
+ ## Dependencies
108
+
109
+ ### Used by
110
+
111
+ - [snk-distinct-search](../..)
112
+
113
+ ### Graph
114
+ ```mermaid
115
+ graph TD;
116
+ snk-distinct-search --> search-modal
117
+ style search-modal fill:#f9f,stroke:#333,stroke-width:4px
118
+ ```
119
+
120
+ ----------------------------------------------
121
+
122
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-bugfix-dev-KB-74246.1",
3
+ "version": "0.0.0-bugfix-dev-KB-76362.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [