Skip to content

Commit 4094ccb

Browse files
Release commit for 0.8.8-commonjs [ci skip]
0 parents  commit 4094ccb

File tree

1,030 files changed

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

+137602
-0
lines changed

.gitignore

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