Guillaume Chau
35 lines
2.1 KiB
Markdown
35 lines
2.1 KiB
Markdown
# ApolloQuery component
|
|
|
|
## Props
|
|
|
|
- `query`: GraphQL query (transformed by `graphql-tag`) or a function that receives the `gql` tag as argument and should return the transformed query
|
|
- `variables`: Object of GraphQL variables
|
|
- `fetchPolicy`: See [apollo fetchPolicy](https://www.apollographql.com/docs/react/basics/queries.html#graphql-config-options-fetchPolicy)
|
|
- `pollInterval`: See [apollo pollInterval](https://www.apollographql.com/docs/react/basics/queries.html#graphql-config-options-pollInterval)
|
|
- `notifyOnNetworkStatusChange`: See [apollo notifyOnNetworkStatusChange](https://www.apollographql.com/docs/react/basics/queries.html#graphql-config-options-notifyOnNetworkStatusChange)
|
|
- `context`: See [apollo context](https://www.apollographql.com/docs/react/basics/queries.html#graphql-config-options-context)
|
|
- `skip`: Boolean disabling query fetching
|
|
- `clientId`: id of the Apollo Client used by the query (defined in ApolloProvider `clients` option)
|
|
- `deep`: Boolean to use deep Vue watchers
|
|
- `tag`: String HTML tag name (default: `div`); if falsy (for example `null` or `undefined`), the component will be renderless (the content won't be wrapped in a tag), in this case, only the first child will be rendered
|
|
- `debounce`: Number of milliseconds for debouncing refetches (for example when the variables are changed)
|
|
- `throttle`: Number of milliseconds for throttling refetches (for example when the variables are changed)
|
|
- `prefetch`: If `false`, will skip prefetching during SSR
|
|
|
|
## Scoped slot
|
|
|
|
- `result`: Apollo Query result
|
|
- `result.data`: Data returned by the query
|
|
- `result.loading`: Boolean indicating that a request is in flight
|
|
- `result.error`: Eventual error for the current result
|
|
- `result.networkStatus`: See [apollo networkStatus](https://www.apollographql.com/docs/react/basics/queries.html#graphql-query-data-networkStatus)
|
|
- `query`: Smart Query associated with the component
|
|
- `isLoading`: Smart Query loading state
|
|
- `gqlError`: first GraphQL error if any
|
|
- `times`: number of times the result was updated
|
|
|
|
## Events
|
|
|
|
- `result(resultObject)`
|
|
- `error(errorObject)`
|