GraphQL query for MatrixFields

[DTesch-Reem]

Is it possible to query for matrixfields using GraphQL?
I want to filter the results based on the matrixfield value.

[brandonkelly]

It’s not. You should be able to accomplish what you want using the Preparse Field plugin, which can be used to store prerendered values as top-level fields. So for example if you want to filter entries in GraphQL if any of its Matrix blocks contain a certain value, you could set the Preparse field to:

{{ clone(element.myMatrixField)
  .someField('test-value')
  .exists() ? '1' }}

Then in your GraphQL query, you could include myPreparseField: 1 in the params.

[DTesch-Reem]

Thanks but that won't work for me because i am using the CMS in headless mode.

[brandonkelly]

My suggestion will work either way.

[DTesch-Reem]

Is it possible to make it function like a search? The user should be able to search for any string values in the front end.

[brandonkelly]

Sorry, if you just want this for search, Preparse won’t be needed. Just posted a new answer for that.

[brandonkelly]

If you just want your Matrix content to be treated as search keywords for the entries, that’s possible out of the box.

Edit your Matrix field, and ensure it’s “Use this field’s values as search keywords” checkbox is ticked.

Then do the same for each sub-field that you want included in the Matrix field’s search keywords.

Finally, run the following command for any sections that use the Matrix field:

php craft resave/entries --section <sectionHandle> --update-search-index

Once finished, the search GraphQL query argument will work for your Matrix fields.

[DTesch-Reem]

Thanks, that is neat 😀
Although I find myself happier using the Plugin Preparse Field because it gives me the opportunity to format the text / to strip html tags beforehand.

[brandonkelly]

OK, well in that case you can just mark the Preparse field as searchable.

[DTesch-Reem]

Yes just checked, the html tags get stripped automatically. 😀

[bryantwells]

@brandonkelly would this technique work for entry fields nested within a matrix block?

[brandonkelly]

Sure, except the Preparse field isn’t going to automatically get updated when the related entries are updated.