Skip to content

Commit 66101c2

Browse files
Release commit for 0.8.6-commonjs [ci skip]
0 parents  commit 66101c2

File tree

1,030 files changed

+136850
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,030 files changed

+136850
-0
lines changed

.gitignore

Lines changed: 314 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,314 @@
1+
### Project files ###
2+
3+
# Only used for release server authentication
4+
/.npmrc
5+
6+
# We may want to remove to make first-time contributing easier
7+
package-lock.json
8+
9+
# React Storybook
10+
storybook/
11+
storybook-based-tests/
12+
13+
# Publishing and dist build
14+
.tmp*
15+
16+
# For build server. A copy of itself from master is pulled down in order to publish itself.
17+
design-system-react
18+
19+
# Allow custom pre-commit
20+
scripts/pre-commit.sh
21+
22+
# --- MACHINE GENERATED BELOW THIS LINE ---
23+
24+
### Node ###
25+
# Logs
26+
logs
27+
*.log
28+
npm-debug.log*
29+
yarn-debug.log*
30+
yarn-error.log*
31+
32+
# Runtime data
33+
pids
34+
*.pid
35+
*.seed
36+
*.pid.lock
37+
38+
# Directory for instrumented libs generated by jscoverage/JSCover
39+
lib-cov
40+
41+
# Coverage directory used by tools like istanbul
42+
coverage
43+
44+
# nyc test coverage
45+
.nyc_output
46+
47+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
48+
.grunt
49+
50+
# Bower dependency directory (https://bower.io/)
51+
bower_components
52+
53+
# node-waf configuration
54+
.lock-wscript
55+
56+
# Compiled binary addons (http://nodejs.org/api/addons.html)
57+
build/Release
58+
59+
# Dependency directories
60+
node_modules/
61+
jspm_packages/
62+
63+
# Typescript v1 declaration files
64+
typings/
65+
66+
# Optional npm cache directory
67+
.npm
68+
69+
# Optional eslint cache
70+
.eslintcache
71+
72+
# Optional REPL history
73+
.node_repl_history
74+
75+
# Output of 'npm pack'
76+
*.tgz
77+
78+
# Yarn Integrity file
79+
.yarn-integrity
80+
81+
# dotenv environment variables file
82+
.env
83+
84+
### Code ###
85+
# Visual Studio Code - https://code.visualstudio.com/
86+
.settings/
87+
.vscode/
88+
tsconfig.json
89+
jsconfig.json
90+
91+
### Emacs ###
92+
# -*- mode: gitignore; -*-
93+
*~
94+
\#*\#
95+
/.emacs.desktop
96+
/.emacs.desktop.lock
97+
*.elc
98+
auto-save-list
99+
tramp
100+
.\#*
101+
102+
# Org-mode
103+
.org-id-locations
104+
*_archive
105+
106+
# flymake-mode
107+
*_flymake.*
108+
109+
# eshell files
110+
/eshell/history
111+
/eshell/lastdir
112+
113+
# elpa packages
114+
/elpa/
115+
116+
# reftex files
117+
*.rel
118+
119+
# AUCTeX auto folder
120+
/auto/
121+
122+
# cask packages
123+
.cask/
124+
dist/
125+
126+
# Flycheck
127+
flycheck_*.el
128+
129+
# server auth directory
130+
/server/
131+
132+
# projectiles files
133+
.projectile
134+
projectile-bookmarks.eld
135+
136+
# directory configuration
137+
.dir-locals.el
138+
139+
# saveplace
140+
places
141+
142+
# url cache
143+
url/cache/
144+
145+
# cedet
146+
ede-projects.el
147+
148+
# smex
149+
smex-items
150+
151+
# company-statistics
152+
company-statistics-cache.el
153+
154+
# anaconda-mode
155+
anaconda-mode/
156+
157+
### macOS ###
158+
*.DS_Store
159+
.AppleDouble
160+
.LSOverride
161+
162+
# Removed due to Icon component not working on NPM.
163+
# Icon must end with two \r
164+
# Icon
165+
166+
# Thumbnails
167+
._*
168+
169+
# Files that might appear in the root of a volume
170+
.DocumentRevisions-V100
171+
.fseventsd
172+
.Spotlight-V100
173+
.TemporaryItems
174+
.Trashes
175+
.VolumeIcon.icns
176+
.com.apple.timemachine.donotpresent
177+
178+
# Directories potentially created on remote AFP share
179+
.AppleDB
180+
.AppleDesktop
181+
Network Trash Folder
182+
Temporary Items
183+
.apdisk
184+
185+
### SublimeText ###
186+
# cache files for sublime text
187+
*.tmlanguage.cache
188+
*.tmPreferences.cache
189+
*.stTheme.cache
190+
191+
# workspace files are user-specific
192+
*.sublime-workspace
193+
194+
# project files should be checked into the repository, unless a significant
195+
# proportion of contributors will probably not be using SublimeText
196+
# *.sublime-project
197+
198+
# sftp configuration file
199+
sftp-config.json
200+
201+
# Package control specific files
202+
Package Control.last-run
203+
Package Control.ca-list
204+
Package Control.ca-bundle
205+
Package Control.system-ca-bundle
206+
Package Control.cache/
207+
Package Control.ca-certs/
208+
Package Control.merged-ca-bundle
209+
Package Control.user-ca-bundle
210+
oscrypto-ca-bundle.crt
211+
bh_unicode_properties.cache
212+
213+
# Sublime-github package stores a github token in this file
214+
# https://packagecontrol.io/packages/sublime-github
215+
GitHub.sublime-settings
216+
217+
### Vim ###
218+
# swap
219+
[._]*.s[a-v][a-z]
220+
[._]*.sw[a-p]
221+
[._]s[a-v][a-z]
222+
[._]sw[a-p]
223+
# session
224+
Session.vim
225+
# temporary
226+
.netrwhist
227+
# auto-generated tag files
228+
tags
229+
230+
### WebStorm ###
231+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
232+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
233+
234+
# User-specific stuff:
235+
.idea/**/workspace.xml
236+
.idea/**/tasks.xml
237+
.idea/dictionaries
238+
239+
# Sensitive or high-churn files:
240+
.idea/**/dataSources/
241+
.idea/**/dataSources.ids
242+
.idea/**/dataSources.xml
243+
.idea/**/dataSources.local.xml
244+
.idea/**/sqlDataSources.xml
245+
.idea/**/dynamic.xml
246+
.idea/**/uiDesigner.xml
247+
248+
# Gradle:
249+
.idea/**/gradle.xml
250+
.idea/**/libraries
251+
252+
# CMake
253+
cmake-build-debug/
254+
255+
# Mongo Explorer plugin:
256+
.idea/**/mongoSettings.xml
257+
258+
## File-based project format:
259+
*.iws
260+
261+
## Plugin-specific files:
262+
263+
# IntelliJ
264+
/out/
265+
266+
# mpeltonen/sbt-idea plugin
267+
.idea_modules/
268+
269+
# JIRA plugin
270+
atlassian-ide-plugin.xml
271+
272+
# Cursive Clojure plugin
273+
.idea/replstate.xml
274+
275+
# Ruby plugin and RubyMine
276+
/.rakeTasks
277+
278+
# Crashlytics plugin (for Android Studio and IntelliJ)
279+
com_crashlytics_export_strings.xml
280+
crashlytics.properties
281+
crashlytics-build.properties
282+
fabric.properties
283+
284+
### WebStorm Patch ###
285+
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
286+
287+
# *.iml
288+
# modules.xml
289+
# .idea/misc.xml
290+
# *.ipr
291+
292+
# Sonarlint plugin
293+
.idea/sonarlint
294+
295+
### Windows ###
296+
# Windows thumbnail cache files
297+
Thumbs.db
298+
ehthumbs.db
299+
ehthumbs_vista.db
300+
301+
# Folder config file
302+
Desktop.ini
303+
304+
# Recycle Bin used on file shares
305+
$RECYCLE.BIN/
306+
307+
# Windows Installer files
308+
*.cab
309+
*.msi
310+
*.msm
311+
*.msp
312+
313+
# Windows shortcuts
314+
*.lnk

