Gatsby

gatsby-plugin-better-page-tree

Gatsby CI Status

This plugin will make the page tree provided by gatsby graphql more intuitive. It was created to overcome some issues with child and parent relations in gatsbyjs.

The initial question on Stackoverflow was this one: How do you figure out parent and child relations between pages in gatsbyjs?. After taking this directly to the gatsby community, the need for a plugin was clear.

gatsby-plugin-better-page-tree will generate the relations like this: /src/pages/subpages,

/src/pages/parentpage/index.js
/src/pages/parentpage/subpage/index.js

will now give you:

{
  "node": {
    "id": "PageTree-parentpage-id-8496bef7-3809-4fac-8f97-ab2b98b7f54d",
    "name": "Parentpage",
    "pathRaw": "/parentpage/",
    "pathNoTrail": "/parentpage",
    "isparentpage": true,
    "children": [
      {
        "id": "PageTree-parentpage/subpage-id-bc8cec01-3f85-47d2-aec9-2e3ddc76df32",
        "name": "Subpage",
        "pathRaw": "/parentpage/subpage/",
        "pathNoTrail": "/parentpage/subpage"
      }
    ]
  },
  "node": {
    "id": "PageTree-parentpage/subpage-id-bc8cec01-3f85-47d2-aec9-2e3ddc76df32",
    "name": "Subpage",
    "pathRaw": "/parentpage/subpage/",
    "pathNoTrail": "/parentpage/subpage",
    "isparentpage": false,
    "children": []
  }
}

:mortar_board: Install

Just use npm install @dream-bit-de/gatsby-plugin-better-page-tree or yarn install @dream-bit-de/gatsby-plugin-better-page-tree, it’s your choice. After that you have to modify your gatsby-config.js:

module.exports = {
  siteMetadata: {
    title: `Your Super Gatsby Site!`,
    description: `I love Gatsby!`,
    author: `Community,`,
    siteUrl: `https://www.my-gatsby-site-yeeehaaaw.com/`
  },
  plugins: [
    // ... other plugins
    `@dream-bit-de/gatsby-plugin-better-page-tree`
  ]
};

:tada: Usage

To use this for example in a sidebar you have to use it like this:

sidebar.js:

import React from 'react';
import { Link, useStaticQuery, graphql } from 'gatsby';

function Sidebar() {
  const Pages = useStaticQuery(graphql`
    query {
      allPageTree {
        edges {
          node {
            id
            name
            pathRaw
            pathNoTrail
            isRootPage
            children {
              id
              ... on PageTree {
                id
                name
                pathRaw
                pathNoTrail
              }
            }
          }
        }
      }
    }
  `);
  const { nodes } = Pages.allSitePage;

return (
     {nodes.map((n) => (
     <ul key={`sidebar-${n.id}`}>
      <li>
       <Link to={n.pathRaw}>
        <span>{n.name}</span>
        {
         n.children && n.children.length > 0 ? (
         {nodes.map((n) => (
          <ul key={`sidebar-${n.id}`}>
            <li>
              <Link to={n.pathRaw}>
                <span>{n.name}</span> 
              </Link>
            </li>
          </ul>
         ) : null
        }
       </Link>
      </li>
     </ul>
     ))}
);

That’s it!

Be aware that the query will give you all pages in the first place! You have to make sure that no duplicates will show up in your sidebar, if that is what you need.

:collision: Configuration

TBD!

:star: contributing

You want to help us, and join the Dream-bit Community? Great! Please make sure to check out and understand what is written in the following files:

  • CODE-OF-CONDUCT.md
  • CONTRIBUTING.md

As well as the gatsby-plugin docs:

:blush: About Dream-bit

At dream-bit dreams become software! We encourage people to do good things with software and bring humanity forward. You can be a part of us by contributing or joining the community at https://dream-bit.de

Develop software with your :heart: as your :brain:.