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.
pip install .[tests]
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/demoand 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.inso that they get properly included when you're ready to publish your component. - Make sure the stylesheets are added to the
_css_distdict inwebviz_core_components/__init__.pyso 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
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file webviz_core_components-0.9.0.tar.gz.
File metadata
- Download URL: webviz_core_components-0.9.0.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d149a2ece4f12eb5136ccb4b8653ee7e251bfc492e9908cd4d1ca227199967d9
|
|
| MD5 |
d6e4edd4ebc2aaf2b20ee585fb237c65
|
|
| BLAKE2b-256 |
fbc8d2ad3d9e7845d2779151afe7df6315142f4f92b8476410c11b6e08c97e26
|
File details
Details for the file webviz_core_components-0.9.0-py3-none-any.whl.
File metadata
- Download URL: webviz_core_components-0.9.0-py3-none-any.whl
- Upload date:
- Size: 740.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
33cc24721edb16ab0fbee21edbfc1d11b51e7c974b3e67fca7beaf6a5098e046
|
|
| MD5 |
27110c6e2d44f3e1bf780d2f25201b95
|
|
| BLAKE2b-256 |
d58a8ef53f5fa87a392c63c74df1b2cb5576f02b48479cf501666767762530cb
|
