Skip to content
A dash component starter pack 🌠
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Build & slew of minor improvements (#555) May 21, 2019
R dccInput updated Apr 20, 2019
dash_core_components Build & slew of minor improvements (#555) May 21, 2019
demo update Dropdown to accept optionHeight prop May 9, 2019
images Upload Component (#73) Oct 14, 2017
inst/deps Build & slew of minor improvements (#555) May 21, 2019
man updated online docs Apr 20, 2019
scripts Only fire error if there is one Sep 18, 2018
src Merge branch 'master' into patch-1 May 10, 2019
test set default type of Input components to 'text' Apr 30, 2019
.Rbuildignore updated R package after applying fixes Jan 18, 2019
.babelrc Update dependencies to their latest (#373) Nov 28, 2018
.builderrc 🔧 Move build deps and scripts to archetype Jun 26, 2016
.editorconfig
.eslintignore eslint ignore config Apr 29, 2018
.eslintrc Improve build (#473) Mar 4, 2019
.gitignore Generate all components with explicit args. Jun 27, 2018
.prettierrc Add prettier and prettier fixes. Aug 31, 2018
CHANGELOG.md bump version to 0.48.0 May 15, 2019
CONTRIBUTING.md Upgrade Plotly.js to 1.47.0 (#516) Apr 9, 2019
DESCRIPTION update package DESCRIPTION Apr 18, 2019
LICENSE updated R package after applying fixes Jan 18, 2019
LICENSE.txt
MANIFEST.in Build & slew of minor improvements (#555) May 21, 2019
NAMESPACE 📦 update dependencies and transpiled R code Mar 8, 2019
README.md Consistent build / requires (#472) Mar 4, 2019
dev-requirements.txt Upgrade to React 16 (#508) Apr 9, 2019
index.html Loading component (#352) Feb 28, 2019
jest.config.js
package-lock.json
package.json Build & slew of minor improvements (#555) May 21, 2019
renovate.json Update react markdown (#492) Mar 19, 2019
setup.py Build & slew of minor improvements (#555) May 21, 2019
webpack.config.js Loading component (#352) Feb 28, 2019
webpack.serve.config.js Loading component (#352) Feb 28, 2019

README.md

Dash Core Components

This package provides the core React component suite for Dash.

CircleCI

Development

Testing Locally

  1. Install the dependencies with:
$ npm i
  1. Build the code:
$ npm run build
  1. Install the library
$ python setup.py install

I recommend installing the library and running the examples in a fresh virtualenv in a separate folder:

$ mkdir dash_examples # create a new folder to test examples
$ cd dash_examples
$ virtualenv venv # create a virtual env
$ source venv/bin/activate # use the virtual env

(and then repeat step 3).

  1. Add the following line to your Dash app
app.scripts.config.serve_locally = True

Demo server

You can start up a demo development server to see a demo of the rendered components:

$ npm start

You have to maintain the list of components in demo/Demo.react.js.

Code quality and tests

To run integration tests (test_integration.py)

You can run the Selenium integration tests with the

npm test

command, and the Jest unit tests with the

npm run test-unit

Testing your components in Dash

  1. Run the build watcher by running $ npm run build:watch

  2. 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

You can run $ python setup.py install to install the package locally, so you can test it out in your current environment.

Uninstalling python package locally

$ npm run uninstall-local

Publishing

There's an npm script that will handle publish, provided you have the right credentials. You can run it by running

$ npm run publish-all

See the Publishing New Components/Features section of the Contributing guide for step-by-step instructions on publishing new components.

Dash Component Boilerplate

See the dash-component-boilerplate repo for more information.

You can’t perform that action at this time.