Skip to content

Commit bb08db9

Browse files
Release commit for 0.8.2-commonjs [ci skip]
0 parents  commit bb08db9

File tree

1,023 files changed

+128208
-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

+128208
-0
lines changed

.gitignore

Lines changed: 312 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,312 @@
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 is
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+
# Icon must end with two \r
162+
Icon
163+
164+
# Thumbnails
165+
._*
166+
167+
# Files that might appear in the root of a volume
168+
.DocumentRevisions-V100
169+
.fseventsd
170+
.Spotlight-V100
171+
.TemporaryItems
172+
.Trashes
173+
.VolumeIcon.icns
174+
.com.apple.timemachine.donotpresent
175+
176+
# Directories potentially created on remote AFP share
177+
.AppleDB
178+
.AppleDesktop
179+
Network Trash Folder
180+
Temporary Items
181+
.apdisk
182+
183+
### SublimeText ###
184+
# cache files for sublime text
185+
*.tmlanguage.cache
186+
*.tmPreferences.cache
187+
*.stTheme.cache
188+
189+
# workspace files are user-specific
190+
*.sublime-workspace
191+
192+
# project files should be checked into the repository, unless a significant
193+
# proportion of contributors will probably not be using SublimeText
194+
# *.sublime-project
195+
196+
# sftp configuration file
197+
sftp-config.json
198+
199+
# Package control specific files
200+
Package Control.last-run
201+
Package Control.ca-list
202+
Package Control.ca-bundle
203+
Package Control.system-ca-bundle
204+
Package Control.cache/
205+
Package Control.ca-certs/
206+
Package Control.merged-ca-bundle
207+
Package Control.user-ca-bundle
208+
oscrypto-ca-bundle.crt
209+
bh_unicode_properties.cache
210+
211+
# Sublime-github package stores a github token in this file
212+
# https://packagecontrol.io/packages/sublime-github
213+
GitHub.sublime-settings
214+
215+
### Vim ###
216+
# swap
217+
[._]*.s[a-v][a-z]
218+
[._]*.sw[a-p]
219+
[._]s[a-v][a-z]
220+
[._]sw[a-p]
221+
# session
222+
Session.vim
223+
# temporary
224+
.netrwhist
225+
# auto-generated tag files
226+
tags
227+
228+
### WebStorm ###
229+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
230+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
231+
232+
# User-specific stuff:
233+
.idea/**/workspace.xml
234+
.idea/**/tasks.xml
235+
.idea/dictionaries
236+
237+
# Sensitive or high-churn files:
238+
.idea/**/dataSources/
239+
.idea/**/dataSources.ids
240+
.idea/**/dataSources.xml
241+
.idea/**/dataSources.local.xml
242+
.idea/**/sqlDataSources.xml
243+
.idea/**/dynamic.xml
244+
.idea/**/uiDesigner.xml
245+
246+
# Gradle:
247+
.idea/**/gradle.xml
248+
.idea/**/libraries
249+
250+
# CMake
251+
cmake-build-debug/
252+
253+
# Mongo Explorer plugin:
254+
.idea/**/mongoSettings.xml
255+
256+
## File-based project format:
257+
*.iws
258+
259+
## Plugin-specific files:
260+
261+
# IntelliJ
262+
/out/
263+
264+
# mpeltonen/sbt-idea plugin
265+
.idea_modules/
266+
267+
# JIRA plugin
268+
atlassian-ide-plugin.xml
269+
270+
# Cursive Clojure plugin
271+
.idea/replstate.xml
272+
273+
# Ruby plugin and RubyMine
274+
/.rakeTasks
275+
276+
# Crashlytics plugin (for Android Studio and IntelliJ)
277+
com_crashlytics_export_strings.xml
278+
crashlytics.properties
279+
crashlytics-build.properties
280+
fabric.properties
281+
282+
### WebStorm Patch ###
283+
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
284+
285+
# *.iml
286+
# modules.xml
287+
# .idea/misc.xml
288+
# *.ipr
289+
290+
# Sonarlint plugin
291+
.idea/sonarlint
292+
293+
### Windows ###
294+
# Windows thumbnail cache files
295+
Thumbs.db
296+
ehthumbs.db
297+
ehthumbs_vista.db
298+
299+
# Folder config file
300+
Desktop.ini
301+
302+
# Recycle Bin used on file shares
303+
$RECYCLE.BIN/
304+
305+
# Windows Installer files
306+
*.cab
307+
*.msi
308+
*.msm
309+
*.msp
310+
311+
# Windows shortcuts
312+
*.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 '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 '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)