@sankhyalabs/sankhyablocks-docs 5.5.0 → 5.6.0

package/components/snk-filter-field-search/readme.md

@@ -7,9 +7,10 @@
 
 ## Properties
 
-| Property     | Attribute    | Description                                              | Type      | Default |
-| ------------ | ------------ | -------------------------------------------------------- | --------- | ------- |
-| `searchable` | `searchable` | Define se o componente irá possuir um campo de pesquisa. | `boolean` | `true`  |
+| Property           | Attribute    | Description                                                                         | Type                     | Default     |
+| ------------------ | ------------ | ----------------------------------------------------------------------------------- | ------------------------ | ----------- |
+| `fieldsDataSource` | --           | Define a fonte de dados que o componente vai utilizar para carregamento dos campos. | `FilterFieldsDataSource` | `undefined` |
+| `searchable`       | `searchable` | Define se o componente irá possuir um campo de pesquisa.                            | `boolean`                | `true`      |
 
 
 ## Events
@@ -21,7 +22,7 @@
 
 ## Methods
 
-### `filterDataSource(filterText: string) => Promise<void>`
+### `applyFilter(filterText: string) => Promise<void>`
 
 Filtra a fonte de dados do componente.
 
@@ -31,9 +32,10 @@ Type: `Promise<void>`
 
 
 
-### `setDataSource(currentLink: IFilterLink, fetchData: DataFetcher) => Promise<void>`
+### `show() => Promise<void>`
 
-Define a fonte de dados do componente.
+Realiza a abertura do componente e faz a primeira carga 
+de dados.
 
 #### Returns
 
@@ -42,6 +44,19 @@ Type: `Promise<void>`
 
 
 
+## Dependencies
+
+### Used by
+
+ - [snk-expression-item](../snk-personalized-filter/subcomponents/snk-expression-item)
+
+### Graph
+```mermaid
+graph TD;
+  snk-expression-item --> snk-filter-field-search
+  style snk-filter-field-search fill:#f9f,stroke:#333,stroke-width:4px
+```
+
 ----------------------------------------------
 
 

package/components/snk-personalized-filter/readme.md

@@ -0,0 +1,32 @@
+# snk-personalized-filter
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute | Description                                                                            | Type                | Default     |
+| ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `messagesBuilder` | --        | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+
+
+## Dependencies
+
+### Depends on
+
+- [snk-expression-item](./subcomponents/snk-expression-item)
+
+### Graph
+```mermaid
+graph TD;
+  snk-personalized-filter --> snk-expression-item
+  snk-expression-item --> snk-filter-field-search
+  snk-expression-item --> snk-filter-param-config
+  style snk-personalized-filter fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md

@@ -0,0 +1,47 @@
+# snk-expression-item
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute    | Description                                                                            | Type                | Default     |
+| ----------------- | ------------ | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `canRemove`       | `can-remove` | Controla a exibição do botão Remover.                                                  | `boolean`           | `true`      |
+| `expression`      | --           | Expressão que será representada visualmente.                                           | `IExpressionItem`   | `undefined` |
+| `messagesBuilder` | --           | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+
+
+## Events
+
+| Event                | Description                                      | Type                           |
+| -------------------- | ------------------------------------------------ | ------------------------------ |
+| `ezFilterItemChange` | Emitido quando acontece alterações na expressão. | `CustomEvent<IExpressionItem>` |
+| `ezFilterItemRemove` | Emitido ao confirmar uma remoção.                | `CustomEvent<IExpressionItem>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-personalized-filter](../..)
+
+### Depends on
+
+- [snk-filter-field-search](../../../snk-filter-field-search)
+- [snk-filter-param-config](../snk-filter-param-config)
+
+### Graph
+```mermaid
+graph TD;
+  snk-expression-item --> snk-filter-field-search
+  snk-expression-item --> snk-filter-param-config
+  snk-personalized-filter --> snk-expression-item
+  style snk-expression-item fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md

@@ -35,6 +35,19 @@ Type: `Promise<IExpressionItem>`
 
 
 
+## Dependencies
+
+### Used by
+
+ - [snk-expression-item](../snk-expression-item)
+
+### Graph
+```mermaid
+graph TD;
+  snk-expression-item --> snk-filter-param-config
+  style snk-filter-param-config fill:#f9f,stroke:#333,stroke-width:4px
+```
+
 ----------------------------------------------
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/sankhyablocks-docs",
-    "version": "5.5.0",
+    "version": "5.6.0",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [