@sankhyalabs/ezui-docs 6.4.4 → 6.5.0-dev.10

package/components/ez-form/readme.md

@@ -38,7 +38,7 @@ Registra um editor customizado para campos da grade e formulário.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
 
@@ -48,7 +48,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `validate() => Promise<void>`
 
@@ -91,6 +91,7 @@ graph TD;
   ez-form-view --> ez-text-input
   ez-form-view --> ez-search-plus
   ez-form-view --> ez-search
+  ez-form-view --> ez-rich-text
   ez-collapsible-box --> ez-icon
   ez-collapsible-box --> ez-text-edit
   ez-text-edit --> ez-text-input
@@ -112,6 +113,8 @@ graph TD;
   ez-date-time-input --> ez-popover-plus
   ez-date-time-input --> ez-calendar
   ez-number-input --> ez-text-input
+  ez-text-area --> ez-tooltip
+  ez-text-area --> ez-icon
   ez-search-plus --> ez-icon
   ez-search-plus --> ez-text-input
   ez-search-plus --> ez-popover-plus
@@ -123,6 +126,29 @@ graph TD;
   ez-search --> ez-popover-plus
   ez-search --> search-list
   search-list --> ez-card-item
+  ez-rich-text --> ez-text-area
+  ez-rich-text --> ez-rich-toolbar
+  ez-rich-text --> ez-link-builder
+  ez-rich-text --> ez-simple-image-uploader
+  ez-rich-toolbar --> ez-rich-toolbar-arrows
+  ez-rich-toolbar --> ez-rich-toolbar-letters
+  ez-rich-toolbar --> ez-rich-toolbar-configs
+  ez-rich-toolbar-arrows --> ez-rich-toolbar-item
+  ez-rich-toolbar-item --> ez-icon
+  ez-rich-toolbar-letters --> ez-rich-toolbar-item
+  ez-rich-toolbar-configs --> ez-rich-toolbar-item
+  ez-link-builder --> ez-popup
+  ez-link-builder --> ez-modal-container
+  ez-link-builder --> ez-text-input
+  ez-link-builder --> ez-check
+  ez-popup --> ez-button
+  ez-modal-container --> ez-icon
+  ez-modal-container --> ez-button
+  ez-simple-image-uploader --> ez-popup
+  ez-simple-image-uploader --> ez-modal-container
+  ez-simple-image-uploader --> ez-tooltip
+  ez-simple-image-uploader --> ez-text-input
+  ez-simple-image-uploader --> ez-icon
   style ez-form fill:#f9f,stroke:#333,stroke-width:4px
 ```
 

package/components/ez-form-view/custom-input/readme.md

@@ -27,7 +27,7 @@ Retorna se o conteúdo é inválido.
 
 Type: `Promise<boolean>`
 
-
+---
 
 ### `setBlur() => Promise<void>`
 
@@ -37,7 +37,7 @@ Remove o foco do campo.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setFocus() => Promise<void>`
 

package/components/ez-form-view/readme.md

@@ -32,7 +32,7 @@ Registra um editor customizado para campos da grade e formulário.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
 
@@ -42,7 +42,7 @@ Altera/adiciona uma propriedade nos metados do campo.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `showUp() => Promise<void>`
 
@@ -76,6 +76,7 @@ Type: `Promise<void>`
 - [ez-text-input](../ez-text-input)
 - [ez-search-plus](../ez-search-plus)
 - [ez-search](../ez-search)
+- [ez-rich-text](../ez-rich-text)
 
 ### Graph
 ```mermaid
@@ -93,6 +94,7 @@ graph TD;
   ez-form-view --> ez-text-input
   ez-form-view --> ez-search-plus
   ez-form-view --> ez-search
+  ez-form-view --> ez-rich-text
   ez-collapsible-box --> ez-icon
   ez-collapsible-box --> ez-text-edit
   ez-text-edit --> ez-text-input
@@ -114,6 +116,8 @@ graph TD;
   ez-date-time-input --> ez-popover-plus
   ez-date-time-input --> ez-calendar
   ez-number-input --> ez-text-input
+  ez-text-area --> ez-tooltip
+  ez-text-area --> ez-icon
   ez-search-plus --> ez-icon
   ez-search-plus --> ez-text-input
   ez-search-plus --> ez-popover-plus
@@ -125,6 +129,29 @@ graph TD;
   ez-search --> ez-popover-plus
   ez-search --> search-list
   search-list --> ez-card-item
+  ez-rich-text --> ez-text-area
+  ez-rich-text --> ez-rich-toolbar
+  ez-rich-text --> ez-link-builder
+  ez-rich-text --> ez-simple-image-uploader
+  ez-rich-toolbar --> ez-rich-toolbar-arrows
+  ez-rich-toolbar --> ez-rich-toolbar-letters
+  ez-rich-toolbar --> ez-rich-toolbar-configs
+  ez-rich-toolbar-arrows --> ez-rich-toolbar-item
+  ez-rich-toolbar-item --> ez-icon
+  ez-rich-toolbar-letters --> ez-rich-toolbar-item
+  ez-rich-toolbar-configs --> ez-rich-toolbar-item
+  ez-link-builder --> ez-popup
+  ez-link-builder --> ez-modal-container
+  ez-link-builder --> ez-text-input
+  ez-link-builder --> ez-check
+  ez-popup --> ez-button
+  ez-modal-container --> ez-icon
+  ez-modal-container --> ez-button
+  ez-simple-image-uploader --> ez-popup
+  ez-simple-image-uploader --> ez-modal-container
+  ez-simple-image-uploader --> ez-tooltip
+  ez-simple-image-uploader --> ez-text-input
+  ez-simple-image-uploader --> ez-icon
   ez-form --> ez-form-view
   style ez-form-view fill:#f9f,stroke:#333,stroke-width:4px
 ```

package/components/ez-grid/readme.md

@@ -57,7 +57,7 @@ Adiciona item de menu nas colunas.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
 
@@ -67,7 +67,7 @@ Registra um editor customizado para campos da grade e formulário.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
 
@@ -77,7 +77,7 @@ Registra um formatador de valores para uma coluna da grid.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
 
@@ -87,7 +87,7 @@ Registra um render customizado para colunas da grid.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `checkStopEditOutsideClick(event: MouseEvent) => Promise<void>`
 
@@ -97,7 +97,7 @@ Type: `Promise<void>`
 
 Type: `Promise<void>`
 
-
+---
 
 ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
 
@@ -107,7 +107,7 @@ Usa um argumento para filtrar as colunas po label
 
 Type: `Promise<EzGridColumn[]>`
 
-
+---
 
 ### `getAppliedColumnFilters() => Promise<Array<Filter>>`
 
@@ -117,7 +117,7 @@ Retorna os filtros aplicados.
 
 Type: `Promise<Filter[]>`
 
-
+---
 
 ### `getColumns() => Promise<Array<EzGridColumn>>`
 
@@ -127,7 +127,7 @@ Obtém a lista de definição de colunas.
 
 Type: `Promise<EzGridColumn[]>`
 
-
+---
 
 ### `getColumnsState() => Promise<Array<EzGridColumn>>`
 
@@ -137,7 +137,7 @@ Obtém o estado atual das colunas.
 
 Type: `Promise<EzGridColumn[]>`
 
-
+---
 
 ### `getCustomValueFormatter(columnName: string) => Promise<ICustomFormatter | undefined>`
 
@@ -147,7 +147,7 @@ Retorna o formatador customizado da coluna caso exista.
 
 Type: `Promise<ICustomFormatter>`
 
-
+---
 
 ### `getSelection() => Promise<Array<any>>`
 
@@ -157,7 +157,7 @@ Obtém as linhas selecionadas.
 
 Type: `Promise<any[]>`
 
-
+---
 
 ### `locateColumn(columnName: string) => Promise<void>`
 
@@ -167,7 +167,7 @@ Localiza determinada coluna tornando-a visível.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `quickFilter(term: string) => Promise<void>`
 
@@ -177,7 +177,7 @@ Aplica um filtro rápido.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `refreshColumnFilterDataSource() => Promise<void>`
 
@@ -187,7 +187,7 @@ Type: `Promise<void>`
 
 Type: `Promise<void>`
 
-
+---
 
 ### `refreshSelectedRows() => Promise<void>`
 
@@ -197,7 +197,7 @@ Atualiza linhas da grade.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
 
@@ -207,7 +207,7 @@ Remove o formatador de valores de uma coluna da grid.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
 
@@ -217,7 +217,7 @@ Aplica a definição de colunas.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setColumnsState(state: Array<EzGridColumnConfig>) => Promise<void>`
 
@@ -227,7 +227,7 @@ Aplica o estado das colunas.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setData(data: Array<any>) => Promise<void>`
 
