English

Quick start

Install

npm

yarn

pnpm

npm install @react-filter/antd

import { ReactFilter } from '@react-filter/antd';

<ReactFilter />;

Props	Description	Type	Default Props
`defaultValue`	component default value after mount	`object`
`value`	component value	`object`
`onChange`	callback when component value change	`(value) => void`
`connectors`	relations of filter groups	`SelectOption[]`	`{ label: '且', value: 'AND' }` `{ label: '或', value: 'OR' }`
`operators`	operators of filter item	`SelectOption[]`	`{ label: "等于", "value": "equal"}` `{ "label": "不等于", "value": "not_equal"}` `{ "label": "大于", "value": "greater" }` `{ "label": "大于等于", "value": "greater_equal" }` `{ "label": "小于", "value": "less" }` `{ "label": "小于等于", "value": "less_equal" }` `{ "label": "包含", "value": "in" }` `{ "label": "不包含", "value": "not_in" }` `{ "label": "模糊匹配", "value": "like" }` `{ "label": "不匹配", "value": "not_like" }`
`fieldNames`	field of value	`FieldNameMap`	`{connector: 'connector', filters: 'filters', left: 'left', operator: 'operator', value: 'value'}`

interface SelectOption {
  label: React.ReactNode;
  value: string | number | boolean;
}

interface FieldNameMap {
  connector?: string;
  filters?: string;
  left?: string;
  operator?: string;
  value?: string;
}

TOC