This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 400,000 packages pre-installed, including
@gooddata/react-components with all
npm packages installed. Try it out:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
With yarn installed, go to your project directory and run
$ yarn add @gooddata/react-components
If you prefer npm run
$ npm install --save @gooddata/react-components
The public API is exposed via global
index.js. Except for the styles, do not import any other file directly
because they are not intended to be part of the public API.
yarn install --frozen-lockfile
These commands may come in handy while developing:
|build react-components to |
|run all unit tests|
|format the source code to match the valid codestyle|
|run storybook from |
|build storybook to |
|run storybook and screenshot tests|
|run Live Examples dev-server from |
|build Live Examples to |
|serve built Live Examples - see |
|run testcafe tests against |
When you deploy this repo to heroku, it serves GoodData.UI Live Examples.
Relevant tasks are in
# run in the project directory heroku login heroku create <your-app-name> heroku config:set DOMAIN_ADMIN_USERNAMEfirstname.lastname@example.org DOMAIN_ADMIN_PASSWORD=xy PROJECT_ID_TO_ASSIGN=xms7ga4tf3g3nzucd8380o2bev8oeknp git push heroku HEAD:master heroku open
Geo chart uses Mapbox to render map which requires a Mapbox access token.
echo -e "EXAMPLE_MAPBOX_ACCESS_TOKEN=token" >> .env # only need to run once echo -e "STORYBOOK_MAPBOX_ACCESS_TOKEN=token" >> .env # only need to run once
To run GoodData.UI Live Examples locally:
git clone <this-repository> cd <repository-folder> yarn install --pure-lockfile yarn examples
Then open https://localhost:8999 and login using Live Examples account (you can create one here).
.envfor more secure
STORYBOOK_MAPBOX_ACCESS_TOKEN=token yarn storybook
The source code in the repository is formatted by Prettier. The format of the code is validated by our Continuous Integration server and is one of the requirements of successful merge.
Prettier is supported by every major IDE. You can find the list of supported editors and how to configure them here.
In the case, when your editor is not supported or you don't want to setup the integration, you can run the
yarn prettier-write command to reformat the code before commit.
In order to make the user experience with integrating GoodData UI SDK as smooth and secure as possible and to ensure that the SDK is using the latest features of the platform, we will only provide support to two most recent major versions of UI SDK.
The most recent majors will be supported in the following modes:
The customers are encouraged to always use the latest version of the UI SDK.
In case of using older versions, the user might face API incompatibility, performance or security issues.
Please follow the installation instructions to update to the newest version.
(C) 2007-2020 GoodData Corporation
This project is dual licensed:
For more information, please see LICENSE