LICENSE.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Copyright (c) 2015-present, Salesforce.com, Inc.
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions are met:
6+
* Redistributions of source code must retain the above copyright
7+
notice, this list of conditions and the following disclaimer.
8+
* Redistributions in binary form must reproduce the above copyright
9+
notice, this list of conditions and the following disclaimer in the
10+
documentation and/or other materials provided with the distribution.
11+
* Neither the name of the Salesforce.com nor the
12+
names of its contributors may be used to endorse or promote products
13+
derived from this software without specific prior written permission.
14+
15+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18+
DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
19+
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Design System for React
2+
3+
### Accessible, localization-friendly, presentational React components
4+
5+
## Install
6+
7+
```
8+
$ npm install @salesforce-ux/design-system @salesforce/design-system-react
9+
```
10+
11+
## Getting Started
12+
13+
Welcome to the project! :wave: This library is the [React](https://facebook.github.io/react/) implementation of the [Salesforce Lightning Design System](https://www.lightningdesignsystem.com/). This library has a peer dependency on `@salesforce-ux/design-system`, `react`, and `react-dom`.
14+
15+
* [Getting Started](https://react.lightningdesignsystem.com/getting-started/)
16+
* [Documentation and interactive examples](https://react.lightningdesignsystem.com)
17+
18+
### Quick Setup (CommonJS)
19+
20+
A CommonJS-compatible version has been included within the NPM package to allows usage without transpiling. Use the following named `import` syntax to access CommonJS components from `/lib/index.js`:
21+
22+
```
23+
import { Button } from '@salesforce/design-system-react';
24+
25+
<Button label="Hello Button" />
26+
```
27+
28+
### Recommended Usage (ES6 modules)
29+
30+
Recommended 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](https://react.lightningdesignsystem.com/) use this syntax. You can use the Babel preset, `@salesforce/babel-preset-design-system-react`, to get started. [This preset](npmjs.com/package/@salesforce-ux/babel-preset-design-system-react) will keep Babel compatible with Design System React and allow ES6 module benefits such as tree-shaking.
31+
32+
```
33+
import Button from '@salesforce/design-system-react/components/button';
34+
35+
<Button label="Hello Button" />
36+
```
37+
38+
#### Transpile with `.babelrc` settings
39+
40+
```json
41+
{
42+
"presets": ["@salesforce/babel-preset-design-system-react"]
43+
}
44+
```
45+
46+
## Licenses
47+
48+
* Source code is licensed under [BSD 3-Clause](https://git.io/sfdc-license)
49+
* All icons and images are licensed under [Creative Commons Attribution-NoDerivatives 4.0](https://github.com/salesforce/licenses/blob/master/LICENSE-icons-images.txt)
50+
* The Salesforce Sans font is licensed under our [font license](https://github.com/salesforce/licenses/blob/master/LICENSE-font.txt)
51+
52+
## Got feedback?
53+
54+
If you have support questions, please post a question to [StackOverflow](https://stackoverflow.com/questions/tagged/design-system-react) and tag with `design-system-react`. If you find any bugs, create a [GitHub Issue](https://github.com/salesforce/design-system-react/issues).

0 commit comments

Comments
 (0)