-
Notifications
You must be signed in to change notification settings - Fork 14
Creating a Bundle
Please Note: This document is still a work in progress!
A simple bundle utilises the generic bundle, providing list, add, edit, and view routes based on a defined schema.
An example of the generic bundle in use is the section bundle provided with control.
Provides an object describing key parts of the bundle:
- name
- version
- description
- adminNav - An array of objects defining the administration system navigation for the bundle
- label - The link name for the bundle
- url - The URL that the name links to
- section - xxx
- permission - Object defining the ACL for the link
- resource - Name of the resource required to display/access the link
- action - Action level required to display/access the link
- items - Subnavigation items that are shown beneath the main link
- label - The link name for the subnavigation item
- url - The URL that the subnavigation item links to
- permission - Object defining the ACL for the link (as above)
- initialize - An array of functions that get run when the bundle is initialized
Provides a function that creates the routes for the bundle:
...
WARNING: If you are using the article bundle, make sure your simple bundle is placed BEFORE article in server.js, otherwise the article bundle's catch-all routing will cause the index route of your bundle to fail.
A complex bundle is required for administration sections that provide extended views, or more in depth functionality than the basic views in the generic bundle provide.
...