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.0a3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a92019f88cb5401a3debc0e8acc65f3c41783aa1e1c45367d48299af9709633b |
|
MD5 | c3fe38f8f9984723a5f1cb2cfb0cfada |
|
BLAKE2b-256 | cc4f8930409f1ed86909ae664aea6fe7df8755f145a6ced52984ee541a3bb880 |
Hashes for webviz_core_components-0.6.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ce6565a6278e14fe31f59fdf9a457d6827774d2cc46523b3c74116efa23ac76 |
|
MD5 | 0784def201b3d7da0471a0d5fb2a758b |
|
BLAKE2b-256 | c96fe5cb7a33e63f7ea6cbb7e97e1756cde10cc4280b25e268256f44cd5ec7fc |