id,node_id,number,state,locked,title,user,body,created_at,updated_at,closed_at,merged_at,merge_commit_sha,assignee,milestone,draft,head,base,author_association,repo,url,merged_by,auto_merge
1299206303,PR_kwDOBm6k_c5NcFCf,2052,closed,0,"feat: Javascript Plugin API (Custom panels, column menu items with JS actions)",9020979,"## Motivation

- Allow plugins that add data visualizations [`datasette-vega`](https://github.com/simonw/datasette-vega), [`datasette-leaflet`](https://github.com/simonw/datasette-leaflet), and [`datasette-nteract-data-explorer`](https://github.com/hydrosquall/datasette-nteract-data-explorer) to co-exist safely
- Standardize APIs / hooks to ease development for new JS plugin developers (better compat with datasette-lite) through standardized DOM selectors, methods for extending the existing Table UI. This has come up as a feature request several times (see research notes for examples)
- Discussion w/ @simonw about a general-purpose Datasette JS API

## Changes

Summary: Provide 2 new surface areas for Datasette JS plugin developers. See alpha [documentation](https://github.com/simonw/datasette/pull/2052#issuecomment-1510423051)

1. Custom column header items: <https://a.cl.ly/Kou97wJr>
2. Basic ""panels"" controlled by buttons: <https://a.cl.ly/rRugWobd>

### User Facing Changes

- Allow creating menu items under table header that triggers JS (instead of opening hrefs per the existing [menu_link](https://docs.datasette.io/en/stable/plugin_hooks.html#menu-links-datasette-actor-request) hook). Items can respond to any column metadata provided by the column header (e.g. label). The proof of concept plugins log data to the console, or copy the column name to clipboard.
- Allow plugins to register UI elements in a panel controller. The parent component handles switching the visibility of active plugins.
  - Because native button elements are used, the panel is keyboard-accessible - use tab / shift-tab to cycle through tab options, and `enter` to select.
  - There's room to improve the styling, but the focus of this PR is on the API rather than the UX.

### (plugin) Developer Facing Changes

- Dispatch a `datasette_init` [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent) when the `datasetteManager` is finished loading.
- Provide `manager.registerPlugin` API for adding new functionality that coordinates with Datasette lifecycle events.
- Provide a `manager.selectors` map of DOM elements that users may want to hook into.
  - Updated `table.js` to use refer to these to motivating keeping things in sync
- Allow plugins to register themselves with 2 hooks:
  - `makeColumnActions`: Add items to menu in table column headers. Users can provide a `label`, and either `href` or `onClick` with full access to the metadata for the clicked column (name, type, misc. booleans)
  - `makeAboveTablePanelConfigs`: Add items to the panel. Each panel has a unique ID (namespaced within that plugin), a render function, and a string label.

See [this file](https://github.com/simonw/datasette/blob/2d92b9328022d86505261bcdac419b6ed9cb2236/datasette/static/table-example-plugins.js) for example plugin usage.

###  Core Developer Facing Changes

- Modified `table.js` to make use of the `datasetteManager` API.
- Added example plugins to the `demos/plugins` folder, and stored the test js in the `statics/` folder

## Testing

For Datasette plugin developers, please see the [alpha-level documentation](https://github.com/simonw/datasette/pull/2052#issuecomment-1510423051) .

To run the examples:

```bash
datasette serve fixtures.db  --plugins-dir=demos/plugins/
```

Open local server: `http://127.0.0.1:8001/fixtures/facetable`

Open to all feedback on this PR, from API design to variable naming, to what additional hooks might be useful for the future.

My focus was more on the general shape of the API for developers, rather than on the UX of the test plugins.

## Design notes

- The manager tab panel could be a separate plugin if the implementation is too custom.
- The `makeColumnHeaderItems` benefits from hooking into the logic of `table.js`
- I wanted to offer this to the Datasette core, since the `datasette-manager` would be more powerful if it were connected to lifecycle and JS events that are part of the existing table.js.
- Non-goals:
  - Dependency management (for now) - there's no ""build"" step, we don't know when new plugins will be added. While there are some valid use cases (for example, allow multiple plugins to wait for a global leaflet object to be loaded), I don't see enough use-cases to justify doing this yet.
  - Enabling single-page-app features - for now, most datasette actions lead to a new page being loaded. SPA development offers some benefits (no page jumping after clicking on a link), but also complexity that doesn't need to be in the core Datasette project.

## Research Notes

- Relocated to a [comment](https://github.com/simonw/datasette/pull/2052#issuecomment-1510423215), as this isn't required to review when evaluating the plugin. Including it just for those who are curious.
",2023-04-02T20:23:44Z,2023-10-14T17:49:03Z,2023-10-13T00:00:27Z,2023-10-13T00:00:27Z,452a587e236ef642cbc6ae345b58767ea8420cb5,9599,,0,8ae479c4775125f59f2367626fd32f3229c1135d,0f7192b6154edb576c41b55bd3f2a3f53e5f436a,CONTRIBUTOR,107914493,https://github.com/simonw/datasette/pull/2052,,
1429431050,PR_kwDOBm6k_c5VM2MK,2099,closed,0,Bump black from 23.3.0 to 23.7.0,49699333,"Bumps [black](https://github.com/psf/black) from 23.3.0 to 23.7.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href=""https://github.com/psf/black/releases"">black's releases</a>.</em></p>
<blockquote>
<h2>23.7.0</h2>
<h3>Highlights</h3>
<ul>
<li>Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
supported until further notice (<a href=""https://redirect.github.com/psf/black/issues/3765"">#3765</a>)</li>
</ul>
<h3>Stable style</h3>
<ul>
<li>Fix a bug where an illegal trailing comma was added to return type annotations using
PEP 604 unions (<a href=""https://redirect.github.com/psf/black/issues/3735"">#3735</a>)</li>
<li>Fix several bugs and crashes where comments in stub files were removed or mishandled
under some circumstances (<a href=""https://redirect.github.com/psf/black/issues/3745"">#3745</a>)</li>
<li>Fix a crash with multi-line magic comments like <code>type: ignore</code> within parentheses
(<a href=""https://redirect.github.com/psf/black/issues/3740"">#3740</a>)</li>
<li>Fix error in AST validation when <em>Black</em> removes trailing whitespace in a type comment
(<a href=""https://redirect.github.com/psf/black/issues/3773"">#3773</a>)</li>
</ul>
<h3>Preview style</h3>
<ul>
<li>Implicitly concatenated strings used as function args are no longer wrapped inside
parentheses (<a href=""https://redirect.github.com/psf/black/issues/3640"">#3640</a>)</li>
<li>Remove blank lines between a class definition and its docstring (<a href=""https://redirect.github.com/psf/black/issues/3692"">#3692</a>)</li>
</ul>
<h3>Configuration</h3>
<ul>
<li>The <code>--workers</code> argument to <em>Black</em> can now be specified via the <code>BLACK_NUM_WORKERS</code>
environment variable (<a href=""https://redirect.github.com/psf/black/issues/3743"">#3743</a>)</li>
<li><code>.pytest_cache</code>, <code>.ruff_cache</code> and <code>.vscode</code> are now excluded by default (<a href=""https://redirect.github.com/psf/black/issues/3691"">#3691</a>)</li>
<li>Fix <em>Black</em> not honouring <code>pyproject.toml</code> settings when running <code>--stdin-filename</code>
and the <code>pyproject.toml</code> found isn't in the current working directory (<a href=""https://redirect.github.com/psf/black/issues/3719"">#3719</a>)</li>
<li><em>Black</em> will now error if <code>exclude</code> and <code>extend-exclude</code> have invalid data types in
<code>pyproject.toml</code>, instead of silently doing the wrong thing (<a href=""https://redirect.github.com/psf/black/issues/3764"">#3764</a>)</li>
</ul>
<h3>Packaging</h3>
<ul>
<li>Upgrade mypyc from 0.991 to 1.3 (<a href=""https://redirect.github.com/psf/black/issues/3697"">#3697</a>)</li>
<li>Remove patching of Click that mitigated errors on Python 3.6 with <code>LANG=C</code> (<a href=""https://redirect.github.com/psf/black/issues/3768"">#3768</a>)</li>
</ul>
<h3>Parser</h3>
<ul>
<li>Add support for the new PEP 695 syntax in Python 3.12 (<a href=""https://redirect.github.com/psf/black/issues/3703"">#3703</a>)</li>
</ul>
<h3>Performance</h3>
<ul>
<li>Speed up <em>Black</em> significantly when the cache is full (<a href=""https://redirect.github.com/psf/black/issues/3751"">#3751</a>)</li>
<li>Avoid importing <code>IPython</code> in a case where we wouldn't need it (<a href=""https://redirect.github.com/psf/black/issues/3748"">#3748</a>)</li>
</ul>
<h3>Output</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href=""https://github.com/psf/black/blob/main/CHANGES.md"">black's changelog</a>.</em></p>
<blockquote>
<h2>23.7.0</h2>
<h3>Highlights</h3>
<ul>
<li>Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
supported until further notice (<a href=""https://redirect.github.com/psf/black/issues/3765"">#3765</a>)</li>
</ul>
<h3>Stable style</h3>
<ul>
<li>Fix a bug where an illegal trailing comma was added to return type annotations using
PEP 604 unions (<a href=""https://redirect.github.com/psf/black/issues/3735"">#3735</a>)</li>
<li>Fix several bugs and crashes where comments in stub files were removed or mishandled
under some circumstances (<a href=""https://redirect.github.com/psf/black/issues/3745"">#3745</a>)</li>
<li>Fix a crash with multi-line magic comments like <code>type: ignore</code> within parentheses
(<a href=""https://redirect.github.com/psf/black/issues/3740"">#3740</a>)</li>
<li>Fix error in AST validation when <em>Black</em> removes trailing whitespace in a type comment
(<a href=""https://redirect.github.com/psf/black/issues/3773"">#3773</a>)</li>
</ul>
<h3>Preview style</h3>
<ul>
<li>Implicitly concatenated strings used as function args are no longer wrapped inside
parentheses (<a href=""https://redirect.github.com/psf/black/issues/3640"">#3640</a>)</li>
<li>Remove blank lines between a class definition and its docstring (<a href=""https://redirect.github.com/psf/black/issues/3692"">#3692</a>)</li>
</ul>
<h3>Configuration</h3>
<ul>
<li>The <code>--workers</code> argument to <em>Black</em> can now be specified via the <code>BLACK_NUM_WORKERS</code>
environment variable (<a href=""https://redirect.github.com/psf/black/issues/3743"">#3743</a>)</li>
<li><code>.pytest_cache</code>, <code>.ruff_cache</code> and <code>.vscode</code> are now excluded by default (<a href=""https://redirect.github.com/psf/black/issues/3691"">#3691</a>)</li>
<li>Fix <em>Black</em> not honouring <code>pyproject.toml</code> settings when running <code>--stdin-filename</code>
and the <code>pyproject.toml</code> found isn't in the current working directory (<a href=""https://redirect.github.com/psf/black/issues/3719"">#3719</a>)</li>
<li><em>Black</em> will now error if <code>exclude</code> and <code>extend-exclude</code> have invalid data types in
<code>pyproject.toml</code>, instead of silently doing the wrong thing (<a href=""https://redirect.github.com/psf/black/issues/3764"">#3764</a>)</li>
</ul>
<h3>Packaging</h3>
<ul>
<li>Upgrade mypyc from 0.991 to 1.3 (<a href=""https://redirect.github.com/psf/black/issues/3697"">#3697</a>)</li>
<li>Remove patching of Click that mitigated errors on Python 3.6 with <code>LANG=C</code> (<a href=""https://redirect.github.com/psf/black/issues/3768"">#3768</a>)</li>
</ul>
<h3>Parser</h3>
<ul>
<li>Add support for the new PEP 695 syntax in Python 3.12 (<a href=""https://redirect.github.com/psf/black/issues/3703"">#3703</a>)</li>
</ul>
<h3>Performance</h3>
<ul>
<li>Speed up <em>Black</em> significantly when the cache is full (<a href=""https://redirect.github.com/psf/black/issues/3751"">#3751</a>)</li>
<li>Avoid importing <code>IPython</code> in a case where we wouldn't need it (<a href=""https://redirect.github.com/psf/black/issues/3748"">#3748</a>)</li>
</ul>
<h3>Output</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href=""https://github.com/psf/black/commit/193ee766ca496871f93621d6b58d57a6564ff81b""><code>193ee76</code></a> Prepare release 23.7.0 (<a href=""https://redirect.github.com/psf/black/issues/3776"">#3776</a>)</li>
<li><a href=""https://github.com/psf/black/commit/38723bb7787d50f8751fad2eaa48b52c9e94c18d""><code>38723bb</code></a> Unpin pytest-xdist (<a href=""https://redirect.github.com/psf/black/issues/3772"">#3772</a>)</li>
<li><a href=""https://github.com/psf/black/commit/138769aa27d6bd86507a0cd98d9a5bf8f63a8e99""><code>138769a</code></a> Disable coverage on pypy tests (<a href=""https://redirect.github.com/psf/black/issues/3777"">#3777</a>)</li>
<li><a href=""https://github.com/psf/black/commit/ad3724b7ffc01d8152c97fe7f4dcf35220f21a8e""><code>ad3724b</code></a> Upgrade to latest mypy (<a href=""https://redirect.github.com/psf/black/issues/3775"">#3775</a>)</li>
<li><a href=""https://github.com/psf/black/commit/b8e2ec728cc09d0f00829a9cffcb54da3efa5760""><code>b8e2ec7</code></a> Fix crash on type comment with trailing space (<a href=""https://redirect.github.com/psf/black/issues/3773"">#3773</a>)</li>
<li><a href=""https://github.com/psf/black/commit/257d392217974a76231e306133288748c7b70786""><code>257d392</code></a> Fix removed comments in stub files (<a href=""https://redirect.github.com/psf/black/issues/3745"">#3745</a>)</li>
<li><a href=""https://github.com/psf/black/commit/2593af2c5d211b58e28f7c1472f1f67e6783216a""><code>2593af2</code></a> Improve performance by skipping unnecessary normalisation (<a href=""https://redirect.github.com/psf/black/issues/3751"">#3751</a>)</li>
<li><a href=""https://github.com/psf/black/commit/f3b50e466969f9142393ec32a4b2a383ffbe5f23""><code>f3b50e4</code></a> Add CITATION.cff file (<a href=""https://redirect.github.com/psf/black/issues/3723"">#3723</a>)</li>
<li><a href=""https://github.com/psf/black/commit/0b4d7d55f78913be9e0a3738681ef3aafd5d9a5a""><code>0b4d7d5</code></a> Run pyupgrade on blib2to3 and src (<a href=""https://redirect.github.com/psf/black/issues/3771"">#3771</a>)</li>
<li><a href=""https://github.com/psf/black/commit/114e8357e65384e17baaa3c31aa528371e15679b""><code>114e835</code></a> Remove click patch (<a href=""https://redirect.github.com/psf/black/issues/3768"">#3768</a>)</li>
<li>Additional commits viewable in <a href=""https://github.com/psf/black/compare/23.3.0...23.7.0"">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=23.3.0&new-version=23.7.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

<!-- readthedocs-preview datasette start -->
----
:books: Documentation preview :books:: https://datasette--2099.org.readthedocs.build/en/2099/

<!-- readthedocs-preview datasette end -->",2023-07-11T13:05:53Z,2023-07-21T21:19:25Z,2023-07-21T21:19:24Z,2023-07-21T21:19:24Z,3a51ca901427ac93b0ed0638fd1f82fb647a299a,,,0,2761e4db2429e5d5588d8d1e54f30a6aafa7456b,0f7192b6154edb576c41b55bd3f2a3f53e5f436a,CONTRIBUTOR,107914493,https://github.com/simonw/datasette/pull/2099,,