FilterSchemaContext
Defined in: filter/src/hooks/use-filter-schema-context.tsx:13
Extends
Readonly<Required<BasicFilterSphereInput<Data>>>
Type Parameters
• Data = unknown
Properties
fieldDeepLimit
readonlyfieldDeepLimit:number
Defined in: filter/src/types.ts:30
The maximum depth of searching for filter fields.
Default
1Inherited from
Readonly.fieldDeepLimit
filterableFields
readonlyfilterableFields:FilterField[]
Defined in: filter/src/hooks/use-filter-schema-context.tsx:16
filterFnList
readonlyfilterFnList:FnSchema[]
Defined in: filter/src/types.ts:18
The list of filter functions schema.
If not provided, the presetFilter will be used.
Inherited from
Readonly.filterFnList
filterRule
readonlyfilterRule:FilterGroup
Defined in: filter/src/hooks/use-filter-schema-context.tsx:15
getLocaleText()
readonlygetLocaleText: (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()
readonlymapFieldName: (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
Returns
string
Inherited from
Readonly.mapFieldName
mapFilterName()
readonlymapFilterName: (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
field
Returns
string
Inherited from
Readonly.mapFilterName
onRuleChange()?
readonlyoptionalonRuleChange: (rule) =>void
Defined in: filter/src/hooks/use-filter-schema-context.tsx:17
Parameters
rule
Returns
void
schema
readonlyschema:ZodType<Data>
Defined in: filter/src/types.ts:8
The schema of the data to be filtered.
Inherited from
Readonly.schema