Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@sankhyalabs/ezui-docs

Package Overview
Dependencies
Maintainers
0
Versions
1111
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@sankhyalabs/ezui-docs - npm Package Compare versions

Comparing version 0.0.0-feat-dev-KB-76495.1 to 0.0.0-feat-dev-KB-77529.0

components/ez-combo-box/ez-combo-box-list/readme.md
components/ez-double-list/readme.md
components/ez-popover-plus/readme.md
components/ez-popover-plus/subcomponent/readme.md
components/ez-tooltip/readme.md

15

components/ez-badge/readme.md

@@ -10,9 +10,10 @@ # ez-badge

| Property | Attribute | Description | Type | Default |
| ----------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------ |
| `iconLeft` | `icon-left` | Define o ícone a ser usado no lado esquerdo do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
| `iconRight` | `icon-right` | Define o ícone a ser usado no lado direito do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
| `label` | `label` | Define o conteúdo textual ou numérico do componente. | `string` | `undefined` |
| `position` | -- | Define a posição do ícone em relação ao elemento filho. | `IPosition` | `{ horizontal: "right", vertical: "top" }` |
| `size` | `size` | Define o tamanho de acordo com o tipo utilizado pelo componente. | `"extra-large" \| "extra-small" \| "large" \| "medium" \| "small" \| "small-medium"` | `"small"` |
| Property | Attribute | Description | Type | Default |
| ------------ | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------ |
| `alignItems` | `align-items` | Define a posição do ícone em relação ao elemento. | `"center" \| "flex-end" \| "flex-start"` | `"center"` |
| `iconLeft` | `icon-left` | Define o ícone a ser usado no lado esquerdo do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
| `iconRight` | `icon-right` | Define o ícone a ser usado no lado direito do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
| `label` | `label` | Define o conteúdo textual ou numérico do componente. | `string` | `undefined` |
| `position` | -- | Define a posição do ícone em relação ao elemento filho. | `IPosition` | `{ horizontal: "right", vertical: "top" }` |
| `size` | `size` | Define o tamanho de acordo com o tipo utilizado pelo componente. | `"extra-large" \| "extra-small" \| "large" \| "medium" \| "small" \| "small-medium"` | `"small"` |

@@ -19,0 +20,0 @@

2

components/ez-button/readme.md

@@ -50,2 +50,3 @@ # ez-button

- [ez-dialog](../ez-dialog)
- [ez-double-list](../ez-double-list)
- [ez-grid](../ez-grid)

@@ -70,2 +71,3 @@ - [ez-guide-navigator](../ez-guide-navigator)

ez-dialog --> ez-button
ez-double-list --> ez-button
ez-grid --> ez-button

@@ -72,0 +74,0 @@ ez-guide-navigator --> ez-button

2

components/ez-collapsible-box/readme.md

@@ -85,2 +85,4 @@ # ez-collapsible-box

ez-text-edit --> ez-button
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-button --> ez-icon

@@ -87,0 +89,0 @@ ez-form-view --> ez-collapsible-box

12

components/ez-combo-box/readme.md

@@ -12,2 +12,3 @@ # ez-combo-box

| ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |

@@ -26,3 +27,3 @@ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |

