Dash UI HTML component suite
Project description
dash-html-components
Vanilla HTML components for Dash
Install dependencies
-
Create a virtual env and activate.
$ virtualenv venv $ venv/bin/activateNote: venv\Scripts\activate for windows
-
Install python packages required to build components.
$ pip install -r dev-requirements.txt -
Generate components and install npm packages
$ npm install
Generating HTML Components
The components in src/components, as well as the export index in
src/index.js are programmatically generated from element definitions in
scripts/. To regenerate:
$ npm run generate-components
The list of attributes is regenerated by scraping the MDN HTML attribute reference.
Note: This step will have already been done for you when you ran npm install
Development
Testing your components in Dash
-
Watch for changes
$ npm run build:watch -
Install module locally (after every change)
# Generate metadata, and build the JavaScript bundle $ npm run install-local # Now you're done. For subsequent changes, if you've got `npm run build:watch` $ python setup.py install -
Run the dash layout you want to test
# Import dash_html_components to your layout, then run it: $ python my_dash_layout.py
Installing python package locally
Before publishing to PyPi, you can test installing the module locally:
# Install in `site-packages` on your machine
$ npm run install-local
Uninstalling python package locally
$ npm run uninstall-local
Contributing
See the contributing guide for guidelines on contributing to this project.
Create a production build and publish:
-
Build your code:
$ npm run build:all -
Create a Python tarball
$ python setup.py sdistThis distribution tarball will get generated in the
dist/folder -
Test your tarball by copying it into a new environment and installing it locally:
$ pip install dash-html-components-<new-version>.tar.gz -
If it works, then you can publish the component to NPM and PyPI:
- Publish on PyPI
$ twine upload dist/* - Cleanup the dist folder (optional)
$ rm -rf dist - Publish on NPM (Optional if chosen False in
publish_on_npm)
Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash servers the component library's CSS and JS from the remote unpkg CDN, so if you haven't published the component package to NPM you'll need to set the$ npm publishserve_locallyflags toTrue(unless you chooseFalseonpublish_on_npm). We will eventually makeserve_locally=Truethe default, follow our progress in this issue.
- Publish on PyPI
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
File details
Details for the file dash_html_components-0.14.0rc21.tar.gz.
File metadata
- Download URL: dash_html_components-0.14.0rc21.tar.gz
- Upload date:
- Size: 534.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.15.0 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c59f54d679e63047dfe702f8134ff3fc86292fc5476a77e712800392ca44a04f |
|
| MD5 | a65c84f0f52f9c6ce3ef2b9837066128 |
|
| BLAKE2b-256 | 8ea68dbd25e1410e58c6298d61e742fd5a5fd0f377e21709a14856af3f40cb4c |
