Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Custom Parameters section to docs #80

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added Custom Parameters section to docs #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,28 @@ You do have to register the entire class with flask-menu at runtime however.
MyEndpoint.register(bp)
register_flaskview(bp, MyEndpoint)

.. _custom_parametters:

Custom Parameters
=================

If you want to register a menu option with a custom url parameter (for example, for
url's that have an optional parameter) you can use the `endpoint_arguments_constructor`
to achieve this.

Here is an example:

.. code-block:: python

@bp_account.route('/list', defaults={'disabled': False})
@bp_account.route('/list/<disabled>')
@register_menu(bp_social, '.account.list', 'Social networks')
@register_menu(bp_social, '.account.list', 'Social networks (Disabled)', endpoint_arguments_constructor=lambda: {'disabled': True})
def list(disabled):
pass

This will register the same menu but with an optional URL parametter set to True.

.. _api:

API
Expand Down