Dash UI HTML component suite
Project description
# dash-html-components
Vanilla HTML components for [Dash][]
## Contributing
```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
## 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://plot.ly/dash
[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][]
## Contributing
```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
## 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://plot.ly/dash
[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.6.2.tar.gz
(43.4 kB
view hashes)
Close
Hashes for dash_html_components-0.6.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c8be2773d878cd4bdeb71a4918c77578bb19aff6198447eb1aa9640e855be73 |
|
MD5 | b3efd4fa1ecac08858cb561523e80803 |
|
BLAKE2b-256 | cf05a33843c06643a492ae593f98cdcaaa5674ec4ad5025e53c0ff2918d60840 |