From e29ea7bd39e1039f2ccd5c11988c889312769218 Mon Sep 17 00:00:00 2001 From: Dominic Fallows Date: Fri, 19 Jan 2018 14:48:28 +0000 Subject: [PATCH] Create new page docs/creating-hybrid-pages-with-static-and-dynamic-components.md (#3579) * Update docs/creating-and-modifying-pages.md to expand on the use of client-only routes to create a hybrid or "app-shell" Gatsby app * + Split hybrid page docs into its own page and update linked pages * Update creating-and-modifying-pages.md * Update and rename creating-hybrid-pages-with-static-and-dynamic-components.md to building-apps-with-gatsby * Update creating-and-modifying-pages.md * Rename building-apps-with-gatsby to building-apps-with-gatsby.md * Update README.md * Update building-apps-with-gatsby.md --- docs/docs/building-apps-with-gatsby.md | 49 +++++++++++++++++++ docs/docs/creating-and-modifying-pages.md | 29 +---------- .../README.md | 4 +- 3 files changed, 51 insertions(+), 31 deletions(-) create mode 100644 docs/docs/building-apps-with-gatsby.md diff --git a/docs/docs/building-apps-with-gatsby.md b/docs/docs/building-apps-with-gatsby.md new file mode 100644 index 0000000000000..414882e0986ef --- /dev/null +++ b/docs/docs/building-apps-with-gatsby.md @@ -0,0 +1,49 @@ +--- +title: "Building apps with Gatsby" +--- + +Gatsby can be used to create fully dynamic apps. The default Gatsby app is made up of statically rendered pages. On this foundation, you can build what we call "hybrid" sites which adds dynamically rendered sections of pages and if needed, client-only routes. + +## Statically rendered pages + +This is what Gatsby does by default. You create [components (layouts/pages/templates)](/docs/building-with-components/) that render [data you ask for in your GraphQL queries](/docs/querying-with-graphql/). Each page component is rendered to HTML when you build your Gatsby site as well as in the client as people click around the site. + +Content and behaviors on the page will look and act the same for every visitor until the next time you build the site. + +## Dynamic sections of pages + +When your React components load in the browser, they can fetch and render data from APIs. The [React docs have a simple example of how to do this.](https://reactjs.org/docs/faq-ajax.html) + +Some examples of how you could use this: + +* Load live data e.g. sports scores or the weather +* Load data personalized to the user +* Create interactive widgets e.g. allow a user to do searches or submit forms + +## Client-only routes + +Sometimes you want to create client-only portions of a site. A classic example would be a site that has a landing page, a login page, and then an app section for logged-in users. The logged-in section doesn't need to be server rendered as all data will be loaded live from your API after the user logs so it makes sense to make this portion of your site client-only. + +These routes will exist on the client only and will not correspond to index.html files in an app's built assets. If you wish people to visit client routes directly, you'll need to setup your server to handle these correctly. + +To create client-only routes, you want to add code to your site's `gatsby-node.js` like the following: + +_Note: There's also a plugin that can aid in creating client-only routes: +[gatsby-plugin-create-client-paths](/packages/gatsby-plugin-create-client-paths/)_. + +```javascript +// Implement the Gatsby API “onCreatePage”. This is +// called after every page is created. +exports.onCreatePage = async ({ page, boundActionCreators }) => { + const { createPage } = boundActionCreators; + + // page.matchPath is a special key that's used for matching pages + // only on the client. + if (page.path.match(/^\/app/)) { + page.matchPath = "/app/:path"; + + // Update the page. + createPage(page); + } +}; +``` diff --git a/docs/docs/creating-and-modifying-pages.md b/docs/docs/creating-and-modifying-pages.md index c94e7c01dc3f9..50e39c7a908d3 100644 --- a/docs/docs/creating-and-modifying-pages.md +++ b/docs/docs/creating-and-modifying-pages.md @@ -12,7 +12,7 @@ Pages can be created in three ways: * Plugins can also implement `createPages` and create pages for you You can also implement the API [`onCreatePage`](/docs/node-apis/#onCreatePage) -to modify pages created in core or plugins or to create client-only pages. +to modify pages created in core or plugins or to create [client-only routes](/docs/building-apps-with-gatsby/). ## Debugging help @@ -134,33 +134,6 @@ exports.onCreatePage = ({ page, boundActionCreators }) => { }; ``` -### Creating client-only routes - -If you're creating a "hybrid" Gatsby app with both statically rendered pages as -well as client-only routes (e.g. an app that combines marketing pages and your -app that lives under `/app/*`), you want to add code to your `gatsby-node.js` -like the following: - -_Note: There's also a plugin that will set up the creation of client-paths declaratively: -[gatsby-plugin-create-client-paths](/packages/gatsby-plugin-create-client-paths/)_. - -```javascript -// Implement the Gatsby API “onCreatePage”. This is -// called after every page is created. -exports.onCreatePage = async ({ page, boundActionCreators }) => { - const { createPage } = boundActionCreators; - - // page.matchPath is a special key that's used for matching pages - // only on the client. - if (page.path.match(/^\/app/)) { - page.matchPath = "/app/:path"; - - // Update the page. - createPage(page); - } -}; -``` - ### Choosing the page layout By default, all pages will use the layout found at `/layouts/index.js`. diff --git a/packages/gatsby-plugin-create-client-paths/README.md b/packages/gatsby-plugin-create-client-paths/README.md index 4a6e06f732483..3b3d3ceea664e 100644 --- a/packages/gatsby-plugin-create-client-paths/README.md +++ b/packages/gatsby-plugin-create-client-paths/README.md @@ -1,8 +1,6 @@ # gatsby-plugin-create-client-paths -Use this plugin to simplify creating a “hybrid” Gatsby app with both statically -rendered pages as well as "client-paths". These paths exist on the client -only and do not correspond to `index.html` files in an app's built assets. +Use this plugin to simplify creating a “hybrid” Gatsby app with both statically rendered pages as well as "client-paths". These paths exist on the client only and do not correspond to index.html files in an app's built assets. ## Usage