Skip to content

Commit d7bf836

Browse files
Release commit for 0.8.4-commonjs [ci skip]
0 parents  commit d7bf836

File tree

1,023 files changed

+128248
-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,023 files changed

+128248
-0
lines changed

.gitignore

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