Dash UI HTML component suite
Project description
# dash-html-components
Vanilla HTML components for Dash
## Dash
Go to this link to learn about [Dash][].
## Getting started
```sh
# Install dependencies
$ npm install
# Watch source for changes and build to `lib/`
$ npm start
```
## 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:
The list of attributes is regenerated by scraping the
[MDN HTML attribute reference][].
```sh
$ npm run generate-components
```
## Development
### Testing your components in Dash
1. Build development bundle to `lib/` and watch for changes
# Once this is started, you can just leave it running.
$ npm start
2. 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 start`
# running in a separate process, it's enough to just do:
$ python setup.py install
3. Run the dash layout you want to test
# Import dash_core_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:
```sh
# Install in `site-packages` on your machine
$ npm run install-local
```
## Uninstalling python package locally
```sh
$ npm run uninstall-local
```
## Publishing
For now, multiple steps are necessary for publishing to NPM and PyPi,
respectively. TODO:
[#5](https://github.com/plotly/dash-components-archetype/issues/5) will roll up
publishing steps into one workflow.
Ask @chriddyp to get NPM / PyPi package publishing accesss.
1. Preparing to publish to NPM
# Bump the package version
$ npm version major|minor|patch
# Push branch and tags to repo
$ git push --follow-tags
2. Preparing to publish to PyPi
# Bump the PyPi package to the same version
$ vi setup.py
# Commit to github
$ git add setup.py
$ git commit -m "Bump pypi package version to vx.x.x"
3. Publish to npm and PyPi
$ npm run publish-all
## Builder / Archetype
We use [Builder][] to centrally manage build configuration, dependencies, and
scripts. See the [dash-components-archetype][] repo for more information.
[Builder]: https://github.com/FormidableLabs/builder
[Dash]: https://github.com/plotly/dash2
[dash-components-archetype]: https://github.com/plotly/dash-components-archetype
[MDN HTML attribute reference]: https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
[NPM package authors]: https://www.npmjs.com/package/dash-html-components/access
[PyPi]: https://pypi.python.org/pypi
Vanilla HTML components for Dash
## Dash
Go to this link to learn about [Dash][].
## Getting started
```sh
# Install dependencies
$ npm install
# Watch source for changes and build to `lib/`
$ npm start
```
## 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:
The list of attributes is regenerated by scraping the
[MDN HTML attribute reference][].
```sh
$ npm run generate-components
```
## Development
### Testing your components in Dash
1. Build development bundle to `lib/` and watch for changes
# Once this is started, you can just leave it running.
$ npm start
2. 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 start`
# running in a separate process, it's enough to just do:
$ python setup.py install
3. Run the dash layout you want to test
# Import dash_core_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:
```sh
# Install in `site-packages` on your machine
$ npm run install-local
```
## Uninstalling python package locally
```sh
$ npm run uninstall-local
```
## Publishing
For now, multiple steps are necessary for publishing to NPM and PyPi,
respectively. TODO:
[#5](https://github.com/plotly/dash-components-archetype/issues/5) will roll up
publishing steps into one workflow.
Ask @chriddyp to get NPM / PyPi package publishing accesss.
1. Preparing to publish to NPM
# Bump the package version
$ npm version major|minor|patch
# Push branch and tags to repo
$ git push --follow-tags
2. Preparing to publish to PyPi
# Bump the PyPi package to the same version
$ vi setup.py
# Commit to github
$ git add setup.py
$ git commit -m "Bump pypi package version to vx.x.x"
3. Publish to npm and PyPi
$ npm run publish-all
## Builder / Archetype
We use [Builder][] to centrally manage build configuration, dependencies, and
scripts. See the [dash-components-archetype][] repo for more information.
[Builder]: https://github.com/FormidableLabs/builder
[Dash]: https://github.com/plotly/dash2
[dash-components-archetype]: https://github.com/plotly/dash-components-archetype
[MDN HTML attribute reference]: https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
[NPM package authors]: https://www.npmjs.com/package/dash-html-components/access
[PyPi]: https://pypi.python.org/pypi
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
dash_html_components-0.4.1.tar.gz
(43.5 kB
view hashes)
Close
Hashes for dash_html_components-0.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab00d09103e51d1ff5f6e504da82fd21592bb2fc7beb82647cf74803770a1b55 |
|
MD5 | 6a2962d6d16d4af4348b97e9af8dd5d2 |
|
BLAKE2b-256 | a3faf84f537e59caed21eafe79e1c93dac1ac5f83b0f9fc711e2947eaccac306 |