Skip to content

Commit 289d0b7

Browse files
Maria Comaspmelab
authored andcommitted

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@
44
[![Code Coverage](https://img.shields.io/codecov/c/github/drupal-graphql/graphql-views.svg)](https://codecov.io/gh/drupal-graphql/graphql-views)
55
[![Code Quality](https://img.shields.io/scrutinizer/g/drupal-graphql/graphql-views.svg)](https://scrutinizer-ci.com/g/drupal-graphql/graphql-views/?branch=8.x-1.x)
66

7-
Please refer to the main [Drupal GraphQL] module for further information.
8-
97
[Drupal GraphQL]: https://github.com/drupal-graphql/graphql
8+
9+
With `graphql_views` enabled a `GraphQL` views display can be added to any view in the system.
10+
11+
Results can be sorted, filtered based on content fields, and relationships can be added. There is also the option to return either the full entities, just a selection of fields, or even search results taken straight from a search server.
12+
13+
Any `GraphQL` views display will provide a field that will adapt to the views configuration:
14+
15+
- The fields name will be composed of the views and displays machine names or configured manually.
16+
- If the view is configured with pagination, the field will accept pager arguments and return the result list and count field instead of the entity list directly.
17+
- Any exposed filters will be added to the `filters` input type that can be used to pass filter values into the view.
18+
- Any contextual filters will be added to the `contextual_filters` input type.
19+
- If a contextual filters validation criteria match an existing GraphQL type, the field will be added to this type too, and the value will be populated from the current result context.
20+
21+
Read more on:
22+
- https://www.amazeelabs.com/en/blog/graphql-drupalers-part-4-fetching-entities
23+
- https://www.amazeelabs.com/en/blog/drupal-graphql-batteries-included
24+
25+
Please also refer to the main [Drupal GraphQL] module for further information.

0 commit comments

Comments
 (0)