@bigbinary/neeto-filters-frontend 2.10.0 → 2.10.2
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 +6 -3
- package/dist/index.cjs.js +2977 -2332
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.js +2959 -2314
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/types.d.ts +3 -0
package/README.md
CHANGED
|
@@ -32,7 +32,8 @@ 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. **
|
|
35
|
+
11. **childrenKeys** The list of keys which has to be cleared from url during clear filters operation.
|
|
36
|
+
12. **children**: To specify the custom components specific to the host application.
|
|
36
37
|
|
|
37
38
|
Here is an example of `keyword` prop:
|
|
38
39
|
```js
|
|
@@ -84,7 +85,8 @@ export const SAMPLE_FILTER_FIELDS = [
|
|
|
84
85
|
},
|
|
85
86
|
];
|
|
86
87
|
```
|
|
87
|
-
-
|
|
88
|
+
- `key` : A unique identifier provided to each columns/field.
|
|
89
|
+
- `group`: The label of the group, if the field is associated with a group.
|
|
88
90
|
- `node`: The column in DB table corresponding to the field.
|
|
89
91
|
- `label` The label to be shown just above the field in Pane.
|
|
90
92
|
- `type`: The nature/type of the field needed in pane.
|
|
@@ -142,7 +144,8 @@ Then the node will be `address.line_1,line_2`. In such cases we need to pass thi
|
|
|
142
144
|
4. **className**: To specify classes to the Bar component.
|
|
143
145
|
5. **keyword**: To specify the props related to searching.
|
|
144
146
|
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. **
|
|
147
|
+
7. **childrenKeys** The list of keys which has to be cleared from url during clear filters operation.
|
|
148
|
+
8. **children**: To specify the custom components specific to the host application.
|
|
146
149
|
|
|
147
150
|
All these props must be same as that passed to the `Filters` component.
|
|
148
151
|
|