Plugin surface: let a plugin add a dashboard widget #1102

New issue

Closed

opened 2026-10-30 21:25:19 +00:00 by tiagoagueda · 0 comments

tiagoagueda commented

2026-10-30 21:25:19 +00:00

Owner

The dashboard is a grid of widgets (#125, closed), and a plugin cannot add one. plugins/api.py says what a widget is handed is deliberately not on the surface yet. This asks for that decision.

What exists today

Built-in widgets in applications/widgets.py, jobs/widgets.py and core/widgets_builtin.py.
plugins/api.py: "What a dashboard widget is handed (#125) is deliberately not here yet."
Plugins that would use one: postulo-imap (suggestions waiting), postulo-francetravail (the next declaration date), postulo-dav (the last sync).

What would change

A widget contract on the plugin surface: a name, a size, a template, and a function handed the user that returns a context.
postulo.plugins.testing checks it, as it checks the rest of the surface.

Decisions

What a widget is handed. Recommended: the user and the plugin's own connection, never a queryset; it reads through the surface's helpers, which are scoped already.
Caching. Recommended: as for built-in widgets.

Checked against main at daee30b15 (2026-10-30). From the status review and feature suggestions of 2026-10-30.

The dashboard is a grid of widgets (#125, closed), and a plugin cannot add one. `plugins/api.py` says what a widget is handed is deliberately not on the surface yet. This asks for that decision. ## What exists today - Built-in widgets in `applications/widgets.py`, `jobs/widgets.py` and `core/widgets_builtin.py`. - `plugins/api.py`: "What a dashboard widget is handed (#125) is deliberately not here yet." - Plugins that would use one: postulo-imap (suggestions waiting), postulo-francetravail (the next declaration date), postulo-dav (the last sync). ## What would change - A widget contract on the plugin surface: a name, a size, a template, and a function handed the user that returns a context. - `postulo.plugins.testing` checks it, as it checks the rest of the surface. ## Decisions - **What a widget is handed.** Recommended: the user and the plugin's own connection, never a queryset; it reads through the surface's helpers, which are scoped already. - **Caching.** Recommended: as for built-in widgets. Checked against `main` at `daee30b15` (2026-10-30). From the status review and feature suggestions of 2026-10-30.

tiagoagueda added this to the 0.6.0 milestone

2026-10-30 21:25:19 +00:00

tiagoagueda added the

enhancement

label

2026-10-30 21:25:19 +00:00

tiagoagueda referenced this issue from a pull request that will close it,

2026-11-11 22:58:35 +00:00

Let a plugin add a widget to the dashboard #1236

tiagoagueda referenced this issue from a commit

2026-11-11 22:58:35 +00:00

Let a plugin add a widget to the dashboard