Welcome to the source code repository for Salesforce Lightning Design System, brought to you by Salesforce UX.
SLDS is...
This project utilizes Storybook for component development. If you would like to know more about Storybook or how it works, check out their website.
cd
into the project and run npm install
to install all project dependencies.The Storybook development environment can be started by running npm start
Whenever you add, remove, or alter a component's css annotation metadata, you'll need to restart Storybook to see those changes.
Node v14 is recommended for use with the Design System repository, and NVM is the recommended choice for managing multiple versions of Node on your computer.
A .nvmrc file is included in this project to aid in local development. To utilize it for setting your project's node version, run nvm use
in the root of the directory.
Additionally, you can set up a deeper shell integration for automatically invoking the nvmrc file when you change into the project directory by
following these instructions.
Once the development server is started with npm start
, you can load it at http://localhost:9002.
See the annotations guide.
npm start
Starts the Storybook server for local development.
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
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-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.
npm run gulp -- styles:stats
: Useful stats about the project's deliverables.
npm test
: run all tests, except axe/a11y tests
npm run test:a11y
: run axe tests for accessibility violations
Results are saved into ./__tests__/a11y/results
.
npm release:site
: build and release the framework and site
Requires heroku access to build and release the site.
See the troubleshooting guide.
See the contributing guide.
Please open a new GitHub Issue.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型