You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-7Lines changed: 6 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ Welcome to the project! :wave: This library is the [React](https://facebook.gith
28
28
29
29
### Quick Setup (CommonJS)
30
30
31
-
For a no hassle setup and compatibility with Create React App v1, a CommonJS version has been included within the NPM package to allow usage without transpiling. Use the following named `import` syntax to access CommonJS components from `/lib/index.js`:
31
+
For a no hassle setup and compatibility with Create React App v1, a CommonJS version has been included within the NPM package. If using this setup, please re-write the `import` statement in the documentation site examples. Use the following named `import` syntax to access CommonJS components from `/lib/index.js`:
32
32
33
33
```
34
34
import { Button } from '@salesforce/design-system-react';
@@ -59,10 +59,6 @@ import Button from '@salesforce/design-system-react/components/button';
59
59
60
60
This library does not contain any Cascading Style Sheets (CSS). You will need to add `<link rel="stylesheet" type="text/css" href="/node_modules/@salesforce-ux/design-system/assets/styles/salesforce-lightning-design-system.min.css" />` to your page and serve that file from a publicly available folder.
61
61
62
-
### Icon Usage
63
-
64
-
Prior to v0.7.0, SLDS icons were bundled with the JavaScript. The 400KB+ icons bundle from [SLDS](https://www.lightningdesignsystem.com/) is no longer included. You will need to download the SLDS CSS and icons separately.
65
-
66
62
#### Serve icons publicly
67
63
68
64
Typically, scripts should be downloaded in the background without blocking the DOM. With React, this works best with [server side rendering](https://reactjs.org/docs/react-dom-server.html#rendertostaticmarkup). SLDS recommends placeholder stencils while scripts are initializing if the HTML cannot be served immediately. If you can serve the HTML, then icon SVGs should not be bundled and served like any other file. Set a path `context` for all child components with `<IconSettings>` at the top of your render tree:
@@ -94,7 +90,6 @@ If you use a module bundler, like Webpack, you can let your module bundler manag
94
90
95
91
```
96
92
import IconSettings from '@salesforce/design-system-react/components/icon-settings';
97
-
98
93
import standardSprite from '@salesforce-ux/design-system/assets/icons/standard-sprite/svg/symbols.svg';
99
94
...
100
95
...
@@ -107,6 +102,10 @@ ReactDOM.render(
107
102
)
108
103
```
109
104
105
+
### Icon Usage
106
+
107
+
Prior to v0.7.0, SLDS icons were bundled with the JavaScript. The 400KB+ icons bundle from [SLDS](https://www.lightningdesignsystem.com/) is no longer included. You will need to download the SLDS CSS and icons separately.
108
+
110
109
Bundled script files are provided _only_ for convenience. Do not use in production.
111
110
112
111
*`design-system-react.min.js` (700KB+) - includes icons in the JavaScript
Copy file name to clipboardExpand all lines: RELEASENOTES.md
+68-3Lines changed: 68 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -31,21 +31,65 @@ These are changes that have backwards-compatible solutions present and that comp
31
31
32
32
### Latest Release
33
33
34
+
## Release 0.8.20
35
+
36
+
**Bugfixes**
37
+
38
+
* Fix bug in `Dropdown` component where getIndexByValue() needs to look at nextProps.options when componentWillreceiveProps() is called.
39
+
* Datepicker: Make year Combobox menu width match the width of its input/button.
40
+
41
+
**Maintenance**
42
+
43
+
* Documentation update on how to use Design System React within Create React App.
44
+
* Consolidate assistiveText props under one object for the following: `DataTable`, `Icon`, `Search`, `PanelFilterGroup`, `Spinner`, `Tree`, `TextArea`.
45
+
46
+
## Release 0.8.19
47
+
48
+
**Major Features**
49
+
50
+
* Add Illustration Component
51
+
52
+
**Bugfixes**
53
+
54
+
* Make `Slider` a controlled component. Use `value` and `onChange` props.
55
+
*`Combobox`: Allow PopperJS to position menu correctly when menu hits the screen or overflow ancestor boundary.
56
+
* Update `Tree` branch and item to use latest SLDS HTML tags
57
+
* Update `Alert` error icon
58
+
59
+
**Maintenance**
60
+
61
+
* Add `getting-started.md` to NPM module
62
+
* Document copying over SLDS fonts to public for Create React App
63
+
* Update `Radio` component examples
64
+
* Remove `Object.assign()` from codebase and replace with spread
65
+
* Consolidate `assistiveText` props under one object. This is going to deprecate many props, but will make props more consistent across all the components.
66
+
*`AppLauncherSection`
67
+
*`Avatar`
68
+
*`Breadcrumb`
69
+
*`ButtonStateful`
70
+
*`Button`
71
+
*`GlobalHeader`
72
+
*`GlobalNavigationBarDropdown`
73
+
34
74
## Release 0.8.18
35
75
36
76
**Bugfixes**
77
+
37
78
*`Icon` uses new values for `name` and `category` when changed.
38
79
* Fixes console error that appears when using keyboard navigation to navigate the tree.
39
80
40
81
**Maintenance**
82
+
41
83
*`url-exists` utility uses `fetch` instead of `xmlHttpRequest`.
42
84
43
85
## Release 0.8.17
44
86
45
87
**Bugfixes**
88
+
46
89
* REVERT [Change inline edit for accessibility](https://github.com/salesforce/design-system-react/pull/1332). It will not be updated. There is a new View/Edit Record Input pattern that uses the [Docked Former Footer component](http://www.lightningdesignsystem.com/components/docked-form-footer/) and this should be used instead of the Inline Edit Input in the future.
47
90
48
91
**Minor features**
92
+
49
93
*`dropdown` prop added to `DataTableRowActions` to increase customization of the dropdown menu
50
94
*`tabIndex` added to `MenuDropdown` component
51
95
*`Picklist` has been removed from examples. Please use a Combobox instead.
@@ -54,41 +98,50 @@ These are changes that have backwards-compatible solutions present and that comp
54
98
55
99
**Deprecation**
56
100
TL:DR; If you use the source code directly, update your form component paths and the parameters in `onChange`. All others stay the same for now.
101
+
57
102
* Moves `Input`, `Checkbox`, and `Textarea` out of `component/forms` and directly into `component/`. Old paths such as `component/forms/input` will still work, but include a console warning as deprecated.
58
103
*`components/input`, `components/checkbox`, and `components/textarea` pass different parameters into the `onChange` callback. `onChange` now passes in `event, { checked }` if the new paths are used. The parameters used to be `checked, event, { checked }`. If you use the new paths such as `components/input`, please update your parameter variables. This aligns the callback's parameters with the rest of the library's callback functions.
59
104
* If you consume the library with named imports `{[component]} from '@salesforce/design-system-react'`, you will recieve the warning and will need to use the old parameter order until the next breaking change.
60
105
* For more information, please review #1350.
61
106
62
107
**Minor features**
108
+
63
109
* Update `Tree` example to be hashmap in order to promote immutability. Please review `Tree` example on [documentation site](http://react.lightningdesignsystem.com/components/tree/) in order to understand flattened tree data.
64
110
* Add `tabIndex` prop to `MenuDropdown`
65
111
* Update SLDS version to 2.6.0 and test
66
112
67
113
**Bug fix**
114
+
68
115
* Dialog components such as Dropdown when used with `menuPosition='overflowBoundaryElement'` now respect `max-width` instead of inherited children width
69
116
* Remove duplicate logo in `GlobalHeader`
70
117
71
118
**Maintenance**
119
+
72
120
* Upgrade Babel to v7 and Jest to v23
73
121
74
122
**Documentation**
123
+
75
124
* Remove deprecated Picklist from code base and examples
76
125
77
126
## Release 0.8.15
127
+
78
128
**Modals are now at `z-index: 8000`.** If there are items on the main page with a higher `z-index`, they will appear in front of the modal. This setting aligns with the [prescribed z-index in SLDS](https://www.lightningdesignsystem.com/design-tokens/#category-z-index) for `$z-index-overlay`.
79
129
**Require `iconCategory` if `iconName` is set.**`utility` used to be the default icon category. `iconCategory` is now required.
80
130
81
131
**Major features**
132
+
82
133
*`@salesforce/design-system-react/module` now contains tree-shaking compatible ES6 modules (Tested with Webpack 4). This should work out of the box (due to `package.json`'s `module` field) and replace CommonJS module usage in Webpack 3 and 4. See [pull request](https://github.com/salesforce/design-system-react/pull/1300) for more details.
83
134
* Tree is now a production component and supports [single selection keyboard navigation](https://www.lightningdesignsystem.com/components/trees/).
84
135
85
136
**Minor features**
137
+
86
138
* DataTable: Align header markup with SLDS to fix alignment issues. Remove error for non-boolean attribute `focusable`.
87
139
* Upgrade React Modal to 3.4.4. This is a dependency of `Modal`.
88
140
* Modal: Adds `assistiveText.dialogLabel` to define modal label when there is no header.
89
141
* DataTable: Adds `noHint` prop to actions and makes hints an optional field.
90
142
91
143
**Bug fix**
144
+
92
145
* Request icons (console warning) with HTTP GET, so Create React App's webpack dev server doesn't 404
93
146
* Modal no longer jumps to 50% of page.
94
147
* Documentation: Align button group example on site with SLDS example
@@ -99,6 +152,7 @@ TL:DR; If you use the source code directly, update your form component paths and
99
152
*`Dropdown` with `overflowBoundaryElement` and `align=right` use max-width instead of inherited children width.
100
153
101
154
**Maintenance**
155
+
102
156
* Require `iconCategory` if `iconName` is set. `utility` used to be the default icon category. `iconCategory` is now required.
103
157
* App Launcher - `assistiveText` is now an object with keys. Please update your component props.
104
158
* Popover - `assistiveText` is now an object with keys. Please update your component props.
@@ -111,50 +165,61 @@ Adds new script storyshots:start that allows interactive viewing of what is bein
111
165
## Release 0.8.14
112
166
113
167
**Minor features**
168
+
114
169
* Tooltip: "Learn more" variant added. Deprecation notice added for `variant: info || error`. Please use `theme` prop going forward instead.
115
170
116
171
**Bug fix**
172
+
117
173
* Data Table: Remove console warning when DataTableColumn `sortable` is `true`.
118
174
* Combobox: Trigger onOpen callback when menu opens
119
175
* Datepicker: Focus input if menu was actually open and not just requested to close
120
176
121
177
## Release 0.8.13
122
178
123
179
**Major features**
180
+
124
181
* Add SLDS Slider
125
182
126
183
**Minor features**
184
+
127
185
* Allow importing Lookup [deprecated] subcomponents in CommonJS modules
128
186
129
187
## Release 0.8.12
130
188
131
189
**Minor features**
190
+
132
191
* Affix position of Dialogs with `hasStaticAlignment` prop. Allows greater control of Tooltip, Popover, and dialog components.
133
192
* Set Datepicker's initial year dropdown menu highlight selection to current selected date.
134
193
135
194
## Release 0.8.11
136
195
137
196
**Minor features**
197
+
138
198
* Allow `input` label of combobox to show as required
139
199
* Input, Checkbox, and Radio support initial state (uncontrolled) in order to support applications with server-side form submission that are transitioning to atomic state.
140
200
141
201
**Maintenance**
202
+
142
203
* Lint warnings from a third-party package have been removed from CI tests.
143
204
144
205
**Documentation**
206
+
145
207
* Prop doc typos:
146
-
* replaced rendered input block to code block
147
-
* fixed broken link to source of Inline Edit Inputs
208
+
* replaced rendered input block to code block
209
+
* fixed broken link to source of Inline Edit Inputs
148
210
149
211
## Release 0.8.10
150
212
151
213
**Minor features**
214
+
152
215
* Combobox supports error messages.
153
216
154
217
**Outside SLDS pattern added**
218
+
155
219
* Multiple selection Combobox error messages should be placed after pillboxes with an additional `slds-has-error` wrapping div.
156
220
157
221
**Maintenance**
222
+
158
223
* Update Dropdown Menu children description
159
224
* Update SLDS peer dependency to allow 2.6.0-alphas
160
225
* Remove plus-plus (`var++`) instances from library for clarity
@@ -169,6 +234,7 @@ Adds new script storyshots:start that allows interactive viewing of what is bein
169
234
* Combobox menu supports subheadings and line separators.
170
235
171
236
**Outside SLDS pattern added**
237
+
172
238
* UX pattern created for Combobox autocomplete that limits subheadings to those that have "child" matching items.
173
239
174
240
## Release 0.8.8
@@ -191,7 +257,6 @@ Adds new script storyshots:start that allows interactive viewing of what is bein
0 commit comments