kopia lustrzana https://github.com/simonw/datasette
extra_body_script module support, closes #1187
Simon Willison
rodzic
fa0c3777b8
commit
c38c42948c
|
|
@ -781,7 +781,13 @@ class Datasette:
|
|||
datasette=self,
|
||||
):
|
||||
extra_script = await await_me_maybe(extra_script)
|
||||
body_scripts.append(Markup(extra_script))
|
||||
if isinstance(extra_script, dict):
|
||||
script = extra_script["script"]
|
||||
module = bool(extra_script.get("module"))
|
||||
else:
|
||||
script = extra_script
|
||||
module = False
|
||||
body_scripts.append({"script": Markup(script), "module": module})
|
||||
|
||||
extra_template_vars = {}
|
||||
# pylint: disable=no-member
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@
|
|||
{% include "_close_open_menus.html" %}
|
||||
|
||||
{% for body_script in body_scripts %}
|
||||
<script>{{ body_script }}</script>
|
||||
<script{% if body_script.module %} type="module"{% endif %}>{{ body_script.script }}</script>
|
||||
{% endfor %}
|
||||
|
||||
{% if select_templates %}<!-- Templates considered: {{ select_templates|join(", ") }} -->{% endif %}
|
||||
|
|
|
|||
|
|
@ -168,7 +168,7 @@ Examples: `datasette-search-all <https://github.com/simonw/datasette-search-all>
|
|||
extra_css_urls(template, database, table, columns, view_name, request, datasette)
|
||||
---------------------------------------------------------------------------------
|
||||
|
||||
Same arguments as :ref:`extra_template_vars(...) <plugin_hook_extra_template_vars>`
|
||||
This takes the same arguments as :ref:`extra_template_vars(...) <plugin_hook_extra_template_vars>`
|
||||
|
||||
Return a list of extra CSS URLs that should be included on the page. These can
|
||||
take advantage of the CSS class hooks described in :ref:`customization`.
|
||||
|
|
@ -217,7 +217,7 @@ Examples: `datasette-cluster-map <https://github.com/simonw/datasette-cluster-ma
|
|||
extra_js_urls(template, database, table, columns, view_name, request, datasette)
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Same arguments as :ref:`extra_template_vars(...) <plugin_hook_extra_template_vars>`
|
||||
This takes the same arguments as :ref:`extra_template_vars(...) <plugin_hook_extra_template_vars>`
|
||||
|
||||
This works in the same way as ``extra_css_urls()`` but for JavaScript. You can
|
||||
return a list of URLs, a list of dictionaries or an awaitable function that returns those things:
|
||||
|
|
@ -264,15 +264,30 @@ extra_body_script(template, database, table, columns, view_name, request, datase
|
|||
|
||||
Extra JavaScript to be added to a ``<script>`` block at the end of the ``<body>`` element on the page.
|
||||
|
||||
Same arguments as :ref:`extra_template_vars(...) <plugin_hook_extra_template_vars>`
|
||||
This takes the same arguments as :ref:`extra_template_vars(...) <plugin_hook_extra_template_vars>`
|
||||
|
||||
The ``template``, ``database``, ``table`` and ``view_name`` options can be used to return different code depending on which template is being rendered and which database or table are being processed.
|
||||
|
||||
The ``datasette`` instance is provided primarily so that you can consult any plugin configuration options that may have been set, using the ``datasette.plugin_config(plugin_name)`` method documented above.
|
||||
|
||||
The string that you return from this function will be treated as "safe" for inclusion in a ``<script>`` block directly in the page, so it is up to you to apply any necessary escaping.
|
||||
This function can return a string containing JavaScript, or a dictionary as described below, or a function or awaitable function that returns a string or dictionary.
|
||||
|
||||
You can also return an awaitable function that returns a string.
|
||||
Use a dictionary if you want to specify that the code should be placed in a ``<script type="module">...</script>`` element:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@hookimpl
|
||||
def extra_body_script():
|
||||
return {
|
||||
"module": True,
|
||||
"script": "console.log('Your JavaScript goes here...')"
|
||||
}
|
||||
|
||||
This will add the following to the end of your page:
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<script type="module">console.log('Your JavaScript goes here...')</script>
|
||||
|
||||
Example: `datasette-cluster-map <https://github.com/simonw/datasette-cluster-map>`_
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ def extra_body_script(
|
|||
template, database, table, view_name, columns, request, datasette
|
||||
):
|
||||
async def inner():
|
||||
return "var extra_body_script = {};".format(
|
||||
script = "var extra_body_script = {};".format(
|
||||
json.dumps(
|
||||
{
|
||||
"template": template,
|
||||
|
|
@ -90,6 +90,7 @@ def extra_body_script(
|
|||
}
|
||||
)
|
||||
)
|
||||
return {"script": script, "module": True}
|
||||
|
||||
return inner
|
||||
|
||||
|
|
|
|||
|
|
@ -288,7 +288,7 @@ def test_plugin_config_file(app_client):
|
|||
],
|
||||
)
|
||||
def test_hook_extra_body_script(app_client, path, expected_extra_body_script):
|
||||
r = re.compile(r"<script>var extra_body_script = (.*?);</script>")
|
||||
r = re.compile(r"<script type=\"module\">var extra_body_script = (.*?);</script>")
|
||||
json_data = r.search(app_client.get(path).text).group(1)
|
||||
actual_data = json.loads(json_data)
|
||||
assert expected_extra_body_script == actual_data
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue