FilterSchemaContext

Defined in: filter/src/hooks/use-filter-schema-context.tsx:13

Extends

• Readonly<Required<BasicFilterSphereInput<Data>>>

Type Parameters

Data

Data = unknown

Properties

fieldDeepLimit

readonly fieldDeepLimit: number

Defined in: filter/src/types.ts:30

The maximum depth of searching for filter fields.

Default

1

Inherited from

FilterSphereInput.fieldDeepLimit

---

filterableFields

readonly filterableFields: FilterField[]

Defined in: filter/src/hooks/use-filter-schema-context.tsx:16

---

filterFnList

readonly filterFnList: FnSchema[]

Defined in: filter/src/types.ts:18

The list of filter functions schema.

If not provided, the presetFilter will be used.

Inherited from

FilterSphereInput.filterFnList

---

filterRule

readonly filterRule: FilterGroup

Defined in: filter/src/hooks/use-filter-schema-context.tsx:15

---

getLocaleText()

readonly getLocaleText: (key) => string

Defined in: filter/src/types.ts:53

Returns the translation for the key.

Parameters

key

string

Returns

string

Inherited from

Readonly.getLocaleText

---

mapFieldName()

readonly mapFieldName: (field) => string

Defined in: filter/src/types.ts:38

Map the filter field to the field name.

For example, if the field path is user.name, you can map it to Name.

If not provided, the default map will use the fieldSchema.description or the field path as the name.

Parameters

field

FilterField

Returns

string

Inherited from

Readonly.mapFieldName

---

mapFilterName()

readonly mapFilterName: (filterSchema, field) => string

Defined in: filter/src/types.ts:46

Map the filter fn schema to the filter label.

For example, if the filter name is eq, you can map it to Equal.

If not provided, the default map will use the filter name as the label.

Parameters

filterSchema

StandardFnSchema

field

FilterField

Returns

string

Inherited from

Readonly.mapFilterName

---

onRuleChange()?

readonly optional onRuleChange: (rule) => void

Defined in: filter/src/hooks/use-filter-schema-context.tsx:17

Parameters

rule

FilterGroup

Returns

void

---

schema

readonly schema: $ZodType<Data>

Defined in: filter/src/types.ts:8

The schema of the data to be filtered.

Inherited from

Readonly.schema