@sankhyalabs/ezui-docs 6.1.0-dev.20 → 6.1.0-dev.22

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-combo-box/ez-combo-box-list/readme.md +11 -11
  2. package/components/ez-combo-box/readme.md +23 -23
  3. package/components/ez-sortable-list/readme.md +16 -16
  4. package/components/ez-split-button/readme.md +13 -13
  5. package/package.json +1 -1
package/components/ez-combo-box/ez-combo-box-list/readme.md CHANGED
@@ -7,17 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------------- | -------------------------------------------------------------------- | --------------------------- | ------------------------------- |
12
- | `maxWidth` | `max-width` | Largura máxima da lista, em pixels. | `number` | `undefined` |
13
- | `onOptionHover` | -- | Callback chamado quando o mouse passa sobre uma opção. | `(index: number) => void` | `undefined` |
14
- | `onOptionSelect` | -- | Callback chamado quando uma opção é selecionada. | `(option: IOption) => void` | `undefined` |
15
- | `preSelection` | `pre-selection` | Índice da opção pré-selecionada na lista. | `number` | `undefined` |
16
- | `showLoading` | `show-loading` | Indica se o indicador de carregamento deve ser exibido. | `boolean` | `undefined` |
17
- | `showOptionValue` | `show-option-value` | Indica se o valor de cada opção deve ser exibido junto com o rótulo. | `boolean` | `undefined` |
18
- | `textEmptyList` | `text-empty-list` | Mensagem exibida quando a lista de opções está vazia. | `string` | `"Nenhum resultado encontrado"` |
19
- | `visibleOptions` | -- | Lista de opções visíveis que serão exibidas no componente. | `IOption[]` | `undefined` |
20
- | `width` | `width` | Largura fixa da lista, em pixels. | `number` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------- | --------------------------- | ----------- |
12
+ | `maxWidth` | `max-width` | Largura máxima da lista, em pixels. | `number` | `undefined` |
13
+ | `onOptionHover` | -- | Callback chamado quando o mouse passa sobre uma opção. | `(index: number) => void` | `undefined` |
14
+ | `onOptionSelect` | -- | Callback chamado quando uma opção é selecionada. | `(option: IOption) => void` | `undefined` |
15
+ | `preSelection` | `pre-selection` | Índice da opção pré-selecionada na lista. | `number` | `undefined` |
16
+ | `showLoading` | `show-loading` | Indica se o indicador de carregamento deve ser exibido. | `boolean` | `undefined` |
17
+ | `showOptionValue` | `show-option-value` | Indica se o valor de cada opção deve ser exibido junto com o rótulo. | `boolean` | `undefined` |
18
+ | `textEmptyList` | `text-empty-list` | Mensagem exibida quando a lista de opções está vazia. | `string` | `undefined` |
19
+ | `visibleOptions` | -- | Lista de opções visíveis que serão exibidas no componente. | `IOption[]` | `undefined` |
20
+ | `width` | `width` | Largura fixa da lista, em pixels. | `number` | `undefined` |
21
21
 
22
22
 
23
23
  ## Methods
package/components/ez-combo-box/readme.md CHANGED
@@ -7,29 +7,29 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------- |
12
- | `alternativePlaceholder` | `alternative-placeholder` | Texto alternativo a ser apresentado como título do campo. | `string` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
14
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
15
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
16
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
- | `hideErrorOnFocusOut` | `hide-error-on-focus-out` | Quando verdadeiro deixa de exibir a mensagem de erro (se existente) quando focar em um elemento diferente. | `boolean` | `true` |
18
- | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
19
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
20
- | `limitCharsToSearch` | `limit-chars-to-search` | Define o limite de caracteres mínimo para realizar uma pesquisa | `number` | `3` |
21
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
22
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
23
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
24
- | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
25
- | `preventAutoFocus` | `prevent-auto-focus` | Se true, impede que o campo de texto receba foco automaticamente ao abrir as opções. | `boolean` | `false` |
26
- | `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
27
- | `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
28
- | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `true` |
29
- | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
30
- | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
31
- | `textEmptyOption` | `text-empty-option` | Texto a ser apresentado na opção de valor nulo. | `string` | `"Selecione um item"` |
32
- | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
12
+ | `alternativePlaceholder` | `alternative-placeholder` | Texto alternativo a ser apresentado como título do campo. | `string` | `undefined` |
13
+ | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
14
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
15
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
16
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
+ | `hideErrorOnFocusOut` | `hide-error-on-focus-out` | Quando verdadeiro deixa de exibir a mensagem de erro (se existente) quando focar em um elemento diferente. | `boolean` | `true` |
18
+ | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
19
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
20
+ | `limitCharsToSearch` | `limit-chars-to-search` | Define o limite de caracteres mínimo para realizar uma pesquisa | `number` | `3` |
21
+ | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
22
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
23
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
24
+ | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
25
+ | `preventAutoFocus` | `prevent-auto-focus` | Se true, impede que o campo de texto receba foco automaticamente ao abrir as opções. | `boolean` | `false` |
26
+ | `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
27
+ | `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
28
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `true` |
29
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
30
+ | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
31
+ | `textEmptyOption` | `text-empty-option` | Texto a ser apresentado na opção de valor nulo. | `string` | `undefined` |
32
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
33
33
 
34
34
 
35
35
  ## Events
