File tree Expand file tree Collapse file tree 2 files changed +20
-9
lines changed
Expand file tree Collapse file tree 2 files changed +20
-9
lines changed Original file line number Diff line number Diff line change @@ -123,14 +123,24 @@ There is nothing more to be considered.
123123
124124### Configure the framework
125125
126- Before the framework can be used it must configured
127- using the ` initializeFramework ` function.
126+ To configure the framework and fetch the initial contributions from the
127+ server the ` initializeContributions ` function must be called once in your
128+ application. In the following example, the default plugins are used.
128129
129130``` TypeScript
130- import { initializeFramework } " charlets"
131+ import { initializeContributions } from " chartlets" ;
132+ import mui from " chartlets/plugins/mui" ;
133+ import vega from " chartlets/plugins/vega" ;
134+
135+ initializeContributions ({
136+ plugins: [mui (), vega ()],
137+ ...
138+ });
131139```
132140
133- _More coming soon._
141+ If you need to separate configuration and fetching configurations you can also
142+ pass the options to the ` configureFramework ` function and call
143+ ` initializeContributions ` without options.
134144
135145### Implement derived application state
136146
@@ -140,6 +150,6 @@ _Coming soon._
140150
141151_ Coming soon._
142152
143- ## Adding new components
153+ ## Extend the framework
144154
145155_ Coming soon._
Original file line number Diff line number Diff line change @@ -11,10 +11,11 @@ and a
1111
1212## Features
1313
14- - Enhance your React web application by UI-contributions programmed in Python
15- - Enhance your (Python) web API to serve server-side UI-contributions.
16- - Uses [ Material UI] ( https://mui.com/material-ui/ ) components and
17- [ Vega-Lite] ( https://vega.github.io/vega-lite/ ) charts.
14+ - Enhance your React web application by UI-contributions programmed in Python.
15+ - Enhance your Python REST server to publish server-side UI-contributions.
16+ - Support your favorite charting library or UI component library by plugins.
17+ - Use provided plugins for [ Vega-Lite] ( https://vega.github.io/vega-lite/ ) charts and [ Material UI] ( https://mui.com/material-ui/ )
18+ components.
1819
1920## Users
2021
You can’t perform that action at this time.
0 commit comments