The doc's are missing the available Navigation menus properties
summercms opened this issue · 2 comments
summercms commented
Link to the doc's: https://octobercms.com/docs/plugin/registration#navigation-menus
October has the following default properties:
Array
(
[example] => Backend\Classes\SideMenuItem Object
(
[code] => example
[owner] => Acme.Plugin
[label] => acme.plugin::lang.menu.example.title
[icon] => fas fa-users-cog
[iconSvg] =>
[url] => https://www.example.com/acme/plugin/example
[counter] =>
[counterLabel] =>
[badge] =>
[order] => 30
[attributes] => Array
[group] => widgets
(
)
[permissions] => Array
(
[0] => acme.plugin.example
)
)
)
There is no mention of the default
properties in the doc's.
It would be nice to have a table in the doc's listing the default
properties available with descriptions on their usage for newbie's.
e.g.
property | description |
---|---|
icon | displays an icon in the navigation menu, choose an icon from October's default icon list found here: October Icons |
p.s. I got no idea what counter
, counterLabel
and badge
do and so I went to the doc's to check and couldn't find anything so ended up opening this issue.
bennothommo commented
@ayumi-cloud Would you be willing to create a PR documenting this? They're documented in the NavigationManager, so it'd just be a case of converting that documentation and formatting it for the docs.
LukeTowers commented
Closed by #468