package/components/ez-sortable-list/readme.md CHANGED
@@ -7,22 +7,22 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ------------------------ |
12
- | `dataSource` | -- | Lista de itens para serem renderizados | `ListItem[]` | `[]` |
13
- | `emptyMessage` | `empty-message` | Mensagem exibida quando a lista está vazia | `string` | `'Nenhum item na lista'` |
14
- | `enableMultipleSelection` | `enable-multiple-selection` | Habilita seleção de múltiplos itens utilizando as teclas 'Ctrl/Command' ou 'Shift' | `boolean` | `false` |
15
- | `entityLabel` | `entity-label` | Nome da entidade listada. Exemplo: "Campo", "Item", "Empresa". | `string` | `'item'` |
16
- | `entityLabelPlural` | `entity-label-plural` | Variação plural do nome da entidade listada. Exemplo: "Campos", "Itens", "Empresas". | `string` | `'itens'` |
17
- | `group` | `group` | Grupo ao qual o ez-sortable-list pertence | `string` | `'default'` |
18
- | `hideHeader` | `hide-header` | Define se o cabeçalho deve ficar oculto. | `boolean` | `false` |
19
- | `hideTotalizer` | `hide-totalizer` | Define se o totalizador deve ser escondido. | `boolean` | `false` |
20
- | `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar hover nos itens da lista | `boolean` | `true` |
21
- | `idSortableList` | `id-sortable-list` | ID do sortable list | `string` | `'DEFAULT_LIST'` |
22
- | `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` |
23
- | `itemRightSlotBuilder` | -- | 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` |
24
- | `removeItensMoved` | `remove-itens-moved` | Remove itens arrastados de uma lista para outra | `boolean` | `false` |
25
- | `title` | `title` | Define o título da lista. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------------- |
12
+ | `dataSource` | -- | Lista de itens para serem renderizados | `ListItem[]` | `[]` |
13
+ | `emptyMessage` | `empty-message` | Mensagem exibida quando a lista está vazia | `string` | `undefined` |
14
+ | `enableMultipleSelection` | `enable-multiple-selection` | Habilita seleção de múltiplos itens utilizando as teclas 'Ctrl/Command' ou 'Shift' | `boolean` | `false` |
15
+ | `entityLabel` | `entity-label` | Nome da entidade listada. Exemplo: "Campo", "Item", "Empresa". | `string` | `undefined` |
16
+ | `entityLabelPlural` | `entity-label-plural` | Variação plural do nome da entidade listada. Exemplo: "Campos", "Itens", "Empresas". | `string` | `undefined` |
17
+ | `group` | `group` | Grupo ao qual o ez-sortable-list pertence | `string` | `'default'` |
18
+ | `hideHeader` | `hide-header` | Define se o cabeçalho deve ficar oculto. | `boolean` | `false` |
19
+ | `hideTotalizer` | `hide-totalizer` | Define se o totalizador deve ser escondido. | `boolean` | `false` |
20
+ | `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar hover nos itens da lista | `boolean` | `true` |
21
+ | `idSortableList` | `id-sortable-list` | ID do sortable list | `string` | `'DEFAULT_LIST'` |
22
+ | `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` |
23
+ | `itemRightSlotBuilder` | -- | 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` |
24
+ | `removeItensMoved` | `remove-itens-moved` | Remove itens arrastados de uma lista para outra | `boolean` | `false` |
25
+ | `title` | `title` | Define o título da lista. | `string` | `undefined` |
26
26
 
27
27
 
28
28
  ## Events
package/components/ez-split-button/readme.md CHANGED
@@ -7,19 +7,19 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------- |
12
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o botão. | `boolean` | `true` |
13
- | `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://gilded-nasturtium-6b64dd.netlify.app/docs/components/layout-doc/icons/) | `string` | `undefined` |
14
- | `image` | `image` | Define o caminho usado nos modos `icon-only` e `icon-left` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
- | `itemBuilder` | -- | 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: IDropdownItem, level: number) => string \| HTMLElement` | `undefined` |
16
- | `items` | -- | Define o conteúdo do dropdown. | `IDropdownItem[]` | `undefined` |
17
- | `label` | `label` | Texto a ser apresentado como label do botão. | `string` | `undefined` |
18
- | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
19
- | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
20
- | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `'Mais opções'` |
21
- | `show` | `show` | | `boolean` | `false` |
22
- | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium" \| "small"` | `'medium'` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o botão. | `boolean` | `true` |
13
+ | `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://gilded-nasturtium-6b64dd.netlify.app/docs/components/layout-doc/icons/) | `string` | `undefined` |
14
+ | `image` | `image` | Define o caminho usado nos modos `icon-only` e `icon-left` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
+ | `itemBuilder` | -- | 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: IDropdownItem, level: number) => string \| HTMLElement` | `undefined` |
16
+ | `items` | -- | Define o conteúdo do dropdown. | `IDropdownItem[]` | `undefined` |
17
+ | `label` | `label` | Texto a ser apresentado como label do botão. | `string` | `undefined` |
18
+ | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
19
+ | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
20
+ | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `undefined` |
21
+ | `show` | `show` | | `boolean` | `false` |
22
+ | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium" \| "small"` | `'medium'` |
23
23
 
24
24
 
25
25
  ## Events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "6.1.0-dev.20",
3
+ "version": "6.1.0-dev.22",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [