@sankhyalabs/ezui-docs 5.21.0-dev.40 → 5.21.0-dev.42

package/components/ez-button/readme.md

@@ -50,6 +50,7 @@ Type: `Promise<void>`
  - [ez-grid](../ez-grid)
  - [ez-guide-navigator](../ez-guide-navigator)
  - [ez-modal-container](../ez-modal-container)
+ - [ez-sidebar-navigator](../ez-sidebar-navigator)
  - [ez-split-item](../ez-split-panel/structure/item)
  - [ez-text-edit](../ez-text-edit)
  - [filter-column](../ez-grid/subcomponents)
@@ -68,6 +69,7 @@ graph TD;
   ez-grid --> ez-button
   ez-guide-navigator --> ez-button
   ez-modal-container --> ez-button
+  ez-sidebar-navigator --> ez-button
   ez-split-item --> ez-button
   ez-text-edit --> ez-button
   filter-column --> ez-button

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

@@ -123,6 +123,7 @@ graph TD;
   ez-guide-navigator --> ez-button
   ez-guide-navigator --> ez-scroller
   ez-guide-navigator --> ez-tree
+  ez-sidebar-button --> ez-icon
   ez-filter-input --> ez-text-input
   ez-filter-input --> ez-icon
   ez-button --> ez-icon

package/components/ez-icon/readme.md

@@ -34,6 +34,7 @@
  - [ez-modal-container](../ez-modal-container)
  - [ez-multi-selection-list](../ez-multi-selection-list)
  - [ez-search](../ez-search)
+ - [ez-sidebar-button](../ez-sidebar-button)
  - [ez-split-button](../ez-split-button)
  - [ez-tabselector](../ez-tabselector)
  - [ez-time-input](../ez-time-input)
@@ -58,6 +59,7 @@ graph TD;
   ez-modal-container --> ez-icon
   ez-multi-selection-list --> ez-icon
   ez-search --> ez-icon
+  ez-sidebar-button --> ez-icon
   ez-split-button --> ez-icon
   ez-tabselector --> ez-icon
   ez-time-input --> ez-icon

package/components/ez-scroller/readme.md

@@ -19,11 +19,13 @@
 ### Used by
 
  - [ez-guide-navigator](../ez-guide-navigator)
+ - [ez-sidebar-navigator](../ez-sidebar-navigator)
 
 ### Graph
 ```mermaid
 graph TD;
   ez-guide-navigator --> ez-scroller
+  ez-sidebar-navigator --> ez-scroller
   style ez-scroller fill:#f9f,stroke:#333,stroke-width:4px
 ```
 

package/components/ez-sidebar-button/readme.md

@@ -17,11 +17,18 @@
 ### Used by
 
  - [ez-guide-navigator](../ez-guide-navigator)
+ - [ez-sidebar-navigator](../ez-sidebar-navigator)
+
+### Depends on
+
+- [ez-icon](../ez-icon)
 
 ### Graph
 ```mermaid
 graph TD;
+  ez-sidebar-button --> ez-icon
   ez-guide-navigator --> ez-sidebar-button
+  ez-sidebar-navigator --> ez-sidebar-button
   style ez-sidebar-button fill:#f9f,stroke:#333,stroke-width:4px
 ```
 

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

@@ -0,0 +1,82 @@
+# ez-sidebar-navigator
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property           | Attribute            | Description                                                  | Type                                                               | Default                |
+| ------------------ | -------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------ | ---------------------- |
+| `isResponsive`     | `is-responsive`      | Define se terá responsividade, Controle deverá ser pelo CSS. | `boolean`                                                          | `false`                |
+| `mode`             | `mode`               | Define se o menu será do tipo FIXED ou FLOAT.                | `ModeMenuEnum.FIXED \| ModeMenuEnum.FLOAT`                         | `ModeMenuEnum.FLOAT`   |
+| `showCollapseMenu` | `show-collapse-menu` | Define se o botão de "Recolher Menu" será exibido            | `boolean`                                                          | `true`                 |
+| `showFixedButton`  | `show-fixed-button`  | Define se o botão de "Fixar Menu" será exibido               | `boolean`                                                          | `true`                 |
+| `size`             | `size`               | Define o tamanho do menu (small, medium, large).             | `SizeMenuEnum.LARGE \| SizeMenuEnum.MEDIUM \| SizeMenuEnum.SMALL`  | `SizeMenuEnum.SMALL`   |
+| `titleMenu`        | `title-menu`         | Define o título do Sidebar Navigator                         | `string`                                                           | `""`                   |
+| `type`             | `type`               | Define o tipo do menu (float, fixed ou dynamic (livre)).     | `TypeMenuEnum.DYNAMIC \| TypeMenuEnum.FIXED \| TypeMenuEnum.FLOAT` | `TypeMenuEnum.DYNAMIC` |
+
+
+## Events
+
+| Event          | Description                                                              | Type                                                    |
+| -------------- | ------------------------------------------------------------------------ | ------------------------------------------------------- |
+| `ezChangeMode` | Evento emitido sempre que o modo (FLOAT ou FIXED) do menu for alterado.. | `CustomEvent<ModeMenuEnum.FIXED \| ModeMenuEnum.FLOAT>` |
+
+
+## Methods
+
+### `changeModeMenu() => Promise<void>`
+
+Método para fixar/desafixar o menu, emitindo o evento ezChangeMode.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `closeSidebar() => Promise<void>`
+
+Método para fechar o menu automaticamente após uma ação, fluxo, etc.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `openSidebar() => Promise<void>`
+
+Método para abrir o menu automaticamente após uma ação, fluxo, etc.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-sidebar-button](../ez-sidebar-button)
+- [ez-button](../ez-button)
+- [ez-scroller](../ez-scroller)
+
+### Graph
+```mermaid
+graph TD;
+  ez-sidebar-navigator --> ez-sidebar-button
+  ez-sidebar-navigator --> ez-button
+  ez-sidebar-navigator --> ez-scroller
+  ez-sidebar-button --> ez-icon
+  ez-button --> ez-icon
+  style ez-sidebar-navigator fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/ezui-docs",
-  "version": "5.21.0-dev.40",
+  "version": "5.21.0-dev.42",
   "description": "Documentação da biblioteca de componentes Sankhya.",
   "main": "",
   "files": [