@bigbinary/neeto-filters-frontend 2.11.8 → 2.11.9

package/README.md

@@ -148,10 +148,23 @@ Then the node will be `address.line_1,line_2`. In such cases we need to pass thi
 5. **keyword**: To specify the props related to searching.
 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.
 7. **childrenKeys** The list of keys which has to be cleared from url during clear filters operation.
+8. **entity**: The entity associated with the filters.
 
 All these props must be same as that passed to the `Filters` component.
+The option to save filters as segments will be enabled only when the entity prop is passed to the component.
 
-### 3. `buildFiltersFromURL` function
+### 3. `Segments` component
+
+#### Props
+
+1.  **columns**: The list of columns/fields that needs to be represented in the filters pane.
+2.  **entity**: The entity associated with the segments.
+3.  **setIsPaneOpen**: To trigger the isOpen state of the filters pane.
+
+The "columns" prop must be same as that passed to the `Filters` component.
+To set up the neeto-filters-engine with support for Segments, please follow the instructions provided in the installation [documentation](https://github.com/bigbinary/neeto-filters-engine#installation).
+
+ ### 3. `buildFiltersFromURL` function
 
 - This function takes a list as argument.
 - This list should contains all the filter columns/fields and the value passed to `keyword` prop of `Filters` and `Bar`.