@sankhyalabs/core-docs 6.1.1 → 6.2.0-ms.1

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 (19) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/ColumnFilterManager.md +6 -6
  3. package/classes/DataUnit.md +158 -158
  4. package/classes/DataUnitLoaderUtils.md +6 -6
  5. package/classes/LangUtils.md +195 -0
  6. package/classes/SelectionInfo.md +16 -16
  7. package/enumerations/ChangeOperation.md +4 -4
  8. package/enumerations/SelectionMode.md +2 -2
  9. package/functions/defaultDataLoader.md +1 -1
  10. package/globals.md +1 -0
  11. package/interfaces/DUActionInterceptor.md +1 -1
  12. package/interfaces/PageRequest.md +3 -3
  13. package/interfaces/PaginationInfoBuilderParams.md +3 -3
  14. package/interfaces/QuickFilter.md +3 -3
  15. package/interfaces/Record.md +4 -4
  16. package/interfaces/SavedRecord.md +5 -5
  17. package/interfaces/WaitingChange.md +3 -3
  18. package/package.json +1 -1
  19. package/type-aliases/DataUnitEventOptions.md +1 -1
package/classes/DataUnitLoaderUtils.md CHANGED
@@ -36,7 +36,7 @@
36
36
 
37
37
  #### Source
38
38
 
39
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:11
39
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:12
40
40
 
41
41
  ***
42
42
 
@@ -58,7 +58,7 @@ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:11
58
58
 
59
59
  #### Source
60
60
 
61
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:40
61
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:41
62
62
 
63
63
  ***
64
64
 
@@ -88,7 +88,7 @@ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:40
88
88
 
89
89
  #### Source
90
90
 
91
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:20
91
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:21
92
92
 
93
93
  ***
94
94
 
@@ -106,7 +106,7 @@ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:20
106
106
 
107
107
  #### Source
108
108
 
109
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:61
109
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:62
110
110
 
111
111
  ***
112
112
 
@@ -128,7 +128,7 @@ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:61
128
128
 
129
129
  #### Source
130
130
 
131
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:51
131
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:52
132
132
 
133
133
  ***
134
134
 
@@ -148,4 +148,4 @@ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:51
148
148
 
149
149
  #### Source
150
150
 
