cylc-ui icon indicating copy to clipboard operation
cylc-ui copied to clipboard

plugable views

Open oliver-sanders opened this issue 1 year ago • 0 comments

The Cylc "views" (i.e. tree, table, graph, etc) all fit into the cylc-ui application model, making use of the shared subscription client, data store, directives, etc.

We should aim to make views more plugable to make writing them easier. At present the interface between the UI and the views is too unstable to expose properly, however, this should settle down in the near future.

A view should be a bundle containing:

  • The root view component.
  • All subscriptions/queries required.
  • Metadata including the view's name and icon.
  • Configurations with defaults.

Ideally we should be able to develop views outside of the cylc-ui project allowing for greater community engagement and site-specific views. Note, they should be pip installable e.g. pip install cylc-flow cylc-uiserver cylc-matrix-view, this is largely a UIS side but does impose import issues at the UI end.

oliver-sanders avatar Jun 12 '23 10:06 oliver-sanders