| `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
| `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
| `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `true` |
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |

@@ -82,3 +83,3 @@ | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |

### `setFocus() => Promise<void>`
### `setFocus(options?: TFocusOptions) => Promise<void>`

@@ -104,2 +105,4 @@ Aplica o foco no campo.

- [ez-icon](../ez-icon)
- [ez-popover-plus](../ez-popover-plus)
- [ez-combo-box-list](ez-combo-box-list)

@@ -111,2 +114,7 @@ ### Graph

ez-combo-box --> ez-icon
ez-combo-box --> ez-popover-plus
ez-combo-box --> ez-combo-box-list
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-popover-plus --> ez-popover-core
ez-form-view --> ez-combo-box

@@ -113,0 +121,0 @@ style ez-combo-box fill:#f9f,stroke:#333,stroke-width:4px

5

components/ez-date-input/readme.md

@@ -12,2 +12,3 @@ # ez-date-input

| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |

@@ -62,3 +63,3 @@ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |

### `setFocus() => Promise<void>`
### `setFocus(options?: TFocusOptions) => Promise<void>`

@@ -90,2 +91,4 @@ Aplica o foco no campo.

ez-date-input --> ez-calendar
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-form-view --> ez-date-input

@@ -92,0 +95,0 @@ style ez-date-input fill:#f9f,stroke:#333,stroke-width:4px

5

components/ez-date-time-input/readme.md

@@ -12,2 +12,3 @@ # ez-date-time-input

| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |

@@ -63,3 +64,3 @@ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |

### `setFocus() => Promise<void>`
### `setFocus(options?: TFocusOptions) => Promise<void>`

@@ -91,2 +92,4 @@ Aplica o foco no campo.

ez-date-time-input --> ez-calendar
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-form-view --> ez-date-time-input

@@ -93,0 +96,0 @@ style ez-date-time-input fill:#f9f,stroke:#333,stroke-width:4px

7

components/ez-filter-input/readme.md

@@ -13,2 +13,3 @@ # ez-filter-input

| `asyncSearch` | `async-search` | Define se o campo irá funcionar de forma assíncrona. | `boolean` | `false` |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |

@@ -64,3 +65,3 @@ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |

### `setFocus() => Promise<void>`
### `setFocus(options?: TFocusOptions) => Promise<void>`

@@ -90,2 +91,3 @@ Aplica o foco no campo.

- [ez-double-list](../ez-double-list)
- [ez-guide-navigator](../ez-guide-navigator)

@@ -104,2 +106,5 @@ - [ez-multi-selection-list](../ez-multi-selection-list)

ez-filter-input --> ez-icon
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-double-list --> ez-filter-input
ez-guide-navigator --> ez-filter-input

@@ -106,0 +111,0 @@ ez-multi-selection-list --> ez-filter-input

5

components/ez-form-view/readme.md

@@ -97,5 +97,10 @@ # ez-form-view

ez-text-edit --> ez-button
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-button --> ez-icon
ez-combo-box --> ez-text-input
ez-combo-box --> ez-icon
ez-combo-box --> ez-popover-plus
ez-combo-box --> ez-combo-box-list
ez-popover-plus --> ez-popover-core
ez-date-input --> ez-text-input

@@ -102,0 +107,0 @@ ez-date-input --> ez-calendar

5

components/ez-form/readme.md

@@ -91,5 +91,10 @@ # ez-form

ez-text-edit --> ez-button
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-button --> ez-icon
ez-combo-box --> ez-text-input
ez-combo-box --> ez-icon
ez-combo-box --> ez-popover-plus
ez-combo-box --> ez-combo-box-list
ez-popover-plus --> ez-popover-core
ez-date-input --> ez-text-input

@@ -96,0 +101,0 @@ ez-date-input --> ez-calendar

69

components/ez-grid/readme.md

@@ -10,18 +10,24 @@ # ez-grid

| Property | Attribute | Description | Type | Default |
| ------------------------ | -------------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
| `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
| `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
| `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
| `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
| `enableContinuousInsert` | `enable-continuous-insert` | Ativa/desativa a inserção continua na grade Só funciona quando a prop enableGridInsert está ativa | `boolean` | `true` |
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
| `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'show'` |
| `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
| `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
| `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
| Property | Attribute | Description | Type | Default |
| ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
| `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
| `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
| `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `false` |
| `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
| `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
| `enableContinuousInsert` | `enable-continuous-insert` | Ativa/desativa a inserção continua na grade Só funciona quando a prop enableGridInsert está ativa | `boolean` | `true` |
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa inserção de registros no modo grade pela Taskbar. | `boolean` | `true` |
| `enableRowTableStriped` | `enable-row-table-striped` | Ativa modo de linhas com cores alternadas. | `boolean` | `true` |
| `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
| `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'show'` |
| `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
| `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
| `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
| `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `false` |
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |

@@ -82,2 +88,12 @@

### `checkStopEditOutsideClick(event: MouseEvent) => Promise<void>`
#### Returns
Type: `Promise<void>`
### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`

@@ -213,3 +229,13 @@

