simonw / simonw/datasette

Documented HTML hooks for JavaScript plugin authors

Open
#987 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation javascript plugins
Dominant language
Python
Stars
11.5k
Forks
904
Avg merge
4d 17h
Merged PRs (30d)
18

Description

In #981 I added data-column= attributes to the <th> on the table page. These should become part of Datasette's documented API so JavaScript plugin authors can use them to derive things about the tables shown on a page (`datasette-cluster-map uses them as-of https://github.com/simonw/datasette-cluster-map/issues/18).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issue #981 and inspecting the existing data-column attributes on the table page. Document these attributes as part of Datasette's API for JavaScript plugin authors, including how they can be used to derive information about displayed tables; the documentation is done when plugin authors can find and understand this hook.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.