Add a menu item

Developer Experience
2

Full disclosure - the guide is not great and needs improving.

If you are going to contribute your change back to the core Xibo - then there are some processes to follow so that we can integrate your change smoothly. See Contributing to Xibo

If you are developing something for private use - the short answer is that you need to create a theme, which provides an alternative authed.twig in which you can add a new menu item. There is a theme guide here: http://xibo.org.uk/manual-tempel/en/advanced_theme.html

If you are doing that and your link is anything other than an external resource, you will most likely need to provide a route and Controller in order to implement your link. There are 2 ways to do that,

  • Develop in a library and include your controllers via composer
  • Use the /custom folder and code in the Xibo\Custom namespace to have your classes auto-loaded

In either case you will need to add routes via Middleware, which can be done in your web/settings.php file via the $middleware array.

I am doing some work on the user manual at present and will try to improve the article today

1 Like