Skip to main content

api.getReactiveState()

Description​

Gets the state object that stores current values of most FilterBuilder properties

Usage​

api.getReactiveState(): object;

Returns​

The method returns an object with the following parameters:

{
   value: {}; //an object that stores all the filters in a tree-like structure
   fields: [];// the list of fields
   options: {}; //the list of options for each field
}

Properties description you can find here: FilterBuilder properties overview

Example​

import { getData } from "./common/data";
import { FilterBuilder } from "@svar-ui/react-filter";

export default function App() {
  const { value, fields, options } = getData();

  const init = (api) => {
    const { fields } = api.getReactiveState();
    console.log(fields); // outputs the list of fields to console
  };

  return `<FilterBuilder value={value} options={options} fields={fields} init={init} />`;
}

Related articles: How to access FilterBuilder API