[Bug] config items with children must have an empty `children: []` or the promise errors

[andrewmosby]

Currently an entry in the config file with the following structure will cause an error (and the page will not load). Note that this is the pattern set in the README.

{
  "title": "Buttons",
  "children": [
    {
      "title": "Primary Button",
      "url": "button-primary"
    },
    {
      "title": "Secondary Button",
      "url": "button-secondary"
    }
  ]
}

This is the error produced in the console: Uncaught (in promise) TypeError: e.item.children is undefined

Currently, the workaround is to add an empty children: [] line.

{
  "title": "Buttons",
  "children": [
    {
      "title": "Primary Button",
      "url": "button-primary",
      "children": []
    },
    {
      "title": "Secondary Button",
      "url": "button-secondary",
      "children": []
    }
  ]
}

Suggested action

• Confirm bug
• Update README w/ current preferred structure (if creating a fix is not quick)
• Create a fix so children: [] is not needed.

[ekfuhrmann]

Another way of handling children might be to use the url. We can create nestings simpling through use of the url and / rather than relying on an additional children: [] prop.

It could look like this:

// BEFORE
"nav": [
    {
      "title": "Buttons",
      "children": [
        {
          "title": "Primary Button",
          "url": "button-primary",
          "children": []
        },
        {
          "title": "Secondary Button",
          "url": "button-secondary",
          "children": []
        }
      ]
    },
]
  
// AFTER
"nav": [
    {
      "title": "Primary Button",
      "url": "buttons/button-primary",
    },
    {
      "title": "Secondary Button",
      "url": "buttons/button-secondary",
    },
]

There would need to be some thought around how to parse what the title should look like for titles with a space or special character such as a hyphen, but generally speaking it'd flatten the json a bit.

[andrewmosby]

@ekfuhrmann I believe this issue is "resolved" now that the json file is auto generated. Correct?

[ekfuhrmann]

No, unfortunately we still need to pass in "children": [], it's just included as part of the auto generated JSON. That automation is also only there for our Blueprint library at the moment. Other projects would still need to generate their own JSON and include that key.