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

Template slot family of plugin hooks - top_homepage() and others

Browse source 
New plugin hooks:

top_homepage
top_database
top_table
top_row
top_query
top_canned_query

New datasette.utils.make_slot_function()

Closes #1191
This commit is contained in:
Simon Willison 2024-01-30 19:54:03 -08:00 • committed by GitHub
commit c3caf36af7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 324 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

119
docs/plugin_hooks.rst
View file

@ -1641,3 +1641,122 @@ This hook is responsible for returning a dictionary corresponding to Datasette :
return metadata
Example: `datasette-remote-metadata plugin <https://datasette.io/plugins/datasette-remote-metadata>`__
.. _plugin_hook_slots:
Template slots
--------------
The following set of plugin hooks can be used to return extra HTML content that will be inserted into the corresponding page, directly below the ``<h1>`` heading.
Multiple plugins can contribute content here. The order in which it is displayed can be controlled using Pluggy's `call time order options <https://pluggy.readthedocs.io/en/stable/#call-time-order>`__.
Each of these plugin hooks can return either a string or an awaitable function that returns a string.
.. _plugin_hook_top_homepage:
top_homepage(datasette, request)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``.
``request`` - :ref:`internals_request`
The current HTTP request.
Returns HTML to be displayed at the top of the Datasette homepage.
.. _plugin_hook_top_database:
top_database(datasette, request, database)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``.
``request`` - :ref:`internals_request`
The current HTTP request.
``database`` - string
The name of the database.
Returns HTML to be displayed at the top of the database page.
.. _plugin_hook_top_table:
top_table(datasette, request, database, table)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``.
``request`` - :ref:`internals_request`
The current HTTP request.
``database`` - string
The name of the database.
``table`` - string
The name of the table.
Returns HTML to be displayed at the top of the table page.
.. _plugin_hook_top_row:
top_row(datasette, request, database, table, row)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``.
``request`` - :ref:`internals_request`
The current HTTP request.
``database`` - string
The name of the database.
``table`` - string
The name of the table.
``row`` - ``sqlite.Row``
The SQLite row object being displayed.
Returns HTML to be displayed at the top of the row page.
.. _plugin_hook_top_query:
top_query(datasette, request, database, sql)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``.
``request`` - :ref:`internals_request`
The current HTTP request.
``database`` - string
The name of the database.
``sql`` - string
The SQL query.
Returns HTML to be displayed at the top of the query results page.
.. _plugin_hook_top_canned_query:
top_canned_query(datasette, request, database, query_name)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``datasette`` - :ref:`internals_datasette`
You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``.
``request`` - :ref:`internals_request`
The current HTTP request.
``database`` - string
The name of the database.
``query_name`` - string
The name of the canned query.
Returns HTML to be displayed at the top of the canned query page.