github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Make request available to menu plugin hooks, closes #1371

Browse source
This commit is contained in:
Simon Willison 2021-06-09 21:45:24 -07:00
commit d23a267138
8 changed files with 44 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/plugin_hooks.rst
View file

@ -1015,8 +1015,8 @@ The function can alternatively return an awaitable function if it needs to make
.. _plugin_hook_menu_links:
menu_links(datasette, actor)
----------------------------
menu_links(datasette, actor, request)
-------------------------------------
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``, or to execute SQL queries.
@ -1024,6 +1024,9 @@ menu_links(datasette, actor)
``actor`` - dictionary or None
The currently authenticated :ref:`actor <authentication_actor>`.
``request`` - object or None
The current HTTP :ref:`internals_request`. This can be ``None`` if the request object is not available.
This hook allows additional items to be included in the menu displayed by Datasette's top right menu icon.
The hook should return a list of ``{"href": "...", "label": "..."}`` menu items. These will be added to the menu.
@ -1045,11 +1048,10 @@ This example adds a new menu item but only if the signed in user is ``"root"``:
Using :ref:`internals_datasette_urls` here ensures that links in the menu will take the :ref:`setting_base_url` setting into account.
.. _plugin_hook_table_actions:
table_actions(datasette, actor, database, table)
------------------------------------------------
table_actions(datasette, actor, database, table, request)
---------------------------------------------------------
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``, or to execute SQL queries.
@ -1063,6 +1065,9 @@ table_actions(datasette, actor, database, table)
``table`` - string
The name of the table.
``request`` - object
The current HTTP :ref:`internals_request`. This can be ``None`` if the request object is not available.
This hook allows table actions to be displayed in a menu accessed via an action icon at the top of the table page. It should return a list of ``{"href": "...", "label": "..."}`` menu items.
It can alternatively return an ``async def`` awaitable function which returns a list of menu items.
@ -1083,8 +1088,8 @@ This example adds a new table action if the signed in user is ``"root"``:
.. _plugin_hook_database_actions:
database_actions(datasette, actor, database)
--------------------------------------------
database_actions(datasette, actor, database, request)
-----------------------------------------------------
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``, or to execute SQL queries.
@ -1095,4 +1100,7 @@ database_actions(datasette, actor, database)
``database`` - string
The name of the database.
``request`` - object
The current HTTP :ref:`internals_request`.
This hook is similar to :ref:`plugin_hook_table_actions` but populates an actions menu on the database page.