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
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
2
+
3
+
# Comment to be posted to on first time issues
4
+
newIssueWelcomeComment: >
5
+
Thanks for opening your first issue! :wave:
6
+
7
+
If you have found this library helpful, please star it. A maintainer will try to respond within 7 days. If you haven’t heard anything by then, please bump this thread.
8
+
9
+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
10
+
11
+
# Comment to be posted to on PRs from first time contributors in your repository
12
+
newPRWelcomeComment: >
13
+
Thanks for opening this pull request! :100:
14
+
15
+
This is a community-driven project, and we can't do it without your participation. Please check out our [contributing guidelines](https://github.com/salesforce/design-system-react/blob/master/CONTRIBUTING.md) and review the Contributor Checklist if you haven't already, to make sure everything is squared away. TravisCI will take about 10 minutes to run through the same items that are on the Contributor checklist with a pass/fail check below. Please fix any issues that cause TravisCI to fail or ask for clarification--we try, but sometimes the errors can be unclear.
16
+
17
+
A maintainer will try to respond within 7 days. If you haven’t heard anything by then, please bump this thread.
18
+
19
+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
20
+
21
+
# Comment to be posted to on pull requests merged by a first time user
22
+
firstPRMergeComment: >
23
+
Congrats on merging your first pull request to Design System React! :tada:
24
+
25
+
On behalf of Salesforce's customers, partners, product specialists and employees, we would like offer sincere thanks and appreciation for helping make our user experience better. We look forward to working with you more in the future.
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
@@ -31,55 +31,133 @@ These are changes that have backwards-compatible solutions present and that comp
31
31
32
32
### Latest Release
33
33
34
+
## Release 0.8.21
35
+
36
+
**Bugfixes**
37
+
38
+
* Positioning behavior of Dialog components that use nubbins has changed. This applies to `Popover`, `Tooltip`, `Datepicker`, `Dropdown`. Previously the nubbin would be misaligned due to hardcoded margins that would get added onto the dialog component. It will now instead calculate the offsets and include them in the positioning logic and add/subtract from the left and top.
39
+
40
+
* Dialogs that use nubbins would previously have the nubbins point at the location on the reference trigger component (i.e. `Button`). Details:
41
+
* If a Popover had an align of `top left`, that meant the nubbin would point at the top left hand side of the `Button`.
42
+
* The behavior now is that the nubbin will always position the Dialog element as needed to ensure it points at the center of the desired side.
43
+
* In the case of a `top left` align the left will only designate the location of the nubbin on the Dialog.
44
+
* We may decide to bring back the ability to control both the nubbin location on the Dialog, but also the location at which it points to on the reference element. Much of the logic surrounding nubbins has been broken at the seams and edge cases for a long time. This change has been done in order to provide a more robust and dependable solution.
45
+
* Any dialog that uses an `offset` prop will need to be manually readjusted.
46
+
* Deprecate `offset` prop for `Dropdown` and `Popover`. The manual setting of positional offset of dialog components has been deemed unreliable. Position logic has been re-written to deliver better and more reliable positioning. Please create an issue if you have an edge case not covered by the built-in logic.
47
+
* In the future we may change the props on some of these Dialog components to ensure a more consistent positioning API with hopefully some less head-scratching in terms of how to use it. This may include deprecating certain props and introduction of other props.
48
+
49
+
50
+
## Release 0.8.20
51
+
52
+
**Bugfixes**
53
+
54
+
* Fix bug in `Dropdown` component where getIndexByValue() needs to look at nextProps.options when componentWillreceiveProps() is called.
55
+
* Datepicker: Make year Combobox menu width match the width of its input/button.
56
+
57
+
**Maintenance**
58
+
59
+
* Documentation update on how to use Design System React within Create React App.
60
+
* Consolidate assistiveText props under one object for the following: `DataTable`, `Icon`, `Search`, `PanelFilterGroup`, `Spinner`, `Tree`, `TextArea`.
61
+
62
+
## Release 0.8.19
63
+
64
+
**Major Features**
65
+
66
+
* Add Illustration Component
67
+
68
+
**Bugfixes**
69
+
70
+
* Make `Slider` a controlled component. Use `value` and `onChange` props.
71
+
*`Combobox`: Allow PopperJS to position menu correctly when menu hits the screen or overflow ancestor boundary.
72
+
* Update `Tree` branch and item to use latest SLDS HTML tags
73
+
* Update `Alert` error icon
74
+
75
+
**Maintenance**
76
+
77
+
* Add `getting-started.md` to NPM module
78
+
* Document copying over SLDS fonts to public for Create React App
79
+
* Update `Radio` component examples
80
+
* Remove `Object.assign()` from codebase and replace with spread
81
+
* Consolidate `assistiveText` props under one object. This is going to deprecate many props, but will make props more consistent across all the components.
82
+
*`AppLauncherSection`
83
+
*`Avatar`
84
+
*`Breadcrumb`
85
+
*`ButtonStateful`
86
+
*`Button`
87
+
*`GlobalHeader`
88
+
*`GlobalNavigationBarDropdown`
89
+
90
+
## Release 0.8.18
91
+
92
+
**Bugfixes**
93
+
94
+
*`Icon` uses new values for `name` and `category` when changed.
95
+
* Fixes console error that appears when using keyboard navigation to navigate the tree.
96
+
97
+
**Maintenance**
98
+
99
+
*`url-exists` utility uses `fetch` instead of `xmlHttpRequest`.
100
+
101
+
## Release 0.8.17
102
+
103
+
**Bugfixes**
104
+
105
+
* 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.
106
+
107
+
**Minor features**
108
+
109
+
*`dropdown` prop added to `DataTableRowActions` to increase customization of the dropdown menu
110
+
*`tabIndex` added to `MenuDropdown` component
111
+
*`Picklist` has been removed from examples. Please use a Combobox instead.
112
+
34
113
## Release 0.8.16
35
114
36
115
**Deprecation**
37
116
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.
117
+
38
118
* 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.
39
119
*`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.
40
120
* 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.
41
121
* For more information, please review #1350.
42
122
43
123
**Minor features**
124
+
44
125
* 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.
45
126
* Add `tabIndex` prop to `MenuDropdown`
46
127
* Update SLDS version to 2.6.0 and test
47
128
48
129
**Bug fix**
130
+
49
131
* Dialog components such as Dropdown when used with `menuPosition='overflowBoundaryElement'` now respect `max-width` instead of inherited children width
50
132
* Remove duplicate logo in `GlobalHeader`
51
133
52
134
**Maintenance**
135
+
53
136
* Upgrade Babel to v7 and Jest to v23
54
137
55
138
**Documentation**
56
-
* Remove deprecated Picklist from code base and examples
57
-
58
-
## Release 0.8.16
59
139
60
-
**Bugfixes**
61
-
* 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.
62
-
63
-
**Minor features**
64
-
*`dropdown` prop added to `DataTableRowActions` to increase customization of the dropdown menu
65
-
*`tabIndex` added to `MenuDropdown` component
66
-
*`Picklist` has been removed from examples. Please use a Comboboxe instead.
140
+
* Remove deprecated Picklist from code base and examples
67
141
68
142
## Release 0.8.15
143
+
69
144
**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`.
70
145
**Require `iconCategory` if `iconName` is set.**`utility` used to be the default icon category. `iconCategory` is now required.
71
146
72
147
**Major features**
148
+
73
149
*`@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.
74
150
* Tree is now a production component and supports [single selection keyboard navigation](https://www.lightningdesignsystem.com/components/trees/).
75
151
76
152
**Minor features**
153
+
77
154
* DataTable: Align header markup with SLDS to fix alignment issues. Remove error for non-boolean attribute `focusable`.
78
155
* Upgrade React Modal to 3.4.4. This is a dependency of `Modal`.
79
156
* Modal: Adds `assistiveText.dialogLabel` to define modal label when there is no header.
80
157
* DataTable: Adds `noHint` prop to actions and makes hints an optional field.
81
158
82
159
**Bug fix**
160
+
83
161
* Request icons (console warning) with HTTP GET, so Create React App's webpack dev server doesn't 404
84
162
* Modal no longer jumps to 50% of page.
85
163
* Documentation: Align button group example on site with SLDS example
@@ -90,6 +168,7 @@ TL:DR; If you use the source code directly, update your form component paths and
90
168
*`Dropdown` with `overflowBoundaryElement` and `align=right` use max-width instead of inherited children width.
91
169
92
170
**Maintenance**
171
+
93
172
* Require `iconCategory` if `iconName` is set. `utility` used to be the default icon category. `iconCategory` is now required.
94
173
* App Launcher - `assistiveText` is now an object with keys. Please update your component props.
95
174
* Popover - `assistiveText` is now an object with keys. Please update your component props.
@@ -102,50 +181,61 @@ Adds new script storyshots:start that allows interactive viewing of what is bein
102
181
## Release 0.8.14
103
182
104
183
**Minor features**
184
+
105
185
* Tooltip: "Learn more" variant added. Deprecation notice added for `variant: info || error`. Please use `theme` prop going forward instead.
106
186
107
187
**Bug fix**
188
+
108
189
* Data Table: Remove console warning when DataTableColumn `sortable` is `true`.
109
190
* Combobox: Trigger onOpen callback when menu opens
110
191
* Datepicker: Focus input if menu was actually open and not just requested to close
111
192
112
193
## Release 0.8.13
113
194
114
195
**Major features**
196
+
115
197
* Add SLDS Slider
116
198
117
199
**Minor features**
200
+
118
201
* Allow importing Lookup [deprecated] subcomponents in CommonJS modules
119
202
120
203
## Release 0.8.12
121
204
122
205
**Minor features**
206
+
123
207
* Affix position of Dialogs with `hasStaticAlignment` prop. Allows greater control of Tooltip, Popover, and dialog components.
124
208
* Set Datepicker's initial year dropdown menu highlight selection to current selected date.
125
209
126
210
## Release 0.8.11
127
211
128
212
**Minor features**
213
+
129
214
* Allow `input` label of combobox to show as required
130
215
* Input, Checkbox, and Radio support initial state (uncontrolled) in order to support applications with server-side form submission that are transitioning to atomic state.
131
216
132
217
**Maintenance**
218
+
133
219
* Lint warnings from a third-party package have been removed from CI tests.
134
220
135
221
**Documentation**
222
+
136
223
* Prop doc typos:
137
-
* replaced rendered input block to code block
138
-
* fixed broken link to source of Inline Edit Inputs
224
+
* replaced rendered input block to code block
225
+
* fixed broken link to source of Inline Edit Inputs
139
226
140
227
## Release 0.8.10
141
228
142
229
**Minor features**
143
-
* Combobox supports error messages.
230
+
231
+
* Combobox supports error messages.
144
232
145
233
**Outside SLDS pattern added**
234
+
146
235
* Multiple selection Combobox error messages should be placed after pillboxes with an additional `slds-has-error` wrapping div.
147
236
148
237
**Maintenance**
238
+
149
239
* Update Dropdown Menu children description
150
240
* Update SLDS peer dependency to allow 2.6.0-alphas
151
241
* Remove plus-plus (`var++`) instances from library for clarity
@@ -160,6 +250,7 @@ Adds new script storyshots:start that allows interactive viewing of what is bein
160
250
* Combobox menu supports subheadings and line separators.
161
251
162
252
**Outside SLDS pattern added**
253
+
163
254
* UX pattern created for Combobox autocomplete that limits subheadings to those that have "child" matching items.
164
255
165
256
## Release 0.8.8
@@ -182,7 +273,6 @@ Adds new script storyshots:start that allows interactive viewing of what is bein
0 commit comments