Sanity GROQ Filter

Curated List of GROQ Filters.

Usage / Examples

Removes all references which are already present in the parent and returns only the unused references.

$3

``js
import GroqFilter from "sanity-groq-filter"

export default {
name: 'documentName',
type: 'document',
fields: [
{
name: 'fieldName',
type: 'array',
of: [
{
type: 'reference',
to: { type: 'someReferencedType' },
options: { filter: GroqFilter.unusedReferences }
}
],
validation: Rule => Rule.unique()
},
]
}
`

$3

Filters to include only documents with ${fieldName} containing the ${matchStr}.

`js
import GroqFilter from "sanity-groq-filter"

export default {
name: 'documentName',
type: 'document',
fields: [
{
name: 'fieldName',
type: 'array',
of: [
{
type: 'reference',
to: { type: 'someReferencedType' },
options: { filter: GroqFilter.matches('myField', 'barbeque') }
}
],
validation: Rule => Rule.unique()
},
]
}
`

$3

Filters to exclude documents with ${fieldName} containing the ${matchStr}.

`js
import GroqFilter from "sanity-groq-filter"
//...
options: { filter: GroqFilter.excludes('myField', 'barbeque') }
//...
``

Further Reading

Sanity documentation on filters