blueprint README

The project's README from github.com/palantir/blueprint. As one markdown file: README.md.

Autorelease

Blueprint CircleCI

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. This is not a mobile-first UI toolkit.

Read the introductory blog post ▸

View the full documentation ▸

Try it out on CodeSandbox ▸

Read frequently asked questions (FAQ) on the wiki ▸

Changelog

Blueprint's change log and migration guides for major versions live on the repo's Github wiki.

Packages

This repository contains multiple projects in the packages/ directory that fall into 3 categories:

Libraries

These are the component libraries we publish to NPM.

Applications

These are hosted on GitHub Pages as static web applications:

These are used as development playground environments:

Build tooling

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 devDependencies. They are published to NPM in order to allow other Blueprint-related projects to use this infrastructure outside this monorepo.

Contributing

Looking for places to contribute to the codebase? First read the contribution guidelines, then check out the "help wanted" label.

Development

pnpm manages third-party and inter-package dependencies in this monorepo. Builds are orchestrated via Nx's task runner and NPM scripts. Lerna-Lite is used to prepare releases.

Prerequisites: Node.js v24.11+ (see version specified in .nvmrc), pnpm v10.x (see version specified in package.json)

One-time setup

First, ensure you have nvm (Node Version Manager) installed.

After cloning this repo, run:

  1. nvm use to use the supported Node version for Blueprint development.
  2. corepack enable to activate pnpm as the Node package manager.
  3. pnpm install to install all dependencies for the monorepo.
    1. If seeing an error like "Error when performing the request ...", you may be using a VPN that needs to be disabled to install the dependencies.
  4. If running on Windows:
    1. npm install -g windows-build-tools to install build tools globally
    2. Ensure bash is your configured script-shell by running:
      npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
      (reset this by running npm config delete script-shell)
  5. pnpm verify to ensure you have all the build tooling working properly.
    1. There may currently be some errors when running this step, even though everything is set up properly, see https://github.com/palantir/blueprint/issues/6926 for more info.
  6. (Optional) Run pnpm dev:demo to start the demo app and verify your setup is working.

Incorporating upstream changes

If you were previously in a working state and have just pulled new code from develop:

Developing libraries

There are a few ways to run development scripts, here they are listed from simplest to more advanced usage:

Updating documentation

Much of Blueprint's documentation lives inside source code as JSDoc comments in .tsx files and KSS markup in .scss 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 packages/docs-app or the docs theme in packages/docs-theme), you'll need to run pnpm compile from packages/docs-data to see changes reflected in the application. For simplicity, an alias script pnpm docs-data exists in the root to minimize directory hopping.

Updating icons

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 pnpm compile in packages/icons to see those changes reflected before running any of the dev scripts.

Thanks

Chromatic

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.

License

This project is made available under the Apache 2.0 License.

blueprint (palantir/blueprint)

Searching Database…

22.1K ·GitHub
Blueprint
What is this?Blueprint is Palantir's React-based UI toolkit for the web: a library of ready-made, Sass-styled UI components written in TypeScript and published under the Apache 2.0 license.
Is this a full framework, or a library I plug into an existing React app?A library, not a framework: it is a monorepo of independent component packages with Sass styling that you combine in your own React app; it does not prescribe the rest of your stack.
How do I get a working development setup?Clone the repo, run pnpm install at the root, then pnpm verify to check that the whole build toolchain is working properly.
What do I need to have installed before it will build?Node.js 24.14.1 or newer and pnpm 11.3.0, both pinned in the repo's engines field; on Windows you additionally need git-bash, with npm's script-shell setting pointed at it.
Are there any setup gotchas to watch out for?pnpm verify can currently report some errors even when everything is configured correctly, so a few red messages right after install do not necessarily mean you did anything wrong.
Is it web-only, or are there native or mobile builds too?Web only: Blueprint renders React components in the browser, and there are no native desktop or mobile targets.
Which component packages does the monorepo contain?Alongside the core component set there are dedicated packages for icons, date and time widgets, select components and tables, plus supporting docs, demo and landing apps.
Can I preview the components locally while developing?Yes — pnpm dev watches all packages and serves the docs application via webpack-dev-server, individual libraries have their own scripts like pnpm dev:table, and pnpm dev:demo starts a standalone demo app.
How is the documentation for all these components produced?It lives in the source code: JSDoc comments in .tsx files and KSS markup in .scss files are extracted by Documentalist into static JSON that powers the docs app.
How does the team catch visual regressions?They use Chromatic, a visual testing platform, to review UI changes and catch visual regressions before they ship.
What are similar projects?mdb-ui-kit, fluentui, tabler, Semantic-UI-React, material-components-web, daisyui, arc-library, css
Which topics is it in?table, system, scss, sass, toolkit, icons, components, design-system, component-library, design, ui-components, css
Creator
palantir
Size
397.6 MB
Stars
22.1K
Updated
CommitOct 16Release@blueprintjs/[email protected]Sep 30
Age
9y
Commits · 90 Days