Salesforce Lightning Design System in React
Clone or download
interactivellama Merge pull request #1646 from kevinparkerson/disable-increment-decrem…
…ent-min-max-counter

Disable increment/decrement when min/max is hit
Latest commit ce85e0e Nov 14, 2018
Permalink
Failed to load latest commit information.
.github Update close PR welcome message Sep 14, 2018
.storybook-based-tests Make test process less opaque Jan 30, 2018
.storybook Prettier: style all files with prettier Sep 4, 2018
assets/images Remove <title> from illustrations. Nov 2, 2018
components Merge pull request #1646 from kevinparkerson/disable-increment-decrem… Nov 14, 2018
docs Move legacy release branch readme Oct 16, 2018
eslint-plugin Make eslint plugin external Sep 15, 2018
icons Clean up for release Nov 8, 2017
preset eslint-plugin: Add license info Sep 15, 2018
scripts Use the npm script from the travis script. Oct 18, 2018
styles Run Prettier on markdown files Dec 29, 2017
tests updates to tests following PR review for counter input Nov 7, 2018
utilities Merge pull request #1610 from kevinparkerson/press-letter-scroll-jump… Nov 1, 2018
.babelrc revert changes in babelrc Aug 22, 2018
.editorconfig Promote line length of 80 in editors Feb 13, 2018
.eslintignore Make test process less opaque Jan 30, 2018
.eslintrc.js Fixes eslint file to be safer Oct 18, 2018
.gitignore Add design token files Sep 15, 2018
.prettierignore Makes Prettier ignore more directories generated during testing. Oct 17, 2018
.prettierrc.json Move prettier config to external file Feb 14, 2018
.travis.yml TravisCI: sudo required Oct 27, 2018
CONTRIBUTING.md Mention git-bash in contributing docs Nov 8, 2018
LICENSE.txt Update license to two lines Apr 6, 2017
Procfile Add authentication May 24, 2016
README.md Additional link to polyfill docs from readme Nov 12, 2018
RELEASENOTES.md Release minor version Oct 25, 2018
app.js Improve Storyshots tests experience May 17, 2018
app.json Run prettier on JSON Feb 13, 2018
karma.conf.js Tests: Remove Chrome sandbox Oct 27, 2018
package-lock.json ran lint:fix Nov 3, 2018
package.json Replace PhantomJS with Headless Chrome Oct 27, 2018
webpack.config.dist.js Prefer object spread eslint rule Jul 25, 2018
webpack.config.js Add commas to end of multiline iterables Feb 5, 2018
webpack.config.test.js Add clarity to browser tests scripts Feb 14, 2018

README.md

Design System for React

Accessible, localization-friendly, presentational React components

Build Status DeepScan Grade Known Vulnerabilities

Install

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

Getting Started

Welcome to the project! 👋 This library is the React implementation of the Salesforce Lightning Design System. This library has a peer dependency on @salesforce-ux/design-system, react, and react-dom. 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.

Usage

Quick Setup (CommonJS)

For a no hassle setup and compatibility with Create React App v1, a CommonJS version has been included within the NPM package. If using this setup, please re-write the import statement in the documentation site examples. Use the following named import syntax to access CommonJS components from /lib/index.js:

import { Button } from '@salesforce/design-system-react';

<Button label="Hello Button" />

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. create-react-app and environments that do not transpile code within node_modules are not compatible with the component import below. All the examples on the documentation site use this syntax. You can use the Babel preset, @salesforce/babel-preset-design-system-react, 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';

<Button label="Hello Button" />

Transpile with .babelrc settings

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

Styling

This library does not contain any Cascading Style Sheets (CSS). You will need to add <link rel="stylesheet" type="text/css" href="/node_modules/@salesforce-ux/design-system/assets/styles/salesforce-lightning-design-system.min.css" /> 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 context for all child components with <IconSettings> at the top of your render tree:

import IconSettings from '@salesforce/design-system-react/components/icon-settings';

ReactDOM.render(
  <IconSettings iconPath="/assets/icons">
    <MyApp />
  </IconSettings>,
  document.getElementById('app')
)

// `/assets/icons` will be prepended to `/standard-sprite/svg/symbols.svg#account` within the SVG path
<svg aria-hidden="true" class="slds-icon">
  <use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="/assets/icons/standard-sprite/svg/symbols.svg#account"></use>
</svg>
// 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 <IconSettings>. 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(
  <IconSettings standardSprite={standardSprite}>
    <MyApp />
  </IconSettings>,
  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 git@github.com:salesforce/design-system-react.git
npm install
npm start
open http://localhost:9001 http://localhost:8001

Please read the CONTRIBUTING.md 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.

Got feedback?

If you have support questions, please post a question to StackOverflow and tag with design-system-react. If you find any bugs, create a GitHub Issue.

Security

Please report any security issue to security@salesforce.com 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.

Contributors

Thank you to all the contributors to this open source project, but special thanks to the following:

Active Key Contributors

Former Key Contributors

Licenses