Core components for webviz-config
Project description
Webviz core components
webviz_core_components
is a Dash component library for use in webviz
. A storybook showing all available components is available at https://equinor.github.io/webviz-core-components/storybook-static.
You can quickly get started with:
- Run
pip install webviz-core-components
- Run
python usage.py
- Visit http://localhost:8050 in your web browser
How to contribute
Install dependencies
If you want to build and develop yourself, you should fork + clone the repository, and then:
- Install npm packages.
npm ci --ignore-scripts --prefix ./react
- Install python packages required to build components.
pip install .[dependencies] pip install dash[dev]
- Install the python packages for testing.
The second of these commands appears to be necessary as long as thispip install .[tests] pip install dash[testing]
pip
issue is open.
Write component code in react/src/lib/components/<ComponentName>/<ComponentName>.tsx
-
Have a look at other components to see how the directory and file structure looks like.
-
The demo app is in
react/src/demo
and is where you will import an example of your component. To start the existing demo app, runnpm start --prefix ./react
. -
To test your code in a Python environment:
- Build your code
npm run build --prefix ./react
- Install the Python pacakge in development mode (if not already done and
assuming you are using a virtual environment):
pip install -e .
- Create a new example in
examples/
which uses your new component.
- Build your code
-
Write tests for your component.
- Python
- Python tests exist in
tests/
. Take a look at them to see how to write tests using the Dash test framework. - Run the tests with
pytest tests
.
- Python tests exist in
- JavaScript
- JavaScript tests exist in
react/tests
. Take a look at them to see how to write tests using the Jest test framework.
- JavaScript tests exist in
- Python
-
Add custom styles to your component by putting your custom CSS files into your distribution folder (
webviz_core_components
).- Make sure that they are referenced in
MANIFEST.in
so that they get properly included when you're ready to publish your component. - Make sure the stylesheets are added to the
_css_dist
dict inwebviz_core_components/__init__.py
so dash will serve them automatically when the component suite is requested. - You can also include stylesheets directly in your component by adding the stylesheet to your component's directory and importing it via
import "./<ComponentName>.css
. Make sure that the class names in your stylesheet are starting with your component's name and two underscores:.MyComponent__MyClassName
.
- Make sure that they are referenced in
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for webviz_core_components-0.6.0a6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cf0b1915d117310a423e14e51fe3db17223827092861ee1afa94c261d5a97bd |
|
MD5 | 39fa51005d2b86cf68bb563ecfc6a4b7 |
|
BLAKE2b-256 | 48fb406b1f47c98d1039abbcd79b9d76176be68fb3061e29dcc50e2299ef999f |
Hashes for webviz_core_components-0.6.0a6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61cbb25ae04f3798491aeff2d21bf72357e66400c4f289e3871f9869e5196777 |
|
MD5 | 76734536e317c03f4d5ef2dc2e01f3af |
|
BLAKE2b-256 | 7e22cdf5a036b282e8974a08b43dfe3ec3f25c1a4c6522462852bc67c40c0e8e |