directus-extension-filters-interface
v1.5.2
Published
This is a custom filter & rule interface for Directus 9&10. It allows you to setup an interface with defined properties that users can then select and add values and conditions for.
Downloads
153
Maintainers
Readme
Custom filter & rule Interface - for Directus 9&10
This is a custom filter & rule interface for Directus 9&10. It allows you to setup an interface with defined properties that users can then select and add values and conditions for.
Using the Rule Filter Validator library you can validate and test the rules stored in your frontend and backend.
Support for $NOW
and field functions such as year()
and count()
is supported in Rule Filter Validator since version 1.5.0
Install
npm install directus-extension-filters-interface
OR
Copy the index.js
file from the dist folder into your project eg. PATH_TO_DIRECTUS_PROJECT/extensions/interfaces/filters
Config
When setting up you as the developer should add the properties that can be chosen according to the following schema:
type Properties = {
[Property: string]: string | Property[] | AdvProp | RelationProp
}
type PropType = 'string' | 'boolean' | 'integer' | 'timestamp' | 'text';
type AdvProp = {
type: PropType
label?: string
choices?: Choice[]
operators?: FieldFilterOperator[]
}
type RelationProp = {
type: PropType
label: string
field: string
template: string
interface: string
collection: string
filter?: Filter
}
Example
{
"org": {
"id": {
"type": "integer",
"field": "id",
"template": "{{name}}",
"interface": "select-dropdown-m2o",
"collection": "organizations",
"filter": {
"country": {
/* It supports getting top level values from the current item */
"_eq": "$CURRENT_ITEM.country"
}
}
},
"country": {
"type": "string",
"choices": "$COUNTRIES"
}
},
"person": {
"id": "integer",
"age": "integer",
"dob": "dateTime", // Will allow for selecting year, month, day, minute and second
"active": "boolean",
"gender": {
"type": "string",
"choices": [
{
"text": "Male",
"value": "male"
},
{
"text": "Female",
"value": "female"
}
],
// (optional) Override default operators for this type (@see @directus/utils/getFilterOperatorsForType)
"operators": [
"eq",
"neq"
]
}
}
}
Develop
- Clone repo
npm install
- Update the path in package.json from
dist/index.js
toPATH_TO_DIRECTUS_PROJECT/extensions/interfaces/filters
npm run dev
PRs are welcome