151
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:57
151
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:58
package/classes/LangUtils.md ADDED
@@ -0,0 +1,195 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / LangUtils
6
+
7
+ # Class: LangUtils
8
+
9
+ A classe `LangUtils` fornece métodos utilitários para gerenciar configurações de
10
+ idioma, incluindo recuperar, definir e aplicar preferências de idioma.
11
+
12
+ ## Constructors
13
+
14
+ ### new LangUtils()
15
+
16
+ > **new LangUtils**(): [`LangUtils`](LangUtils.md)
17
+
18
+ #### Returns
19
+
20
+ [`LangUtils`](LangUtils.md)
21
+
22
+ ## Properties
23
+
24
+ ### ELanguages
25
+
26
+ > `static` **ELanguages**: *typeof* `__class`
27
+
28
+ Classe estática contendo os códigos de idioma predefinidos.
29
+
30
+ #### Source
31
+
32
+ src/utils/LangUtils.ts:14
33
+
34
+ ## Methods
35
+
36
+ ### applyLanguageFromCookie()
37
+
38
+ > `static` **applyLanguageFromCookie**(): `void`
39
+
40
+ Define o atributo `lang` no elemento `<html>` com base no cookie de idioma, se existir.
41
+
42
+ #### Returns
43
+
44
+ `void`
45
+
46
+ #### Example
47
+
48
+ ```ts
49
+ LangUtils.applyLanguageFromCookie(); // Aplica o idioma do cookie ao elemento `<html>`
50
+ ```
51
+
52
+ #### Source
53
+
54
+ src/utils/LangUtils.ts:123
55
+
56
+ ***
57
+
58
+ ### convertLanguage()
59
+
60
+ > `static` `private` **convertLanguage**(`lang`): `string`
61
+
62
+ Converte o idioma fornecido para um dos códigos predefinidos.
63
+
64
+ #### Parameters
65
+
66
+ • **lang**: `string`
67
+
68
+ O idioma a ser convertido (ex.: "en", "es", "pt-BR").
69
+
70
+ #### Returns
71
+
72
+ `string`
73
+
74
+ O código de idioma correspondente (ex.: "en_US", "es_ES").
75
+
76
+ #### Example
77
+
78
+ ```ts
79
+ LangUtils.convertLanguage("en"); // Retorna "en_US"
80
+ LangUtils.convertLanguage("es-es"); // Retorna "es_ES"
81
+ ```
82
+
83
+ #### Source
84
+
85
+ src/utils/LangUtils.ts:30
86
+
87
+ ***
88
+
89
+ ### getHtmlLanguage()
90
+
91
+ > `static` **getHtmlLanguage**(): `string`
92
+
93
+ Recupera o valor do atributo `lang` do elemento `<html>`. Se o ambiente
94
+ estiver em modo de desenvolvimento, o idioma padrão será `"pt_BR"`. Caso
95
+ contrário, utiliza o idioma do navegador ou `"pt-BR"` como padrão.
96
+
97
+ #### Returns
98
+
99
+ `string`
100
+
101
+ O idioma definido no elemento `<html>` ou o padrão.
102
+
103
+ #### Example
104
+
105
+ ```ts
106
+ LangUtils.getHtmlLanguage(); // Retorna "pt_BR" no modo desenvolvimento
107
+ ```
108
+
109
+ #### Source
110
+
111
+ src/utils/LangUtils.ts:77
112
+
113
+ ***
114
+
115
+ ### getLanguage()
116
+
117
+ > `static` **getLanguage**(): `string`
118
+
119
+ Captura o idioma atualmente definido. Primeiro verifica se há um idioma
120
+ armazenado nos cookies. Caso contrário, utiliza o idioma definido no elemento
121
+ `<html>`. Se nenhum valor for encontrado nos cookies ou no elemento `<html>`,
122
+ é utilizada a configuração do navegador. Caso o navegador também não forneça
123
+ um idioma, o padrão será `"pt_BR"`.
124
+
125
+ #### Returns
126
+
127
+ `string`
128
+
129
+ O idioma definido (ex.: "pt_BR", "en_US").
130
+
131
+ #### Example
132
+
133
+ ```ts
134
+ LangUtils.getLanguage(); // Retorna o idioma atual
135
+ ```
136
+
137
+ #### Source
138
+
139
+ src/utils/LangUtils.ts:57
140
+
141
+ ***
142
+
143
+ ### getLanguageFromCookie()
144
+
145
+ > `static` **getLanguageFromCookie**(): `null` \| `string`
146
+
147
+ Recupera o valor do cookie de idioma.
148
+
149
+ #### Returns
150
+
151
+ `null` \| `string`
152
+
153
+ O valor do cookie de idioma ou `null` se não existir.
154
+
155
+ #### Example
156
+
157
+ ```ts
158
+ LangUtils.getLanguageFromCookie(); // Retorna "pt_BR" se o cookie existir
159
+ ```
160
+
161
+ #### Source
162
+
163
+ src/utils/LangUtils.ts:112
164
+
165
+ ***
166
+
167
+ ### setHtmlLanguage()
168
+
169
+ > `static` **setHtmlLanguage**(`language`): `void`
170
+
171
+ Define o atributo `lang` no elemento `<html>` e atualiza o cookie de idioma.
172
+
173
+ #### Parameters
174
+
175
+ • **language**: `string`
176
+
177
+ O idioma a ser definido (ex.: "pt_BR", "en_US").
178
+
179
+ > **Nota:** Definir o idioma no elemento `<html>` é essencial para garantir que o conteúdo
180
+ da página seja interpretado corretamente por navegadores, leitores de tela e mecanismos de
181
+ busca, melhorando a acessibilidade e a indexação.
182
+
183
+ #### Returns
184
+
185
+ `void`
186
+
187
+ #### Example
188
+
189
+ ```ts
190
+ LangUtils.setHtmlLanguage("en_US"); // Define o idioma como "en_US"
191
+ ```
192
+
193
+ #### Source
194
+
195
+ src/utils/LangUtils.ts:99
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:2147
33
+ src/dataunit/SelectionInfo.ts:13
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2147
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2144
43
+ src/dataunit/SelectionInfo.ts:10
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2144
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2145
53
+ src/dataunit/SelectionInfo.ts:11
54
54
 
55
55
  ***
56
56
 
@@ -60,21 +60,21 @@ src/dataunit/DataUnit.ts:2145
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2141
63
+ src/dataunit/SelectionInfo.ts:7
64
64
 
65
65
  ***
66
66
 
67
67
  ### getAllRecords()?
68
68
 
