@@ -5,8 +5,10 @@ server-side UI-contributions provided by an application contributor.
55
66## How Chartlets works
77
8- Users write the widgets in, e.g. Python, and a REST server implements three
9- endpoints to publish the widgets:
8+ The basic idea is that application contributors develop the
9+ UI-contributions in Python and a REST server developed by you, the
10+ application provider, implements three endpoints to publish the
11+ UI-contributions to a frontend application:
1012
1113- ` GET /contributions ` : Called once after application UI starts up.
1214 Returns an object whose keys are contribution points (e.g., "panels")
@@ -15,18 +17,19 @@ endpoints to publish the widgets:
1517 Called once for every contribution when it becomes visible in the UI.
1618 Returns the contribution's initial component tree.
1719- ` POST /callback ` :
18- Called when users interact with the component tree or on application
19- state changes. Returns an array of contribution changes where each
20- contribution change contains an array of actions to be applied to the
20+ Called when application users interact with the component tree or on
21+ application state changes. Returns an array of contribution changes where
22+ each contribution change contains an array of actions to be applied to the
2123 component tree.
2224
23- The following sequence diagram depicts how the library is supposed to
24- work. The top shows the JavaScript frontend that uses this library.
25- The bottom shows the lifeline of the backend REST server.
25+ The following sequence diagram depicts the framework in action.
26+ The top shows the frontend application that uses the Chartlets JavaScript
27+ library. The bottom shows the lifeline of the backend REST server that uses
28+ the Chartlets Python library.
2629
2730![ sequence.png] ( ../images/sequence.png )
2831
29- ## Backend integration
32+ ## REST server integration
3033
3134The Chartlets backend implementation is provided by the module
3235` chartlets.controllers ` of the Python package ` chartlets ` .
@@ -99,7 +102,7 @@ the controller implementations in `chartlets.controllers`.
99102
100103As an example, see [ ` app.py ` of the demo server] ( https://github.com/bcdev/chartlets/tree/main/chartlets.py/demo/server/app.py ) .
101104
102- ## Frontend integration
105+ ## Application UI integration
103106
104107The JavaScript package ` chartlets ` provides the types, actions, and hooks
105108to allow for supporting server-side UI contributions in your React
@@ -150,6 +153,6 @@ _Coming soon._
150153
151154_ Coming soon._
152155
153- ## Extend the framework
156+ ## Extending the framework
154157
155158_ Coming soon._
0 commit comments