A React-based UI toolkit for the web
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
Blueprint is a React-based UI toolkit for the web.
It is optimized for building complex, data-dense web interfaces for desktop applications which run in modern browsers and IE11. This is not a mobile-first UI toolkit.
Blueprint's change log and migration guides for major verions live on the repo's Github wiki.
This repository contains multiple projects in the
directory that fall into 3 categories:
These are the component libraries we publish to NPM.
These are hosted on GitHub Pages as static web applications:
– Documentation site at blueprintjs.com/docs
– Landing page at blueprintjs.com
These are used as development playground environments:
– demo page that supports manual testing of all table features
These packages define development dependencies and contain build configuration. They adhere to the standard NPM package layout, which allows us to keep clear API boundaries for build configuration and isolate groups of
. They are published to NPM in order to allow other Blueprint-related projects to use this infrastructure outside this monorepo.
, not directly)
Lerna manages inter-package dependencies in this monorepo. Builds are orchestrated via
and NPM scripts.
Prerequisites: Node.js v12+, Yarn v1.22+
After cloning this repo, run:
to install all dependencies.
to install build tools globally
npm install -g windows-build-tools
is your configured script-shell by running:
npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
to ensure you have all the build tooling working properly.
If you were previously in a working state and have just pulled new code from
at the root.
to get the latest built versions of the library packages in this repo.
since it doesn't build the application packages (
, etc.) or run tests
from the root directory to watch changes across all packages and run the docs application with webpack-dev-server.
Alternately, each library has its own dev script to run the docs app and watch changes to just that package (and its dependencies):
, etc. One exception is
: since it has its own dev application, the
instead of the docs.
Much of Blueprint's documentation lives inside source code as JSDoc comments in
files and KSS markup in
files. This documentation is extracted and converted into static JSON data using documentalist.
If you are updating documentation sources (not the docs UI code which lives in
or the docs theme in
), you'll need to run
to see changes reflected in the application. For simplicity, an alias script
exists in the root to minimize directory hopping.
The One-time setup and Incorporating upstream changes steps should produce the generated source code in this repo used to build the icons documentation. This is sufficient for most development workflows.
If you are updating icons or adding new ones, you'll need to run
to see those changes reflected before running any of the dev scripts.
This project is made available under the Apache 2.0 License.