69
- > `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
69
+ > `optional` **getAllRecords**: () => [`Record`](../interfaces/Record.md)[]
70
70
 
71
71
  #### Returns
72
72
 
73
- `undefined` \| [`Record`](../interfaces/Record.md)[]
73
+ [`Record`](../interfaces/Record.md)[]
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2143
77
+ src/dataunit/SelectionInfo.ts:9
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2143
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2140
87
+ src/dataunit/SelectionInfo.ts:6
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2140
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2142
97
+ src/dataunit/SelectionInfo.ts:8
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2142
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2175
111
+ src/dataunit/SelectionInfo.ts:41
112
112
 
113
113
  ***
114
114
 
@@ -122,21 +122,21 @@ src/dataunit/DataUnit.ts:2175
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2165
125
+ src/dataunit/SelectionInfo.ts:31
126
126
 
127
127
  ***
128
128
 
129
129
  ### records
130
130
 
131
- > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
131
+ > `get` **records**(): [`Record`](../interfaces/Record.md)[]
132
132
 
133
133
  #### Returns
134
134
 
135
- `undefined` \| [`Record`](../interfaces/Record.md)[]
135
+ [`Record`](../interfaces/Record.md)[]
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2155
139
+ src/dataunit/SelectionInfo.ts:21
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2155
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2182
153
+ src/dataunit/SelectionInfo.ts:48
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2182
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2186
167
+ src/dataunit/SelectionInfo.ts:52
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2026
17
+ src/dataunit/interfaces/dataUnit.ts:31
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2026
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2028
27
+ src/dataunit/interfaces/dataUnit.ts:33
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:2028
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2025
37
+ src/dataunit/interfaces/dataUnit.ts:30
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:2025
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:2027
47
+ src/dataunit/interfaces/dataUnit.ts:32
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2134
17
+ src/dataunit/interfaces/dataUnit.ts:63
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2134
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2135
27
+ src/dataunit/interfaces/dataUnit.ts:64
package/functions/defaultDataLoader.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  ## Source
24
24
 
25
- src/dataunit/DataUnitHelper.ts:26
25
+ src/dataunit/DataUnitHelper.ts:27
package/globals.md CHANGED
@@ -46,6 +46,7 @@
46
46
  - [IDBRepository](classes/IDBRepository.md)
47
47
  - [JSUtils](classes/JSUtils.md)
48
48
  - [KeyboardManager](classes/KeyboardManager.md)
49
+ - [LangUtils](classes/LangUtils.md)
49
50
  - [LockManager](classes/LockManager.md)
50
51
  - [MaskFormatter](classes/MaskFormatter.md)
51
52
  - [NumberUtils](classes/NumberUtils.md)
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:2009
25
+ src/dataunit/interfaces/dataUnit.ts:14
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2114
17
+ src/dataunit/interfaces/dataUnit.ts:43
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2114
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2115
27
+ src/dataunit/interfaces/dataUnit.ts:44
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2115
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2116
37
+ src/dataunit/interfaces/dataUnit.ts:45
package/interfaces/PaginationInfoBuilderParams.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
17
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:85
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:83
27
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:83
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/loader/utils/dataUnitLoaderUtils.ts:85
37
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:86
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2121
17
+ src/dataunit/interfaces/dataUnit.ts:50
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2121
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2122
27
+ src/dataunit/interfaces/dataUnit.ts:51
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2122
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2120
37
+ src/dataunit/interfaces/dataUnit.ts:49
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:2016
25
+ src/dataunit/interfaces/dataUnit.ts:21
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:2016
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:2015
35
+ src/dataunit/interfaces/dataUnit.ts:20
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:2015
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:2013
45
+ src/dataunit/interfaces/dataUnit.ts:18
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:2013
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:2014
55
+ src/dataunit/interfaces/dataUnit.ts:19
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:2021
21
+ src/dataunit/interfaces/dataUnit.ts:26
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:2021
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:2016
35
+ src/dataunit/interfaces/dataUnit.ts:21
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:2016
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:2015
49
+ src/dataunit/interfaces/dataUnit.ts:20
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2015
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2013
63
+ src/dataunit/interfaces/dataUnit.ts:18
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:2013
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2014
77
+ src/dataunit/interfaces/dataUnit.ts:19
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2109
17
+ src/dataunit/interfaces/dataUnit.ts:38
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2109
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2110
27
+ src/dataunit/interfaces/dataUnit.ts:39
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2110
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2108
37
+ src/dataunit/interfaces/dataUnit.ts:37
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "6.1.1",
3
+ "version": "6.2.0-ms.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/DataUnitEventOptions.md CHANGED
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Source
16
16
 
17
- src/dataunit/DataUnit.ts:2191
17
+ src/dataunit/interfaces/dataUnit.ts:67