### `stopEdit() => Promise<void>`
Para a edição da grade.
#### Returns
Type: `Promise<void>`
## Dependencies

@@ -219,5 +245,6 @@

- [ez-popover](../ez-popover)
- [ez-icon](../ez-icon)
- [ez-button](../ez-button)
- [filter-column](subcomponents)
- [ez-icon](../ez-icon)

@@ -227,9 +254,11 @@ ### Graph

graph TD;
ez-grid --> ez-popover
ez-grid --> ez-icon
ez-grid --> ez-button
ez-grid --> filter-column
ez-grid --> ez-icon
ez-button --> ez-icon
filter-column --> ez-popover
filter-column --> ez-popover-plus
filter-column --> ez-button
filter-column --> ez-multi-selection-list
ez-popover-plus --> ez-popover-core
ez-multi-selection-list --> ez-check

@@ -244,2 +273,4 @@ ez-multi-selection-list --> ez-list

ez-filter-input --> ez-icon
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-search --> ez-card-item

@@ -246,0 +277,0 @@ ez-search --> ez-text-input

7

components/ez-grid/subcomponents/readme.md

@@ -60,3 +60,3 @@ # filter-column

- [ez-popover](../../ez-popover)
- [ez-popover-plus](../../ez-popover-plus)
- [ez-button](../../ez-button)

@@ -68,5 +68,6 @@ - [ez-multi-selection-list](../../ez-multi-selection-list)

graph TD;
filter-column --> ez-popover
filter-column --> ez-popover-plus
filter-column --> ez-button
filter-column --> ez-multi-selection-list
ez-popover-plus --> ez-popover-core
ez-button --> ez-icon

@@ -82,2 +83,4 @@ ez-multi-selection-list --> ez-check

ez-filter-input --> ez-icon
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-search --> ez-card-item

@@ -84,0 +87,0 @@ ez-search --> ez-text-input

2

components/ez-guide-navigator/readme.md

@@ -129,2 +129,4 @@ # ez-guide-navigator

ez-filter-input --> ez-icon
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-button --> ez-icon

@@ -131,0 +133,0 @@ ez-tree --> ez-icon

2

components/ez-icon/readme.md

@@ -40,2 +40,3 @@ # ez-icon

- [ez-tabselector](../ez-tabselector)
- [ez-text-input](../ez-text-input)
- [ez-time-input](../ez-time-input)

@@ -66,2 +67,3 @@ - [ez-tree](../ez-tree)

ez-tabselector --> ez-icon
ez-text-input --> ez-icon
ez-time-input --> ez-icon

@@ -68,0 +70,0 @@ ez-tree --> ez-icon

38

components/ez-list/readme.md

@@ -10,12 +10,13 @@ # ez-list

| Property | Attribute | Description | Type | Default |
| --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
| `dataSource` | -- | Define a lista inicial do componente. | `(ListItem \| ListGroup)[]` | `[]` |
| `ezDraggable` | `ez-draggable` | Se true habilita `drag and drop` para os itens. | `boolean` | `false` |
| `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
| `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
| `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` |
| `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` |
| `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
| `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |
| Property | Attribute | Description | Type | Default |
| ------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
| `dataSource` | -- | Define a lista inicial do componente. | `(ListItem \| ListGroup)[]` | `[]` |
| `enableMultipleSelection` | `enable-multiple-selection` | Habilita seleção de múltiplos items. | `boolean` | `false` |
| `ezDraggable` | `ez-draggable` | Se true habilita `drag and drop` para os itens. | `boolean` | `false` |
| `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
| `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
| `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` |
| `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` |
| `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
| `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |

@@ -25,8 +26,9 @@

| Event | Description | Type |
| --------------- | ----------------------------------------------------------- | ---------------------------------------- |
| `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
| `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
| `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
| `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
| Event | Description | Type |
| ----------------------- | -------------------------------------------------------------- | ---------------------------------------- |
| `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
| `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
| `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
| `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
| `ezSelectMultipleItems` | Emitido sempre que um ou vários item da lista for selecionado. | `CustomEvent<ListItem[]>` |

@@ -86,3 +88,3 @@

### `setSelection(selectedItem: ListItem, scrollToOption?: boolean) => Promise<void>`
### `setSelection(selectedItem: ListItem, scrollToOption?: boolean, shitkey?: boolean, ctrlKey?: boolean) => Promise<void>`

@@ -103,2 +105,3 @@ Aplica seleção nas linhas da lista.

- [ez-alert-list](../ez-alert-list)
- [ez-double-list](../ez-double-list)
- [ez-multi-selection-list](../ez-multi-selection-list)

@@ -115,2 +118,3 @@

ez-alert-list --> ez-list
ez-double-list --> ez-list
ez-multi-selection-list --> ez-list

@@ -117,0 +121,0 @@ style ez-list fill:#f9f,stroke:#333,stroke-width:4px

20

components/ez-modal/readme.md

@@ -10,12 +10,12 @@ # ez-modal

| Property | Attribute | Description | Type | Default |
| ------------------- | --------------------- | ---------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
| `align` | `align` | Define o alinhamento do ez-modal. | `"left" \| "right"` | `undefined` |
| `closeEsc` | `close-esc` | Define se o ez-modal será fechado ao clicar `ESC`. | `boolean` | `false` |
| `closeOutsideClick` | `close-outside-click` | Define se o modal será fechado ao clicar fora do conteúdo. | `boolean` | `false` |
| `closeOutsideLeave` | `close-outside-leave` | Define se o modal será fechado se o mouse sair para fora do conteúdo. | `boolean` | `false` |
| `heightMode` | `height-mode` | Ativa o modo Full, permitindo que o Modal expanda-se verticalmente e ocupe todo o espaço disponível. | `"full" \| "regular"` | `"regular"` |
| `modalSize` | `modal-size` | Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`. | `string` | `undefined` |
| `opened` | `opened` | Define se o ez-modal está aberto. | `boolean` | `true` |
| `scrim` | `scrim` | Define o tipo de scrim a ser aplicado no overlay do modal | `"light" \| "medium"` | `"medium"` |
| Property | Attribute | Description | Type | Default |
| ------------------- | --------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------- | ----------- |
| `align` | `align` | Define o alinhamento do ez-modal. | `"left" \| "right"` | `undefined` |
| `closeEsc` | `close-esc` | Define se o ez-modal será fechado ao clicar `ESC`. | `boolean` | `false` |
| `closeOutsideClick` | `close-outside-click` | Define se o modal será fechado ao clicar fora do conteúdo. | `boolean` | `false` |
| `closeOutsideLeave` | `close-outside-leave` | Define se o modal será fechado se o mouse sair para fora do conteúdo. | `boolean` | `false` |
| `heightMode` | `height-mode` | Ativa o modo Full, permitindo que o Modal expanda-se verticalmente e ocupe todo o espaço disponível. | `"full" \| "regular"` | `"regular"` |
| `modalSize` | `modal-size` | Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`. | `string` | `undefined` |
| `opened` | `opened` | Define se o ez-modal está aberto. | `boolean` | `true` |
| `scrim` | `scrim` | Define o tipo de scrim a ser aplicado no overlay do modal | `"light" \| "medium" \| "none"` | `"medium"` |

@@ -22,0 +22,0 @@

2

components/ez-multi-selection-list/readme.md

@@ -66,2 +66,4 @@ # ez-multi-selection-list

ez-filter-input --> ez-icon
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-search --> ez-card-item

@@ -68,0 +70,0 @@ ez-search --> ez-text-input

3

components/ez-number-input/readme.md

@@ -13,2 +13,3 @@ # ez-number-input

| `allowNegative` | `allow-negative` | Se false, o input não aceitará números negativos. | `boolean` | `true` |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |

@@ -90,2 +91,4 @@ | `enabled` | `enabled` | Se false, o usuário não pode interagir com o campo. | `boolean` | `true` |

ez-number-input --> ez-text-input
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-form-view --> ez-number-input

@@ -92,0 +95,0 @@ style ez-number-input fill:#f9f,stroke:#333,stroke-width:4px

4

components/ez-popover/readme.md

@@ -73,3 +73,3 @@ # ez-popover

