Skip to content

Commit

Permalink
Document how to create custom fragments (#3914)
Browse files Browse the repository at this point in the history
* Document how to create custom fragments

* Fix ordering

* Add example component exporting a fragment

* Tweak language
  • Loading branch information
jiahaog authored and KyleAMathews committed Feb 9, 2018
1 parent 5160b03 commit f8f52ba
Showing 1 changed file with 141 additions and 0 deletions.
141 changes: 141 additions & 0 deletions docs/docs/querying-with-graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,147 @@ See also the following blog posts:
* [Making Website Building Fun](/blog/2017-10-16-making-website-building-fun/)
* [Image Optimization Made Easy with Gatsby.js](https://medium.com/@kyle.robert.gill/ridiculously-easy-image-optimization-with-gatsby-js-59d48e15db6e)
## Advanced
### Fragments
Notice that in the above example for [querying images](#images), we used `...GatsbyImageSharpResolutions`, which is a GraphQL Fragment, a reusable set of fields for query composition. You can read more about them [here](http://graphql.org/learn/queries/#fragments).
If you wish to define your own fragments for use in your application, you can use named exports to export them in any Javascript file, and they will be automatically processed by Gatsby for use in your GraphQL queries.
For example if I put a fragment in a helper component, I can use that fragment in any other query:
```jsx
// src/components/PostItem.js
export const markdownFrontmatterFragment = graphql`
fragment MarkdownFrontmatter on MarkdownRemark {
frontmatter {
path
title
date(formatString: "MMMM DD, YYYY")
}
}
`;
```
They can then be used in any GraphQL query after that!
```graphql
query PostByPath($path: String!) {
markdownRemark(frontmatter: { path: { eq: $path } }) {
...MarkdownFrontmatter
}
}
```
It’s good practice for your helper components to define and export a fragment for the data they need. For example, on your index page might map over all of your posts to show them in a list.
```jsx
// src/pages/index.jsx
import React from "react";
export default ({ data }) => {
return (
<div>
<h1>
Index page
</h1>
<h4>{data.allMarkdownRemark.totalCount} Posts</h4>
{data.allMarkdownRemark.edges.map(({ node }) => (
<div key={node.id}>
<h3>
{node.frontmatter.title}{" "}
<span>— {node.frontmatter.date}</span>
</h3>
</div>
))}
</div>
);
};
export const query = graphql`
query IndexQuery {
allMarkdownRemark {
totalCount
edges {
node {
id
frontmatter {
title
date(formatString: "DD MMMM, YYYY")
}
}
}
}
}
`;
```
If the index component becomes too large, you might want to refactor it into smaller components.
```jsx
// src/components/IndexPost.jsx
import React from "react";
export default ({ frontmatter: { title, date } }) => (
<div>
<h3>
{title} <span>— {date}</span>
</h3>
</div>
);
export const query = graphql`
fragment IndexPostFragment on MarkdownRemark {
frontmatter {
title
date(formatString: "MMMM DD, YYYY")
}
}
`;
```
Now, we can use the component together with the exported fragment in our index page.
```jsx{28}
// src/pages/index.jsx
import React from "react";
import IndexPost from "../components/IndexPost";
export default ({ data }) => {
return (
<div>
<h1>
Index page
</h1>
<h4>{data.allMarkdownRemark.totalCount} Posts</h4>
{data.allMarkdownRemark.edges.map(({ node }) => (
<div key={node.id}>
<IndexPost frontmatter={node.frontmatter} />
</div>
))}
</div>
);
};
export const query = graphql`
query IndexQuery {
allMarkdownRemark {
totalCount
edges {
node {
...IndexPostFragment
}
}
}
}
`;
```
## Further reading
### Getting started with GraphQL
Expand Down

0 comments on commit f8f52ba

Please sign in to comment.