Salesforce Lightning Design System
Welcome to the source code repository for Salesforce Lightning Design System, brought to you by Salesforce UX.
SLDS is...
- 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.
Getting Started
This project utilizes Storybook for component development. If you would like to know more about Storybook or how it works, check out their website.
Project Installation & Setup:
- Clone the repository down locally.
cdinto the project and runnpm installto install all project dependencies.
Running the Development Environment:
- Run
npm startto start the Storybook development environment.
Developing in Storybook
Once the development server is started with npm start, you can load it at http://localhost:9002.
Annotations
See the annotations guide.
Tasks
npm start
Starts the Storybook server for local development.
npm run full-start
Performs a full build and dist before starting the Storybook server. Useful for when a component or utility is added or removed from the system.
npm run gulp -- lint
Lint the code base for syntax and stylistic errors.
# Lint indentation, Sass, JavaScript files
npm run gulp -- lint
# Lint languages independently
npm run gulp -- lint:sass
npm run gulp -- lint:javascript
npm run gulp -- lint:javascript:test
npm run gulp -- lint:spaces
npm run gulp -- lint:html
# HTML5 validation
npm run gulp -- lint:vnu
# HTML5 validation on comma separated blueprint names
npm run gulp -- lint:vnu --components button,path,trees
# a11y validation
npm run gulp -- lint:a11y
# a11y validation on comma separated blueprint names
npm run gulp -- lint:a11y --components button,path,trees
# Lint examples using vnu, aXe, slds validation, and HTML5 validation
npm run gulp -- lint:examples
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
Compilation
npm run build-dist
Generate the Lightning Design System into the .dist directory.
npm run gulp -- styles
Compile Sass to CSS into .assets/styles.
npm run gulp -- clean
Delete temporary build and local files.
Stats
npm run gulp -- styles:stats: Useful stats about the project's deliverables.
Tests
npm test: run all tests
Troubleshooting
See the troubleshooting guide.
Contributing Back to SLDS
See the contributing guide.
Licenses
- 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
Got Feedback?
Please open a new GitHub Issue.