@sankhyalabs/ezui-docs 0.0.0-bugfix-dev-KB-76362.0 → 0.0.0-bugfix-dev-KB-75609.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 (5) hide show
  1. package/components/ez-filter-input/readme.md +15 -27
  2. package/components/ez-list/readme.md +10 -32
  3. package/components/ez-popup/readme.md +8 -8
  4. package/components/ez-text-area/readme.md +1 -0
  5. package/package.json +1 -1
package/components/ez-filter-input/readme.md CHANGED
@@ -7,27 +7,25 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | -------------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `asyncSearch` | `async-search` | Define se o campo irá funcionar de forma assíncrona. | `boolean` | `false` |
13
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
15
- | `enabledIconClick` | `enabled-icon-click` | Se true permite ao usuário interagir com o ícone de pesquisa | `boolean` | `false` |
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 a ser apresentado como título do campo. | `string` | `undefined` |
18
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
19
- | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
20
- | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `asyncSearch` | `async-search` | Define se o campo irá funcionar de forma assíncrona. | `boolean` | `false` |
13
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
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` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
17
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
+ | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
19
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
21
20
 
22
21
 
23
22
  ## Events
24
23
 
25
- | Event | Description | Type |
26
- | ------------- | --------------------------------------------------------------------- | ---------------------- |
27
- | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
28
- | `ezFocusIn` | Emitido quando acontece o foco no campo. | `CustomEvent<void>` |
29
- | `ezIconClick` | Emitido quando tem interação com o Ícone de pesquisa | `CustomEvent<boolean>` |
30
- | `ezSearching` | Emitido quando está sendo realizada uma pesquisa no modo asyncSearch. | `CustomEvent<string>` |
24
+ | Event | Description | Type |
25
+ | ------------- | --------------------------------------------------------------------- | --------------------- |
26
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
27
+ | `ezFocusIn` | Emitido quando acontece o foco no campo. | `CustomEvent<void>` |
28
+ | `ezSearching` | Emitido quando está sendo realizada uma pesquisa no modo asyncSearch. | `CustomEvent<string>` |
31
29
 
32
30
 
33
31
  ## Methods
@@ -42,16 +40,6 @@ Type: `Promise<void>`
42
40
 
43
41
 
44
42
 
45
- ### `handleIconClick() => Promise<void>`
46
-
47
- Método usado para emitir o evento de clique no ícone
48
-
49
- #### Returns
50
-
51
- Type: `Promise<void>`
52
-
53
-
54
-
55
43
  ### `isInvalid() => Promise<boolean>`
56
44
 
57
45
  Retorna se o conteúdo é inválido.
package/components/ez-list/readme.md CHANGED
@@ -7,17 +7,16 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
12
- | `dataSource` | -- | Define a lista inicial do componente. | `(ListItem \| ListGroup)[]` | `[]` |
13
- | `disableShortcuts` | `disable-shortcuts` | Desabilita os atalhos de teclado. | `boolean` | `false` |
14
- | `ezDraggable` | `ez-draggable` | Se true habilita `drag and drop` para os itens. | `boolean` | `false` |
15
- | `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
16
- | `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
17
- | `itemLeftSlotBuilder` | -- | Função builder que possibilita gerar conteúdo dinâmico à esquerda do item da lista. * Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
18
- | `itemSlotBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
19
- | `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
20
- | `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
12
+ | `dataSource` | -- | Define a lista inicial do componente. | `(ListItem \| ListGroup)[]` | `[]` |
13
+ | `ezDraggable` | `ez-draggable` | Se true habilita `drag and drop` para os itens. | `boolean` | `false` |
14
+ | `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
15
+ | `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
16
+ | `itemLeftSlotBuilder` | -- | Função builder que possibilita gerar conteúdo dinâmico à esquerda do item da lista. * Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
17
+ | `itemSlotBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
18
+ | `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
19
+ | `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |
21
20
 
22
21
 
23
22
  ## Events
@@ -26,7 +25,6 @@
26
25
  | --------------- | ----------------------------------------------------------- | ---------------------------------------- |
27
26
  | `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
28
27
  | `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
29
- | `ezClickItem` | Emitido sempre que um item da lista for clicado. | `CustomEvent<ListItem>` |
30
28
  | `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
31
29
  | `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
32
30
 
@@ -83,26 +81,6 @@ Type: `Promise<void>`
83
81
 
84
82
 
85
83
 
86
- ### `selectNextItem() => Promise<void>`
87
-
88
- Seleciona o próximo item.
89
-
90
- #### Returns
91
-
92
- Type: `Promise<void>`
93
-
94
-
95
-
96
- ### `selectPreviousItem() => Promise<void>`
97
-
98
- Seleciona o item anterior.
99
-
100
- #### Returns
101
-
102
- Type: `Promise<void>`
103
-
104
-
105
-
106
84
  ### `setSelection(selectedItem: ListItem, scrollToOption?: boolean) => Promise<void>`
107
85
 
108
86
  Aplica seleção nas linhas da lista.
package/components/ez-popup/readme.md CHANGED
@@ -7,14 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------- | ---------------- | ------------------------------------------------------------- | ------------------ | ----------- |
12
- | `enabledScroll` | `enabled-scroll` | Possibilita scroll vertical no conteúdo interno do componente | `boolean` | `false` |
13
- | `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
14
- | `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
15
- | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
16
- | `size` | `size` | Define a largura do ez-popup. | `string` | `"medium"` |
17
- | `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ---------------- | ------------------------------------------------------------- | ---------------------------------------------------------- | ----------- |
12
+ | `enabledScroll` | `enabled-scroll` | Possibilita scroll vertical no conteúdo interno do componente | `boolean` | `false` |
13
+ | `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
14
+ | `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
15
+ | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
16
+ | `size` | `size` | Define a largura do ez-popup. | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"` |
17
+ | `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |
18
18
 
19
19
 
20
20
  ## Events
package/components/ez-text-area/readme.md CHANGED
@@ -9,6 +9,7 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `autoRows` | `auto-rows` | Ativa a opção de fazer as linhas do componente serem baseados na altura máxima. | `boolean` | `false` |
12
13
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
13
14
  | `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `false` |
14
15
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-bugfix-dev-KB-76362.0",
3
+ "version": "0.0.0-bugfix-dev-KB-75609.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [