mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
Code Issues Releases Wiki Activity

Document icon_name and classname for register_page_action_menu_item

Browse Source
This commit is contained in:
Matt Westcott 2020-07-17 17:58:00 +01:00 committed by Matt Westcott
parent 310ea2af35
commit c8a8689cee
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/hooks.rst
View File

@ -589,6 +589,8 @@ Hooks for customising the way users are directed through the process of creating
:label: the displayed text of the menu item :label: the displayed text of the menu item
:get_url: a method which returns a URL for the menu item to link to; by default, returns ``None`` which causes the menu item to behave as a form submit button instead :get_url: a method which returns a URL for the menu item to link to; by default, returns ``None`` which causes the menu item to behave as a form submit button instead
:name: value of the ``name`` attribute of the submit button, if no URL is specified :name: value of the ``name`` attribute of the submit button, if no URL is specified
:icon_name: icon to display against the menu item
:classname: a ``class`` attribute value to add to the button element
:is_shown: a method which returns a boolean indicating whether the menu item should be shown; by default, true except when editing a locked page :is_shown: a method which returns a boolean indicating whether the menu item should be shown; by default, true except when editing a locked page
:template: path to a template to render to produce the menu item HTML :template: path to a template to render to produce the menu item HTML
:get_context: a method that returns a context dictionary to pass to the template :get_context: a method that returns a context dictionary to pass to the template