- [filter-column](../ez-grid/subcomponents)
- [ez-grid](../ez-grid)

@@ -79,3 +79,3 @@ ### Graph

graph TD;
filter-column --> ez-popover
ez-grid --> ez-popover
style ez-popover fill:#f9f,stroke:#333,stroke-width:4px

@@ -82,0 +82,0 @@ ```

16

components/ez-popup/readme.md

@@ -10,10 +10,10 @@ # ez-popup

| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | ------------------------------------------------------------- | ---------------------------------------------------------- | ----------- |
| `enabledScroll` | `enabled-scroll` | Possibilita scroll vertical no conteúdo interno do componente | `boolean` | `false` |
| `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
| `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
| `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
| `size` | `size` | Define a largura do ez-popup. | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"` |
| `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |
| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | ------------------------------------------------------------- | -------------------------------------------------------------------- | ----------- |
| `enabledScroll` | `enabled-scroll` | Possibilita scroll vertical no conteúdo interno do componente | `boolean` | `false` |
| `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
| `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
| `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
| `size` | `size` | Define a largura do ez-popup. | `"auto" \| "large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"` |
| `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |

@@ -20,0 +20,0 @@

2

components/ez-scroller/readme.md

@@ -21,2 +21,3 @@ # ez-scroller

- [ez-double-list](../ez-double-list)
- [ez-guide-navigator](../ez-guide-navigator)

@@ -28,2 +29,3 @@ - [ez-sidebar-navigator](../ez-sidebar-navigator)

graph TD;
ez-double-list --> ez-scroller
ez-guide-navigator --> ez-scroller

@@ -30,0 +32,0 @@ ez-sidebar-navigator --> ez-scroller

48

components/ez-search/readme.md

@@ -10,23 +10,25 @@ # ez-search

| Property | Attribute | Description | Type | Default |
| ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
| `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
| `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` |
| `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
| `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
| `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
| `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
| `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `false` |
| `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
| Property | Attribute | Description | Type | Default |
| ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------- |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
| `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` |
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
| `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
| `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` |
| `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
| `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
| `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
| `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
| `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `true` |
| `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |

@@ -83,3 +85,3 @@

### `setFocus() => Promise<void>`
### `setFocus(options?: TFocusOptions) => Promise<void>`

@@ -114,2 +116,4 @@ Aplica o foco no campo.

ez-search --> ez-icon
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-form-view --> ez-search

@@ -116,0 +120,0 @@ ez-multi-selection-list --> ez-search

16

components/ez-split-panel/readme.md

@@ -10,8 +10,16 @@ # ez-split-panel

| Property | Attribute | Description | Type | Default |
| ---------------- | ------------------ | ------------------------------------------------------------------------ | ------------------- | ---------- |
| `anchorToExpand` | `anchor-to-expand` | Responsável por definir o painel que limita o tamanho do item expandido. | `boolean` | `false` |
| `direction` | `direction` | | `"column" \| "row"` | `'column'` |
| Property | Attribute | Description | Type | Default |
| ---------------- | ------------------ | -------------------------------------------------------------------------------------- | ------------------- | ---------- |
| `anchorToExpand` | `anchor-to-expand` | Responsável por definir o painel que limita o tamanho do item expandido. | `boolean` | `false` |
| `direction` | `direction` | | `"column" \| "row"` | `'column'` |
| `structural` | `structural` | Define se o painel está sendo utilizado como estrutura para apresentação de outro item | `boolean` | `false` |
## Events
| Event | Description | Type |
| ----------- | ----------- | ----------------------------- |
| `resizeEnd` | | `CustomEvent<IPanelSizeInfo>` |
## Methods

@@ -18,0 +26,0 @@

11

components/ez-split-panel/structure/item/readme.md

@@ -10,7 +10,8 @@ # ez-split-item

| Property | Attribute | Description | Type | Default |
| -------------- | --------------- | ----------------------------------- | --------- | ----------- |
| `enableExpand` | `enable-expand` | Define se o item pode ser expandido | `boolean` | `true` |
| `label` | `label` | Define um título para o painel. | `string` | `undefined` |
| `size` | `size` | Define o tamanho inicial do painel. | `string` | `undefined` |
| Property | Attribute | Description | Type | Default |
| -------------- | --------------- | -------------------------------------------------------------------------------------- | --------- | ----------- |
| `enableExpand` | `enable-expand` | Define se o item pode ser expandido | `boolean` | `true` |
| `label` | `label` | Define um título para o painel. | `string` | `undefined` |
| `size` | `size` | Define o tamanho inicial do painel. | `string` | `undefined` |
| `structural` | `structural` | Define se o painel está sendo utilizado como estrutura para apresentação de outro item | `boolean` | `false` |

@@ -17,0 +18,0 @@

3

components/ez-text-area/readme.md

@@ -12,5 +12,6 @@ # ez-text-area

| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `autoRows` | `auto-rows` | Ativa a opção de fazer as linhas do componente serem baseados na altura máxima. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
| `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `false` |
| `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `true` |
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |

@@ -17,0 +18,0 @@ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |

2

components/ez-text-edit/readme.md

@@ -53,2 +53,4 @@ # ez-text-edit

ez-text-edit --> ez-button
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-button --> ez-icon

@@ -55,0 +57,0 @@ ez-collapsible-box --> ez-text-edit

33

components/ez-text-input/readme.md

@@ -10,14 +10,16 @@ # ez-text-input

| Property | Attribute | Description | Type | Default |
| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
| `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
| `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` |
| `password` | `password` | Se true o campo não terá bordas. | `boolean` | `false` |
| `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
| `value` | `value` | Define o valor do campo. | `string` | `undefined` |
| Property | Attribute | Description | Type | Default |
| ---------------- | ------------------ | --------------------------------------------------------------------------------- | --------------------- | ----------- |
| `autoFocus` | `auto-focus` | Se true o campo receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
| `cleanValueMask` | `clean-value-mask` | Para remover a máscara quando fizer um apply no formulário. | `boolean` | `false` |
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
| `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
| `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` |
| `password` | `password` | Se true o campo não terá bordas. | `boolean` | `false` |
| `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
| `value` | `value` | Define o valor do campo. | `string` | `undefined` |

@@ -79,5 +81,12 @@

### Depends on
- [ez-tooltip](../ez-tooltip)
- [ez-icon](../ez-icon)
### Graph
```mermaid
graph TD;
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-combo-box --> ez-text-input

