@tripup-company/element-ui-extended 0.0.3 → 0.0.8

package/README.md

@@ -22,3 +22,153 @@ npm run lint
 
 ### Customize configuration
 See [Configuration Reference](https://cli.vuejs.org/config/).
+
+NewField, EditableField are powerful components that combine such components of element io: el-checkbox, el-input-number, el-select, el-date-picker, el-input
+====
+These components are quickly configurable through the config and are needed to shorten the code, we can render elements use loop
+---
+Works with Vue 2.*, example:
+---
+```
+<editable-field
+    v-model="data[prop]"
+    :type="'select'"
+    :select-list="selectList"
+    :select-multiple="selectMultiple"
+    :select-key="'value'"
+    :select-label="'name'
+    :select-value="'value'"
+    :field="prop"
+    :remote-method="remoteMethod"
+    :filterable="filterable"
+    @editable:save="updateValue"
+/>
+```
+Attributes
+---
+|Attribute name|Description|Type|Accepted values|Default|
+| --- | --- | --- | --- | --- |
+|field|field key in model|String|—|''|
+|value|field value - binding value|String, Boolean, Date, Number, Array|—|''|
+|type|type element from Accepted values|String|checkbox select date-picker number textarea input|input|
+|placeholder|placeholder for this field|String|—|''|
+|select-key|selectKey in select-list|String|—|''|
+|select-label|selectLabel  in select-list|String|—|''|
+|remote-method|remote method for select search|Object|—|null|
+|step|incremental step|Number|—|1|
+|precision|precision of input value|Number|—|0|
+|select-multiple|is select Multiple|Boolean|—|false|
+|select-list|list for select|Array|—|[]|
+
+PartColumn is component that show part of form with it title and configured column resolution
+====
+This component is wrapper for column it need for quick create part of form and transfer errors from backend to form elements
+---
+```
+ <part-column
+    :data="form.partner"
+    :fields="partnerConfig.commissionFields"
+    :prop-prefix="'partner.'"
+    :errors="errors"
+    @save="partnerUpdateValue"
+/>
+```
+Attributes
+---
+|Attribute name|Description|Type|Accepted values|Default|
+| --- | --- | --- | --- | --- |
+|col-resolution|col resolution for this column|Object|—|{xl: 24, lg: 24, md: 24, sm: 24, xs: 24}|
+|col-inner-resolution|col resolution for current field|Object|—|{xl: 24, lg: 24, md: 24, sm: 24, xs: 24}|
+|column-name|column label (title)|String|—|''|
+|prop-prefix|prefix for all fields in column|String|—|''|
+|fields|fields array|Array|—|[]|
+|data|data biding values for fields|Object|—|{}|
+|errors|errors for fields|Object|—|{}|
+
+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
+====
+
+