Helper functions for basic structure organization

[mitchuman]

I've set up the following helper functions that I use in every project to quickly organize documents to singletons, lists and groups.

(I've updated this now to work with v3, where S is passed down as an argument.)

It would be nice to have similar helper utilities built into or provided by default.

Example implementation:

const AllDocuments = S.documentTypeListItems()
  .filter(item => ![
    'site',
    'header', 'footer',
    'page',
    'blogPg', 'blogCategory', 'article',
    'clinicalStudy',
  ].includes(item.getId()))

export default () =>
  S.list()
    .title('Content')
    .items([
      group('Site settings', [
        singleton('Site', 'site').icon(BsInfoCircleFill),
        singleton('Header', 'header').icon(RiLayoutTop2Line),
        singleton('Footer', 'footer').icon(RiLayoutBottom2Line),
      ]).icon(BsInfoCircleFill),

      list('Pages', 'page'),

      group('Blog', [
        list('Blog pages', 'blogPg'),
        list('Categories', 'blogCategory'),
        list('Articles', 'article'),
      ]).icon(FaPenAlt),

      list('Clinical Studies', 'clinicalStudy'),

      ...AllDocuments,
    ])

[legowhales]

Hey, I see that you reverted back to not passing S down as an argument. How does it work in v3 for you?
I have similar helpers, and I was curious if I had to change them for v3 :-).

Thank's for sharing your helper functions btw!

[mitchuman]

I've reverted back since I was only trying out v3 temporarily—the previous version with S being passed as an argument should still work.

[JanneHelewaut]

Do you have an example of the S you are passing down.
I keep running into issues that the structure-builder wants parts defined, and I can't figure out how I can make it work!

Thank you!

[mitchuman]

The current version is intended for v2. For v3, take a look at the previous revision here where it's basically being passed from the parent (in my structure.js or the desk structure config file).

Note: make sure to remove the import statement for S.