@sankhyalabs/ezui-docs 6.2.0-dev.2 → 6.2.0-dev.4

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 (5) hide show
  1. package/components/ez-classic-input/readme.md +80 -0
  2. package/components/ez-classic-text-area/readme.md +78 -0
  3. package/components/ez-icon/readme.md +4 -0
  4. package/components/ez-tree/readme.md +8 -7
  5. package/package.json +1 -1
package/components/ez-classic-input/readme.md ADDED
@@ -0,0 +1,80 @@
1
+ # ez-classic-input
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------- |
12
+ | `emitMaskedValue` | `emit-masked-value` | Define se o valor emitido pelo evento ezChange deve conter a máscara aplicada (padrão: false) | `boolean` | `false` |
13
+ | `enabled` | `enabled` | Define se o input está habilitado | `boolean` | `true` |
14
+ | `helpText` | `help-text` | Texto de ajuda exibido abaixo do input | `string` | `undefined` |
15
+ | `label` | `label` | Texto do label exibido acima do input | `string` | `undefined` |
16
+ | `leftIconClickable` | `left-icon-clickable` | Define se o ícone da esquerda é clicável | `boolean` | `false` |
17
+ | `leftIconName` | `left-icon-name` | Nome do ícone à esquerda | `string` | `undefined` |
18
+ | `leftIconTooltip` | `left-icon-tooltip` | Título do ícone à esquerda (tooltip) | `string` | `undefined` |
19
+ | `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido. Para mais informações acesse: https://gilded-nasturtium-6b64dd.netlify.app/docs/utilities/api/classes/maskformatter/ | `string` | `undefined` |
20
+ | `maxlength` | `maxlength` | Tamanho máximo do valor | `number` | `undefined` |
21
+ | `minlength` | `minlength` | Tamanho mínimo do valor | `number` | `undefined` |
22
+ | `name` | `name` | Nome do input | `string` | `undefined` |
23
+ | `placeholder` | `placeholder` | Placeholder do input | `string` | `undefined` |
24
+ | `readonly` | `readonly` | Define se o input é somente leitura | `boolean` | `false` |
25
+ | `rightIconClickable` | `right-icon-clickable` | Define se o ícone da direita é clicável | `boolean` | `false` |
26
+ | `rightIconName` | `right-icon-name` | Nome do ícone à direita | `string` | `undefined` |
27
+ | `rightIconTooltip` | `right-icon-tooltip` | Título do ícone à direita (tooltip) | `string` | `undefined` |
28
+ | `state` | `state` | Estado visual do input: default, error, success ou warning | `"default" \| "error" \| "success" \| "warning"` | `"default"` |
29
+ | `type` | `type` | Tipo do input (ex: text, password, email, etc) | `string` | `'text'` |
30
+ | `value` | `value` | Valor do input | `string` | `undefined` |
31
+
32
+
33
+ ## Events
34
+
35
+ | Event | Description | Type |
36
+ | ----------- | -------------------------------------------------------------------------------- | ------------------------------------------- |
37
+ | `ezBlur` | Evento disparado quando o input perde o foco. | `CustomEvent<string>` |
38
+ | `ezChange` | Evento disparado quando o valor do input muda. | `CustomEvent<string>` |
39
+ | `iconClick` | Evento disparado quando um ícone é clicado. Payload: { icon: "left" \| "right" } | `CustomEvent<{ icon: "left" \| "right"; }>` |
40
+
41
+
42
+ ## Methods
43
+
44
+ ### `setBlur() => Promise<void>`
45
+
46
+ Remove o foco do campo.
47
+
48
+ #### Returns
49
+
50
+ Type: `Promise<void>`
51
+
52
+
53
+
54
+ ### `setFocus(option?: OptionsSetFocus) => Promise<void>`
55
+
56
+ Aplica o foco no campo.
57
+
58
+ #### Returns
59
+
60
+ Type: `Promise<void>`
61
+
62
+
63
+
64
+
65
+ ## Dependencies
66
+
67
+ ### Depends on
68
+
69
+ - [ez-icon](../ez-icon)
70
+
71
+ ### Graph
72
+ ```mermaid
73
+ graph TD;
74
+ ez-classic-input --> ez-icon
75
+ style ez-classic-input fill:#f9f,stroke:#333,stroke-width:4px
76
+ ```
77
+
78
+ ----------------------------------------------
79
+
80
+
package/components/ez-classic-text-area/readme.md ADDED
@@ -0,0 +1,78 @@
1
+ # ez-classic-text-area
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------- | ---------------------- | -------------------------------------------------------------- | ------------------------------------------------ | ---------------------------- |
12
+ | `enabled` | `enabled` | Define se a textarea está habilitada | `boolean` | `true` |
13
+ | `helpText` | `help-text` | Texto de ajuda exibido abaixo da textarea | `string` | `undefined` |
14
+ | `label` | `label` | Texto do rótulo exibido acima da área de texto | `string` | `''` |
15
+ | `leftIconClickable` | `left-icon-clickable` | Define se o ícone da esquerda é clicável | `boolean` | `false` |
16
+ | `leftIconName` | `left-icon-name` | Nome do ícone à esquerda | `string` | `undefined` |
17
+ | `leftIconTooltip` | `left-icon-tooltip` | Título do ícone à esquerda (tooltip) | `string` | `undefined` |
18
+ | `maxlength` | `maxlength` | Número máximo de caracteres permitidos | `number` | `undefined` |
19
+ | `name` | `name` | Nome da textarea | `string` | `StringUtils.generateUUID()` |
20
+ | `placeholder` | `placeholder` | Texto de placeholder exibido quando a área de texto está vazia | `string` | `''` |
21
+ | `readonly` | `readonly` | Se a área de texto é somente leitura | `boolean` | `false` |
22
+ | `resize` | `resize` | Comportamento de redimensionamento da área de texto | `"both" \| "horizontal" \| "none" \| "vertical"` | `'vertical'` |
23
+ | `rightIconClickable` | `right-icon-clickable` | Define se o ícone da direita é clicável | `boolean` | `false` |
24
+ | `rightIconName` | `right-icon-name` | Nome do ícone à direita | `string` | `undefined` |
25
+ | `rightIconTooltip` | `right-icon-tooltip` | Título do ícone à direita (tooltip) | `string` | `undefined` |
26
+ | `rows` | `rows` | Define o número de linhas da área de texto | `number` | `5` |
27
+ | `state` | `state` | Estado visual da textarea: default, error, success ou warning | `"default" \| "error" \| "success" \| "warning"` | `"default"` |
28
+ | `value` | `value` | Valor atual da área de texto | `string` | `''` |
29
+
30
+
31
+ ## Events
32
+
33
+ | Event | Description | Type |
34
+ | ----------- | -------------------------------------------------------------------------------- | ------------------------------------------- |
35
+ | `ezBlur` | Evento emitido quando a área de texto perde foco | `CustomEvent<string>` |
36
+ | `ezChange` | Evento emitido quando o valor da área de texto muda | `CustomEvent<string>` |
37
+ | `iconClick` | Evento disparado quando um ícone é clicado. Payload: { icon: "left" \| "right" } | `CustomEvent<{ icon: "left" \| "right"; }>` |
38
+
39
+
40
+ ## Methods
41
+
42
+ ### `setBlur() => Promise<void>`
43
+
44
+ Remove o foco do campo.
45
+
46
+ #### Returns
47
+
48
+ Type: `Promise<void>`
49
+
50
+
51
+
52
+ ### `setFocus(option?: OptionsSetFocus) => Promise<void>`
53
+
54
+ Aplica o foco no campo.
55
+
56
+ #### Returns
57
+
58
+ Type: `Promise<void>`
59
+
60
+
61
+
62
+
63
+ ## Dependencies
64
+
65
+ ### Depends on
66
+
67
+ - [ez-icon](../ez-icon)
68
+
69
+ ### Graph
70
+ ```mermaid
71
+ graph TD;
72
+ ez-classic-text-area --> ez-icon
73
+ style ez-classic-text-area fill:#f9f,stroke:#333,stroke-width:4px
74
+ ```
75
+
76
+ ----------------------------------------------
77
+
78
+
package/components/ez-icon/readme.md CHANGED
@@ -26,6 +26,8 @@
26
26
  - [ez-breadcrumb](../ez-breadcrumb)
27
27
  - [ez-button](../ez-button)
28
28
  - [ez-chip](../ez-chip)
29
+ - [ez-classic-input](../ez-classic-input)
30
+ - [ez-classic-text-area](../ez-classic-text-area)
29
31
  - [ez-collapsible-box](../ez-collapsible-box)
30
32
  - [ez-combo-box](../ez-combo-box)
31
33
  - [ez-dialog](../ez-dialog)
@@ -59,6 +61,8 @@ graph TD;
59
61
  ez-breadcrumb --> ez-icon
60
62
  ez-button --> ez-icon
61
63
  ez-chip --> ez-icon
64
+ ez-classic-input --> ez-icon
65
+ ez-classic-text-area --> ez-icon
62
66
  ez-collapsible-box --> ez-icon
63
67
  ez-combo-box --> ez-icon
64
68
  ez-dialog --> ez-icon
package/components/ez-tree/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------------- |
12
- | `iconResolver` | -- | Define uma função que vai resolver o ícone daquele item. Retorna o nome do ícone da lib de icones do DS. | `(item: ITreeItem, expanded: boolean, level: number) => string` | `defaultIconResolver` |
13
- | `items` | -- | Define os itens apresentados na árvore. | `ITreeItem[]` | `[]` |
14
- | `selectedId` | `selected-id` | Forma alternativa para atribuir o item selecionado por seu ID. | `string` | `undefined` |
15
- | `tooltipResolver` | -- | Define uma função que vai resolver o `tooltip` ou `title` daquele item. | `(item: ITreeItem, enabled: boolean, level: number) => string` | `undefined` |
16
- | `value` | -- | Define o item selecionado na árvore. | `ITreeItem` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------------- |
12
+ | `enableHierarchicalFilter` | `enable-hierarchical-filter` | Define se a árvore deve permitir a filtragem hierárquica. | `boolean` | `true` |
13
+ | `iconResolver` | -- | Define uma função que vai resolver o ícone daquele item. Retorna o nome do ícone da lib de icones do DS. | `(item: ITreeItem, expanded: boolean, level: number) => string` | `defaultIconResolver` |
14
+ | `items` | -- | Define os itens apresentados na árvore. | `ITreeItem[]` | `[]` |
15
+ | `selectedId` | `selected-id` | Forma alternativa para atribuir o item selecionado por seu ID. | `string` | `undefined` |
16
+ | `tooltipResolver` | -- | Define uma função que vai resolver o `tooltip` ou `title` daquele item. | `(item: ITreeItem, enabled: boolean, level: number) => string` | `undefined` |
17
+ | `value` | -- | Define o item selecionado na árvore. | `ITreeItem` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "6.2.0-dev.2",
3
+ "version": "6.2.0-dev.4",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [