@tripup-company/element-ui-extended 0.0.4 → 0.0.9

package/README.md

@@ -85,7 +85,90 @@ Attributes
 |data|data biding values for fields|Object|—|{}|
 |errors|errors for fields|Object|—|{}|
 
-GenericTable is component that combine such components of element io: el-table, el-paginator
+GenericFilters - component for work with filter ( template with checkbox for use selected filters) 
+===
+Attributes
+---
+|Attribute name|Description|Type|Accepted values|Default|
+| --- | --- | --- | --- | --- |
+|filters| all filters for show| Array | [] | []|
+|search| selected filters | Array | [] | [] |
+
+Example filters:
+```
+[
+    {
+        name: 'state',
+        label: 'State',
+        type: 'string',
+    },
+    {
+        name: 'created_at',
+        label: 'Created at',
+        type: 'date',
+        operator: 'between_date',
+    }
+]
+```
+Example search: 
+```
+{
+    title: {
+        title: Object
+        operator: ""
+        value: ""
+    },
+    first_name,last_name,email,phone,mobile,position,street,city,state,second_email,department: {
+        operator: "like_fields"
+        position: "top"
+        value: ""
+    }
+}
+```
+
+Events
+---
+@apply:filter
+
+@reset:filter
+
+GenericTopFilters - component for work with filter (template without checkbox)
+===
+Attributes and events such as GenericFilter component
+---
+
+
+GenericTable - component for show table
+===
+Attributes
+---
+|Attribute name|Description|Type|Accepted values|Default|
+| --- | --- | --- | --- | --- |
+|fields|Array of columns|Array|[]|[]|
+|data|Array of rows|Array|[]|[]|
+
+Events
+---
+@sort:change
+
+
+GeneticPaginator - component for pagination
+===
+Attributes
+---
+|Attribute name|Description|Type|Accepted values|Default|
+| --- | --- | --- | --- | --- |
+|total|Total rows|Number|Number|0|
+|limit|Limit per page|Number|Number|0|
+|current-page|Number current page|Number|Number|0|
+
+Events
+---
+@size:change
+
+@page:change
+
+CompositeTable is component that combine such components GenericTable, GenericFilters, GenericTopFilters
 ====
-It also include filters right side and top filter
+