@@ -237,7 +237,7 @@ Insere os registros no ez-grid.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setFocus() => Promise<void>`
 
@@ -247,7 +247,7 @@ Atribui o foco para a grade.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `stopEdit() => Promise<void>`
 

package/components/ez-grid/subcomponents/readme.md

@@ -36,7 +36,7 @@
 
 Type: `Promise<void>`
 
-
+---
 
 ### `show(configs: IFilterColumnConfigs) => Promise<void>`
 

package/components/ez-guide-navigator/readme.md

@@ -32,7 +32,7 @@ Desabilita um ou mais itens.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `enableItem(id: string | Array<string>) => Promise<void>`
 
@@ -42,7 +42,7 @@ Habilita um ou mais itens.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `getCurrentPath() => Promise<Array<IGuideItem>>`
 
@@ -54,6 +54,8 @@ Type: `Promise<IGuideItem[]>`
 
 Retorna um array do caminho de itens da seleção atual.
 
+---
+
 ### `getItem(id: string) => Promise<IGuideItem>`
 
 Obtem um item pelo id
@@ -62,7 +64,7 @@ Obtem um item pelo id
 
 Type: `Promise<IGuideItem>`
 
-
+---
 
 ### `getParent(id: string) => Promise<IGuideItem>`
 
@@ -72,7 +74,7 @@ Obtem o item pai a partir de um id
 
 Type: `Promise<IGuideItem>`
 
-
+---
 
 ### `openGuideNavidator() => Promise<void>`
 
@@ -82,7 +84,7 @@ Abre o navegador de Guia
 
 Type: `Promise<void>`
 
-
+---
 
 ### `selectGuide(id: string) => Promise<void>`
 
@@ -92,7 +94,7 @@ Seleciona o item desejado pelo ID.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `updateItem(item: IGuideItem | Array<IGuideItem>) => Promise<void>`
 

package/components/ez-icon/readme.md

@@ -35,13 +35,17 @@
  - [ez-file-item](../ez-file-item)
  - [ez-filter-input](../ez-filter-input)
  - [ez-grid](../ez-grid)
+ - [ez-list-item](../ez-list-item)
  - [ez-modal-container](../ez-modal-container)
  - [ez-multi-selection-list](../ez-multi-selection-list)
+ - [ez-rich-toolbar-item](../ez-rich-text/ez-rich-toolbar/ez-rich-toolbar-item)
  - [ez-search](../ez-search)
  - [ez-search-plus](../ez-search-plus)
  - [ez-sidebar-button](../ez-sidebar-button)
+ - [ez-simple-image-uploader](../ez-rich-text/ez-simple-image-uploader)
  - [ez-split-button](../ez-split-button)
  - [ez-tabselector](../ez-tabselector)
+ - [ez-text-area](../ez-text-area)
  - [ez-text-input](../ez-text-input)
  - [ez-tile](../ez-tile)
  - [ez-tile-medium](../ez-tile-medium)
@@ -67,13 +71,17 @@ graph TD;
   ez-file-item --> ez-icon
   ez-filter-input --> ez-icon
   ez-grid --> ez-icon
+  ez-list-item --> ez-icon
   ez-modal-container --> ez-icon
   ez-multi-selection-list --> ez-icon
+  ez-rich-toolbar-item --> ez-icon
   ez-search --> ez-icon
   ez-search-plus --> ez-icon
   ez-sidebar-button --> ez-icon
+  ez-simple-image-uploader --> ez-icon
   ez-split-button --> ez-icon
   ez-tabselector --> ez-icon
+  ez-text-area --> ez-icon
   ez-text-input --> ez-icon
   ez-tile --> ez-icon
   ez-tile-medium --> ez-icon

package/components/ez-list/readme.md

@@ -41,7 +41,7 @@ Limpa o histórico da lista.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `getList() => Promise<Array<ListItem | ListGroup>>`
 
@@ -51,7 +51,7 @@ Obtém a lista de items ou grupos.
 
 Type: `Promise<(ListItem | ListGroup)[]>`
 
-
+---
 
 ### `getSelection() => Promise<ListItem>`
 
@@ -61,7 +61,7 @@ Obtém o item selecionado.
 
 Type: `Promise<ListItem>`
 
-
+---
 
 ### `removeSelection() => Promise<void>`
 
@@ -71,7 +71,7 @@ Limpa a seleção atual
 
 Type: `Promise<void>`
 
-
+---
 
 ### `scrollToTop() => Promise<void>`
 
@@ -81,7 +81,7 @@ Traz o conteúdo da lista para a área visível.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setSelection(selectedItem: ListItem, scrollToOption?: boolean, shitkey?: boolean, ctrlKey?: boolean) => Promise<void>`
 

package/components/ez-list-item/readme.md

@@ -0,0 +1,43 @@
+# ez-list-item
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute    | Description                                 | Type     | Default     |
+| ----------- | ------------ | ------------------------------------------- | -------- | ----------- |
+| `iconName`  | `icon-name`  | Nome do ícone que deve ser exibido no item. | `string` | `undefined` |
+| `text`      | `text`       | Texto do item da lista.                     | `string` | `undefined` |
+| `titleText` | `title-text` | Título do item da lista.                    | `string` | `undefined` |
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-list-item --> ez-icon
+  style ez-list-item fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+
+
+
+## CSS Variables
+| Variable  | Description | 
+ |-|-|
+| --ez-list-item\_\_title--color | Define a cor do título do item da lista.  | 
+| --ez-list-item\_\_text--color | Define a cor do texto do item da lista.  | 
+| --ez-list-item\_\_icon--color | Define a cor do ícone do item da lista.  | 
+| --ez-list-item\_\_background--color | Define a cor do background do item da lista.  | 
+| --ez-list-item\_\_border--color-hover | Define a cor da borda do item da lista com hover.  | 
+| --ez-list-item\_\_min-width | Define a largura mínima do componente.  | 

package/components/ez-loading-bar/readme.md

@@ -15,7 +15,7 @@ Oculta o ez-loading-bar.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `show() => Promise<void>`
 

package/components/ez-modal-container/readme.md

@@ -28,6 +28,11 @@
 
 ## Dependencies
 
+### Used by
+
+ - [ez-link-builder](../ez-rich-text/ez-link-builder)
+ - [ez-simple-image-uploader](../ez-rich-text/ez-simple-image-uploader)
+
 ### Depends on
 
 - [ez-icon](../ez-icon)
@@ -39,6 +44,8 @@ graph TD;
   ez-modal-container --> ez-icon
   ez-modal-container --> ez-button
   ez-button --> ez-icon
+  ez-link-builder --> ez-modal-container
+  ez-simple-image-uploader --> ez-modal-container
   style ez-modal-container fill:#f9f,stroke:#333,stroke-width:4px
 ```
 

package/components/ez-number-input/readme.md

@@ -41,7 +41,7 @@
 
 Type: `Promise<number>`
 
-
+---
 
 ### `isInvalid() => Promise<boolean>`
 
@@ -51,7 +51,7 @@ Retorna se o conteúdo é inválido.
 
 Type: `Promise<boolean>`
 
-
+---
 
 ### `setBlur() => Promise<void>`
 
@@ -61,7 +61,7 @@ Remove o foco do campo.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `setFocus(options?: TFocusOptions) => Promise<void>`
 

package/components/ez-pagination/readme.md

@@ -0,0 +1,57 @@
+# ez-pagination
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property        | Attribute         | Description                                                            | Type                    | Default     |
+| --------------- | ----------------- | ---------------------------------------------------------------------- | ----------------------- | ----------- |
+| `currentPage`   | `current-page`    | O número da página atual.                                              | `number`                | `1`         |
+| `hideInfoLabel` | `hide-info-label` | Esconde as o texto de informação da paginação no tipo default.         | `boolean`               | `false`     |
+| `pageLimit`     | `page-limit`      | O número de páginas a serem exibidas na paginação.                     | `number`                | `10`        |
+| `pageSize`      | `page-size`       | O número de itens por página.                                          | `number`                | `10`        |
+| `totalItems`    | `total-items`     | O número total de itens.                                               | `number`                | `0`         |
+| `type`          | `type`            | O tipo de paginação a ser renderizada. Pode ser 'default' ou 'number'. | `"default" \| "number"` | `'default'` |
+
+
+## Events
+
+| Event          | Description                                | Type                  |
+| -------------- | ------------------------------------------ | --------------------- |
+| `ezPageChange` | Evento emitido quando a página é alterada. | `CustomEvent<number>` |
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-button](../ez-button)
+
+### Graph
+```mermaid
+graph TD;
+  ez-pagination --> ez-button
+  ez-button --> ez-icon
+  style ez-pagination fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+
+
+
+## CSS Variables
+| Variable  | Description | 
+ |-|-|
+| --ez-pagination\_\_info--color | Define a cor do label de informação dfa paginação.  | 
+| --ez-pagination\_\_info--margin-right | Define o espaçamento entre o texto de informação e os botões de controle.  | 
+| --ez-pagination\_\_info--text-weight | Define o peso da fonte do texto de informação .  | 
+| --ez-pagination\_\_info--font-size | Define o tamanho da fonte do texto de informação .  | 
+| --ez-pagination\_\_info-range--font-weight | Define o peso da fonte do texto de intervalo da informação .  | 
+| --ez-pagination\_\_pages-option-padding | Define o espaçamento lateral entre as opções de páginas do modo numérico .  | 
+| --ez-pagination\_\_pages-option-color | Define a cor de texto das opções de páginas do modo numérico .  | 
+| --ez-pagination\_\_pages-option-weight | Define a o peso da fonte do texto das opções de páginas do modo numérico .  | 
+| --ez-pagination\_\_pages-option-size | Define a o tamanho da fonte do texto das opções de páginas do modo numérico .  | 

package/components/ez-popover/readme.md

@@ -33,7 +33,7 @@ Oculta o ez-popover.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `show(top?: string, left?: string) => Promise<void>`
 
@@ -43,7 +43,7 @@ Exibe o ez-popover.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `showUnder(element: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
 
@@ -53,7 +53,7 @@ Ancora a exibição do popOver a um elemento HTML.
 
 Type: `Promise<void>`
 
-
+---
 
 ### `updatePosition(top?: string, left?: string) => Promise<void>`