@sankhyalabs/ezui-docs 6.5.0-dev.7 → 6.5.0-dev.9

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 (3) hide show
  1. package/components/ez-chip/readme.md +8 -0
  2. package/components/ez-tag-input/readme.md +132 -0
  3. package/package.json +1 -1
package/components/ez-chip/readme.md CHANGED
@@ -17,8 +17,10 @@
17
17
  | `maxWidth` | `max-width` | Define o tamanho máximo do chip. | `string` | `undefined` |
18
18
  | `mode` | `mode` | Define o modo de uso do ez-chip. | `"action" \| "label"` | `undefined` |
19
19
  | `removePosition` | `remove-position` | Determina o posicionamento do botão de remover (não disponível no modo `action`). Se não informado, não exibe o botão. | `"left" \| "right"` | `undefined` |
20
+ | `removeWithKeyboard` | `remove-with-keyboard` | Define se o chip deve ser removido ao pressionar a tecla Enter quando focado. | `boolean` | `false` |
20
21
  | `showNativeTooltip` | `show-native-tooltip` | Exibe condicionalmente o tooltip nativo do navegador ao sobrepor o cursor acima do elemento. | `boolean` | `false` |
21
22
  | `size` | `size` | Define o tamanho do chip. | `"default" \| "large" \| "medium"` | `'default'` |
23
+ | `tabIndex` | `tab-index` | Define o tabindex do chip. Por padrão é 0, permitindo que o chip seja focável. | `number` | `0` |
22
24
  | `type` | `type` | Define o tipo de estilização do chip. | `"primary" \| "secondary"` | `'primary'` |
23
25
  | `value` | `value` | Define o valor do ez-chip. | `boolean` | `false` |
24
26
 
@@ -58,6 +60,10 @@ Type: `Promise<void>`
58
60
 
59
61
  ## Dependencies
60
62
 
63
+ ### Used by
64
+
65
+ - [ez-tag-input](../ez-tag-input)
66
+
61
67
  ### Depends on
62
68
 
63
69
  - [ez-tooltip](../ez-tooltip)
@@ -68,6 +74,7 @@ Type: `Promise<void>`
68
74
  graph TD;
69
75
  ez-chip --> ez-tooltip
70
76
  ez-chip --> ez-icon
77
+ ez-tag-input --> ez-chip
71
78
  style ez-chip fill:#f9f,stroke:#333,stroke-width:4px
72
79
  ```
73
80
 
@@ -98,4 +105,5 @@ graph TD;
98
105
  | --ez-label-chip\_\_label\_\_container--default--color--active | Define a cor do texto quando o cursor está sobre ele. |
99
106
  | --ez-label-chip\_\_label\_\_container--text--disabled | Define a cor do texto e do ícone quando o chip está desabilitado. |
100
107
  | --ez-label-chip\_\_label\_\_container--default--border-color--active | Define a cor da borda quando o componente está ativo. |
108
+ | --ez-label-chip\_\_label\_\_container--secondary--border-color--active | Define a cor da borda quando o componente está ativo e na variação secundária. |
101
109
  | --ez-label-chip\_\_label\_\_container--default--margin-top | Define a margem superior. |
package/components/ez-tag-input/readme.md ADDED
@@ -0,0 +1,132 @@
1
+ # ez-tag-input
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------ | ----------- |
12
+ | `allowDuplicates` | `allow-duplicates` | Define se tags duplicadas são permitidas | `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` | `''` |
16
+ | `maxTagLength` | `max-tag-length` | Tamanho máximo de uma tag | `number` | `undefined` |
17
+ | `maxTags` | `max-tags` | Número máximo de tags permitidas | `number` | `undefined` |
18
+ | `name` | `name` | Nome do input | `string` | `undefined` |
19
+ | `placeholder` | `placeholder` | Placeholder do input | `string` | `''` |
20
+ | `readonly` | `readonly` | Define se o input é somente leitura | `boolean` | `false` |
21
+ | `state` | `state` | Estado visual do componente | `"default" \| "error" \| "success" \| "warning"` | `"default"` |
22
+ | `suppressBackspaceToRemove` | `suppress-backspace-to-remove` | Define se a tecla Backspace deve remover a última tag quando o input está vazio | `boolean` | `false` |
23
+ | `suppressTagsKeyboardNavigation` | `suppress-tags-keyboard-navigation` | Define se a navegação por teclado pelas tags deve ser suprimida | `boolean` | `false` |
24
+ | `tags` | -- | Array de tags iniciais | `string[]` | `[]` |
25
+ | `validator` | -- | Função de validação customizada para tags | `(tag: string, existingTags: string[]) => string \| boolean` | `undefined` |
26
+
27
+
28
+ ## Events
29
+
30
+ | Event | Description | Type |
31
+ | ------------------- | --------------------------------------------- | ----------------------------------------------- |
32
+ | `ezBlur` | Evento disparado quando o input perde foco | `CustomEvent<void>` |
33
+ | `ezChange` | Evento disparado quando as tags mudam | `CustomEvent<string[]>` |
34
+ | `ezFocus` | Evento disparado quando o input recebe foco | `CustomEvent<void>` |
35
+ | `ezTagAdded` | Evento disparado quando uma tag é adicionada | `CustomEvent<string>` |
36
+ | `ezTagRemoved` | Evento disparado quando uma tag é removida | `CustomEvent<string>` |
37
+ | `ezType` | Emitido quando é digitado no campo de entrada | `CustomEvent<string>` |
38
+ | `ezValidationError` | Evento disparado quando uma validação falha | `CustomEvent<{ tag: string; error?: string; }>` |
39
+
40
+
41
+ ## Methods
42
+
43
+ ### `addTag(tag: string) => Promise<boolean>`
44
+
45
+ Adiciona uma tag programaticamente
46
+
47
+ #### Returns
48
+
49
+ Type: `Promise<boolean>`
50
+
51
+ ---
52
+
53
+ ### `clearTags() => Promise<void>`
54
+
55
+ Limpa todas as tags
56
+
57
+ #### Returns
58
+
59
+ Type: `Promise<void>`
60
+
61
+ ---
62
+
63
+ ### `removeTag(tag: string) => Promise<boolean>`
64
+
65
+ Remove uma tag programaticamente
66
+
67
+ #### Returns
68
+
69
+ Type: `Promise<boolean>`
70
+
71
+ ---
72
+
73
+ ### `setBlur() => Promise<void>`
74
+
75
+ Remove o foco do campo
76
+
77
+ #### Returns
78
+
79
+ Type: `Promise<void>`
80
+
81
+ ---
82
+
83
+ ### `setFocus(option?: OptionsSetFocus) => Promise<void>`
84
+
85
+ Aplica o foco no campo
86
+
87
+ #### Returns
88
+
89
+ Type: `Promise<void>`
90
+
91
+
92
+
93
+
94
+ ## Dependencies
95
+
96
+ ### Depends on
97
+
98
+ - [ez-chip](../ez-chip)
99
+
100
+ ### Graph
101
+ ```mermaid
102
+ graph TD;
103
+ ez-tag-input --> ez-chip
104
+ ez-chip --> ez-tooltip
105
+ ez-chip --> ez-icon
106
+ style ez-tag-input fill:#f9f,stroke:#333,stroke-width:4px
107
+ ```
108
+
109
+ ----------------------------------------------
110
+
111
+
112
+
113
+
114
+ ## CSS Variables
115
+ | Variable | Description |
116
+ |-|-|
117
+ | --ez-tag-input--background-color | Define a cor de fundo do container do input. |
118
+ | --ez-tag-input--border-color-default | Define a cor da borda no estado padrão. |
119
+ | --ez-tag-input--border-color-focused | Define a cor da borda no estado focado. |
120
+ | --ez-tag-input--border-color-error | Define a cor da borda no estado de erro. |
121
+ | --ez-tag-input--border-color-success | Define a cor da borda no estado de sucesso. |
122
+ | --ez-tag-input--border-color-warning | Define a cor da borda no estado de aviso. |
123
+ | --ez-tag-input--border-radius | Define o raio da borda do container. |
124
+ | --ez-tag-input--padding | Define o espaçamento interno do container. |
125
+ | --ez-tag-input--gap | Define o espaçamento entre tags e input. |
126
+ | --ez-tag-input--label-color | Define a cor do texto do label. |
127
+ | --ez-tag-input--label-font-weight | Define o peso da fonte do label. |
128
+ | --ez-tag-input--input-color | Define a cor do texto do input. |
129
+ | --ez-tag-input--input-font-size | Define o tamanho da fonte do input. |
130
+ | --ez-tag-input--placeholder-color | Define a cor do placeholder. |
131
+ | --ez-tag-input--background-color-disabled | Define a cor de fundo do input quando está desabilitado. |
132
+ | --ez-tag-input--helptext-color | Define a cor do texto de ajuda do input. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "6.5.0-dev.7",
3
+ "version": "6.5.0-dev.9",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [