Need help with design-system-react?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

688 Stars 314 Forks BSD 3-Clause "New" or "Revised" License 7.5K Commits 102 Opened issues


Salesforce Lightning Design System for React

Services available


Need anything else?

Contributors list

Lightning Design System for React

Accessible, localization-friendly, presentational React components

Build Status DeepScan grade Known Vulnerabilities Join the chat at Monthly NPM downloads


$ npm install @salesforce-ux/design-system @salesforce/design-system-react

Getting Started

Welcome to this community-supported project! :wave: This library is the React implementation of the Salesforce Lightning Design System. This library has a peer dependency on

, and
. It is tested with React 16 and has a stable API despite its version number. Please polyfill this library in order to meet your target environment needs.


Quick Setup (ES6 and CJS modules)

For a no hassle setup and compatibility with Create React App, transpiled ES6 and CommonJS module versions have been included within the NPM package. If using this setup, please re-write the

statement in the documentation site examples. Use the following named
syntax to access the transpiled components from
import { Button } from '@salesforce/design-system-react';

Please view Create React App Setup for more information on using this library with Create React App.

Advanced (Source code)

Advanced usage requires that your babel presets are set up correctly.

and environments that do not transpile code within
are not compatible with the component import below. All the examples on the documentation site use this syntax. You can use the Babel preset,
, to get started. This preset will keep Babel compatible with Design System React and allow ES6 module benefits such as tree-shaking. This library is not browser-ready and should be polyfilled to your target environment.
import Button from '@salesforce/design-system-react/components/button';

Transpile with

    "presets": ["@salesforce/babel-preset-design-system-react"]

The current preset version is only compatible with Babel 6. Please see this issue comment for Babel 7.


This library does not contain any Cascading Style Sheets (CSS). You will need to add

 to your page and serve that file from a publicly available folder.

Serve icons publicly

Typically, scripts should be downloaded in the background without blocking the DOM. With React, this works best with server side rendering. SLDS recommends placeholder stencils while scripts are initializing if the HTML cannot be served immediately. If you can serve the HTML, then icon SVGs should not be bundled and served like any other file. Set a path

for all child components with
 at the top of your render tree:
import IconSettings from '@salesforce/design-system-react/components/icon-settings';

ReactDOM.render( , document.getElementById('app') )

// /assets/icons will be prepended to /standard-sprite/svg/symbols.svg#account within the SVG path

// ExpressJS example
app.use('/assets/icons', express.static('node_modules/@salesforce-ux/design-system/assets/icons/'));

Bundle icons

If you use a module bundler, like Webpack, you can let your module bundler manage SVG sprite file paths and send that path into

. This requires configuring your module bundler to manage your public assets.
import IconSettings from '@salesforce/design-system-react/components/icon-settings';
import standardSprite from '@salesforce-ux/design-system/assets/icons/standard-sprite/svg/symbols.svg';

ReactDOM.render( , document.getElementById('app') )

Icon Usage

Prior to v0.7.0, SLDS icons were bundled with the JavaScript. The 400KB+ icons bundle from SLDS is no longer included. You will need to download the SLDS CSS and icons separately.

Bundled script files are provided only for convenience. Do not use in production.

  • design-system-react.min.js
    (700KB+) - includes icons in the JavaScript
  • design-system-react-components.min.js
    (~400KB) - no icons.

Contributing to the code base

Clone and develop locally with Storybook and in-browser tests

git clone [email protected]:salesforce/design-system-react.git
cd design-system-react
npm install
npm start
open http://localhost:9001 http://localhost:8001

Please read the and Test README first. Then, create an issue to tell others you are working on a bug. If you would like to contribute a new component, create an issue with a list of proposed props to discuss with maintainers. Issues not addressed with pull requests may be closed eventually. Check out who's contributing to the project.


Audit conducted in November, 2019 on all current component examples not intended solely for testing by Salesforce Marketing Cloud (MC) Accessibility Specialist and project team.

  • Methods: Automated testing with axe; Manual testing with keyboard, JAWS, and NVDA
  • Results: 100% accessibility

Quarterly audits will be conducted beginning Feb 1, 2020 on any new or updated components by MC Accessibility Specialist.

  • Methods: Automated testing with axe; Manual testing with keyboard, JAWS, and NVDA
  • Goal: 100% accessibility

Project team will conduct internal accessibility testing in development process for new and updated components.

Got feedback?

If you have support questions, please post a question to StackOverflow and tag with

. If you find any bugs, create a GitHub Issue.


Please report any security issue to [email protected] as soon as it is discovered. This library limits its runtime dependencies in order to reduce the total cost of ownership as much as can be, but all consumers should remain vigilant and have their security stakeholders review all third-party dependencies.


Thank you to all the contributors to this one of many open source projects at Salesforce, but special thanks to the following:

Active Key Contributors

Former Key Contributors


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.