@@ -84,0 +93,0 @@ ez-date-input --> ez-text-input

3

components/ez-time-input/readme.md

@@ -12,2 +12,3 @@ # ez-time-input

| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |

@@ -80,2 +81,4 @@ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |

ez-time-input --> ez-icon
ez-text-input --> ez-tooltip
ez-text-input --> ez-icon
ez-form-view --> ez-time-input

@@ -82,0 +85,0 @@ style ez-time-input fill:#f9f,stroke:#333,stroke-width:4px

9

components/ez-tree/readme.md

@@ -21,6 +21,7 @@ # ez-tree

| Event | Description | Type |
| ------------ | ----------------------------------------------- | ------------------------ |
| `ezChange` | Emitido quando um item é selecionado na árvore. | `CustomEvent<ITreeItem>` |
| `ezOpenItem` | Emitido quando um item é aberto na árvore. | `CustomEvent<ITreeItem>` |
| Event | Description | Type |
| --------------- | ------------------------------------------------- | ------------------------ |
| `ezChange` | Emitido quando um item é selecionado na árvore. | `CustomEvent<ITreeItem>` |
| `ezDbClickItem` | Emitido ao dar clique duplo em um item da árvore. | `CustomEvent<ITreeItem>` |
| `ezOpenItem` | Emitido quando um item é aberto na árvore. | `CustomEvent<ITreeItem>` |

@@ -27,0 +28,0 @@

2

package.json
{
"name": "@sankhyalabs/ezui-docs",
"version": "0.0.0-feat-dev-KB-76495.1",
"version": "0.0.0-feat-dev-KB-77529.0",
"description": "Documentação da biblioteca de componentes Sankhya.",

@@ -5,0 +5,0 @@ "main": "",

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc