@bigbinary/neeto-filters-frontend 2.9.6 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/index.cjs.js +2694 -2230
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.js +2694 -2230
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/types.d.ts +35 -31
package/README.md
CHANGED
|
@@ -32,6 +32,7 @@ neeto-filters-frontend exports 2 components (`Filters` & `Bar`) and 2 functions
|
|
|
32
32
|
8. **isSearchable**: To specify whether you need a search bar in filters pane to search through filter fields.
|
|
33
33
|
9. **className**: To specify classes to the Filters component.
|
|
34
34
|
10. **keyword**: To specify the props related to searching.
|
|
35
|
+
11. **children**: To specify the custom components specific to the host application.
|
|
35
36
|
|
|
36
37
|
Here is an example of `keyword` prop:
|
|
37
38
|
```js
|
|
@@ -105,6 +106,7 @@ Then the node will be `address.line_1,line_2`. In such cases we need to pass thi
|
|
|
105
106
|
- `showRuleSelector` : Boolean value, which determines whether to show a rule selector above the `text` , `number` and `decimal` type fields. `false` by default.
|
|
106
107
|
- `hidden`: Boolean value, which determines to show or hide field from filter pane. `false ` by default.
|
|
107
108
|
- `defaultValue`: The default value that should appear as chosen one in the filter fields.
|
|
109
|
+
- `defaultType`: The type of the input that should be used in the Filters pane.
|
|
108
110
|
- `isClearable`: Boolean value which specifies whether the field can be cleared or not.
|
|
109
111
|
|
|
110
112
|
- By `selectors` we mean the filter fields which doesn't have any relation (`node`) to a DB >table column.
|
|
@@ -140,6 +142,7 @@ Then the node will be `address.line_1,line_2`. In such cases we need to pass thi
|
|
|
140
142
|
4. **className**: To specify classes to the Bar component.
|
|
141
143
|
5. **keyword**: To specify the props related to searching.
|
|
142
144
|
6. **onSelectorsChange**: To specify the callback function that is triggered whenever a selector value is changed. This function will get the updated selectors as argument.
|
|
145
|
+
7. **children**: To specify the custom components specific to the host application.
|
|
143
146
|
|
|
144
147
|
All these props must be same as that passed to the `Filters` component.
|
|
145
148
|
|