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

[simonw]

Refs:

• Ability for plugins to collaborate when adding extra HTML to blocks in default templates #1191

TODO:

• top_homepage
• top_database
• top_table
• top_row
• top_query
• top_canned_query

---

📚 Documentation preview 📚: https://datasette--2238.org.readthedocs.build/en/2238/

[simonw]

Preview documentation: https://datasette--2238.org.readthedocs.build/en/2238/plugin_hooks.html#top-homepage-datasette-request

[simonw]

Should these be wrapped in a <div> with a known ID or class I wonder? HTML currently looks like this:

datasette/datasette/templates/index.html

Lines 1 to 12 in 0c814ce

	{% extends "base.html" %}
	{% block title %}{{ metadata.title or "Datasette" }}: {% for database in databases %}{{ database.name }}{% if not loop.last %}, {% endif %}{% endfor %}{% endblock %}
	{% block body_class %}index{% endblock %}
	{% block content %}
	<h1>{{ metadata.title or "Datasette" }}{% if private %} 🔒{% endif %}</h1>
	{{ top_homepage() }}
	{% block description_source_license %}{% include "_description_source_license.html" %}{% endblock %}

[simonw]

Also am I right putting these above the description/metadata section, or should they be below it?

I think above. Conceptually that information is strongly related to the table that is being displayed.

I'm going to standardize on having these blocks appear directly below the <h1>.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7a5adb5) 92.33% compared to head (eb13117) 92.67%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2238      +/-   ##
==========================================
+ Coverage   92.33%   92.67%   +0.33%     
==========================================
  Files          41       40       -1     
  Lines        6134     6116      -18     
==========================================
+ Hits         5664     5668       +4     
+ Misses        470      448      -22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[simonw]

I thought about maybe using a {{ slot("top_homepage") }} template function instead of the {{ top_homepage() }} thing that gets injected in to the context, but different slots take different arguments (e.g. the row one takes top_row(datasette, request, database, table, row)) so actually it's better to feed them in from the view function after all.