- Tailored for building Salesforce apps: Using the Lightning Design System markup and CSS framework results in UIs that reflect the Salesforce Lightning look and feel.
- Continuously updated: As long as you’re using the latest version of the Lightning Design System, your pages are always up to date with Salesforce UI changes.
- Clone the project with
git clone https://github.com/salesforce-ux/design-system.git
npm installin the root design-system folder.
npm startto launch the Previewer.
- Visit http://localhost:3003/local/preview
Having trouble getting these steps to work on your machine? Follow the troubleshooting guide.
The previewer is an interactive tool for creating blueprints.
It runs at the designated url on startup and is the primary means of viewing your work - it will live update as you make changes.
You can choose the blueprint, variant, and modifiers to preview as well as background color and screen size. It also previews the sass docs.
Everything in the design system is driven by annotations and the previewer is no different. To see any work in the previewer, you must add annotations to your code.
See the annotations guide.
See the blueprint documentation guide.
Start the Lightning Design System preview app.
npm run gulp -- lint
Lint the code base for syntax and stylistic errors.
Pull Request Checks
To run all the checks a pull request will run in Travis use the following command.
# To run every check against all blueprints npm run pr-checks # To run every check but target certain blueprints for slow checks like aXe and vnu npm run pr-checks -- --components button,path,trees
npm run build && npm run dist
Generate the Lightning Design System into the
npm run gulp -- styles
Compile Sass to CSS into
npm run gulp -- clean
Delete temporary build and local files.
npm run gulp -- styles:stats: Useful stats about the project's deliverables.
npm test: run all tests
See the troubleshooting guide.
Contributing to the code base
See the contributing guide.
- Source code is licensed under BSD 3-Clause
- All icons and images are licensed under Creative Commons Attribution-NoDerivatives 4.0
- The Salesforce Sans font is licensed under our font license
Please open a new GitHub Issue.