-
Notifications
You must be signed in to change notification settings - Fork 97
chore: v9 QA sweep #1929
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
chore: v9 QA sweep #1929
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Changelog | ||
| # v6 Changelog | ||
|
|
||
| > **Tags:** | ||
| > - :boom: Breaking Change | ||
|
|
@@ -331,6 +331,7 @@ improved autocompletion and documentation in certain IDEs and editors like VSCod | |
| ## v6.0.0 (2019-06-07) | ||
|
|
||
| #### :boom: Breaking Change | ||
| * All breaking changes are detailed in the [Migration Guide](https://github.com/zendeskgarden/react-components/blob/main/docs/migrations/v6.md). Follow the guide to upgrade to version 6. | ||
| * `all packages` | ||
| * [#342](https://github.com/zendeskgarden/react-components/pull/342) BREAKING CHANGE: upgrade to [email protected] and styled-components@v4 ([@austin94](https://github.com/austin94)) | ||
|
|
||
|
|
@@ -342,43 +343,7 @@ improved autocompletion and documentation in certain IDEs and editors like VSCod | |
| * `all packages` | ||
| * [#353](https://github.com/zendeskgarden/react-components/pull/353) chore(lerna): update versioning flow ([@austin94](https://github.com/austin94)) | ||
|
|
||
| ### Breaking Change Details | ||
|
|
||
| #### New versioning strategy | ||
|
|
||
| - Garden React packages are now published under a shared, fixed (common major) version number | ||
| - You are still able to upgrade packages individually | ||
| - This change will help us better communicate changes and allows consumers to better understand the state of their dependencies | ||
| - This is the first release under the new versioning strategy, **v6.0.0** | ||
|
|
||
| #### New peer dependencies | ||
|
|
||
| From **v6.0.0** all Garden React libraries now require the following peer dependencies: | ||
|
|
||
| ```bash | ||
| react@^16.8.0 | ||
| react-dom@^16.8.0 | ||
| styled-components@^4.2.0 | ||
| @zendeskgarden/react-theming@^6.0.0 | ||
| ``` | ||
|
|
||
| [React v16 upgrade docs](https://reactjs.org/blog/2017/09/26/react-v16.0.html) | ||
| [styled-components v4 upgrade docs](https://www.styled-components.com/docs/faqs#what-do-i-need-to-do-to-migrate-to-v4) | ||
|
|
||
| Beginning with v4, styled-components now uses the [React.forwardRef](https://reactjs.org/docs/react-api.html#reactforwardref) API. | ||
|
|
||
| This means that all existing `innerRef`, `menuRef`, `buttonRef`, etc. props are now replaced with `ref`. | ||
|
|
||
| #### How to upgrade | ||
|
|
||
| 1. Upgrade `react` and `react-dom` to `latest` | ||
| 2. Upgrade all Garden dependencies to their most recent, pre v6 versions | ||
| 3. Upgrade styled-components and all Garden dependencies to `latest` | ||
| 1. Correct all `innerRef`, `buttonRef`, `menuRef`, etc. usages based on the [styled-components v4 upgrade docs](https://www.styled-components.com/docs/faqs#what-do-i-need-to-do-to-migrate-to-v4) | ||
|
|
||
| If you have any upgrade questions please [create an issue](https://github.com/zendeskgarden/react-components/issues). | ||
|
|
||
| #### Pre v6 changelogs | ||
| ## Pre v6 changelogs | ||
|
|
||
| [react-autocomplete](https://github.com/zendeskgarden/react-components/blob/930d97a0c923a98aa821a475c2557ceda22bec2c/packages/autocomplete/CHANGELOG.md), | ||
| [react-avatars](https://github.com/zendeskgarden/react-components/blob/930d97a0c923a98aa821a475c2557ceda22bec2c/packages/avatars/CHANGELOG.md), | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Changelog | ||
| # v8 Changelog | ||
|
|
||
| > **Tags:** | ||
| > - :boom: Breaking Change | ||
|
|
@@ -2372,6 +2372,7 @@ utilities upgrade to `@zendeskgarden/[email protected]` first. | |
| ## v8.0.0 (2020-02-18) | ||
|
|
||
| #### :boom: Breaking Change | ||
| * All breaking changes are detailed in the [Migration Guide](https://github.com/zendeskgarden/react-components/blob/main/docs/migrations/v8.md). Follow the guide to upgrade from version 7 to version 8. | ||
| * `.template`, `avatars`, `breadcrumbs`, `buttons`, `chrome`, `datepickers`, `dropdowns`, `forms`, `grid`, `loaders`, `modals`, `notifications`, `pagination`, `selection`, `tables`, `tabs`, `tags`, `theming`, `tooltips`, `typography`, `utilities` | ||
| * [#639](https://github.com/zendeskgarden/react-components/pull/639) feat(build): bring master up-to-date with next ([@austin94](https://github.com/austin94)) | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Garden Migration Guide | ||
|
|
||
| ## v6 | ||
|
|
||
| ### Breaking Change Details | ||
|
|
||
| #### New versioning strategy | ||
|
|
||
| - Garden React packages are now published under a shared, fixed (common major) version number | ||
| - You are still able to upgrade packages individually | ||
| - This change will help us better communicate changes and allows consumers to better understand the state of their dependencies | ||
| - This is the first release under the new versioning strategy, **v6.0.0** | ||
|
|
||
| #### New peer dependencies | ||
|
|
||
| From **v6.0.0** all Garden React libraries now require the following peer dependencies: | ||
|
|
||
| ```bash | ||
| react@^16.8.0 | ||
| react-dom@^16.8.0 | ||
| styled-components@^4.2.0 | ||
| @zendeskgarden/react-theming@^6.0.0 | ||
| ``` | ||
|
|
||
| [React v16 upgrade docs](https://reactjs.org/blog/2017/09/26/react-v16.0.html) | ||
| [styled-components v4 upgrade docs](https://www.styled-components.com/docs/faqs#what-do-i-need-to-do-to-migrate-to-v4) | ||
|
|
||
| Beginning with v4, styled-components now uses the [React.forwardRef](https://reactjs.org/docs/react-api.html#reactforwardref) API. | ||
|
|
||
| This means that all existing `innerRef`, `menuRef`, `buttonRef`, etc. props are now replaced with `ref`. | ||
|
|
||
| #### How to upgrade | ||
|
|
||
| 1. Upgrade `react` and `react-dom` to `latest` | ||
| 2. Upgrade all Garden dependencies to their most recent, pre v6 versions | ||
| 3. Upgrade styled-components and all Garden dependencies to `latest` | ||
| 4. Correct all `innerRef`, `buttonRef`, `menuRef`, etc. usages based on the [styled-components v4 upgrade docs](https://www.styled-components.com/docs/faqs#what-do-i-need-to-do-to-migrate-to-v4) | ||
|
|
||
| If you have any upgrade questions please [create an issue](https://github.com/zendeskgarden/react-components/issues). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Garden Migration Guide | ||
|
|
||
| ## v7 | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| #### `react-loaders` | ||
|
|
||
| - The `Dots` and `Spinner` components no longer accept a `velocity` prop | ||
| - To customize the speed of the animation use the `duration` prop to provide the time in MS. | ||
|
|
||
| #### `react-pagination` | ||
|
|
||
| - The `focusedKey` prop is no longer accepted | ||
| - This state is no longer controllable | ||
| - The `onStateChange` prop is no longer accepted | ||
| - Use the `onChange` prop to receive `currentPage` updates. | ||
|
|
||
| #### `react-tabs` | ||
|
|
||
| - The `selectedKey` prop has been renamed to `selectedItem` | ||
| - This API now aligns with other components | ||
| - All `<TabPanel>` components now require an `item` prop instead of a `key` prop | ||
| - Previously we used the `key` attribute to uniquely identify each tab | ||
| - This created confusion as `key` is also a reserved prop name in React | ||
| - The `onStateChange` prop is no longer valid | ||
| - Use the `onChange` prop to receive `selectedItem` updates | ||
|
|
||
| #### Removal of deprecated packages | ||
|
|
||
| The following deprecated packages have been removed from the repository and will not be upgraded to `v7`: | ||
|
|
||
| - `@zendeskgarden/react-autocomplete` | ||
| - Migrate to the `@zendeskgarden/react-dropdowns` package | ||
| - `@zendeskgarden/react-checkboxes` | ||
| - Migrate to the `@zendeskgarden/react-forms` package | ||
| - `@zendeskgarden/react-menus` | ||
| - Migrate to the `@zendeskgarden/react-dropdowns` package | ||
| - `@zendeskgarden/react-radios` | ||
| - Migrate to the `@zendeskgarden/react-forms` package | ||
| - `@zendeskgarden/react-ranges` | ||
| - Migrate to the `@zendeskgarden/react-forms` package | ||
| - `@zendeskgarden/react-select` | ||
| - Migrate to the `@zendeskgarden/react-dropdowns` package | ||
| - `@zendeskgarden/react-textfields` | ||
| - Migrate to the `@zendeskgarden/react-forms` package | ||
| - `@zendeskgarden/react-toggles` | ||
| - Migrate to the `@zendeskgarden/react-forms` package | ||
|
|
||
| #### Removal of deprecated Render-Prop Containers | ||
|
|
||
| In previous versions we have included render-prop containers for | ||
| the common UX patterns provided in our components. To help make these | ||
| assets more flexible, we have created a new repository [react-containers](https://github.com/zendeskgarden/react-containers). | ||
|
|
||
| In `v7` all render-prop containers (`*Container`) has been moved to standalone packages. | ||
| These containers are now available as standard React Hooks as well as render-props. | ||
|
|
||
| ### Migration Steps | ||
|
|
||
| - Upgrade all Garden React dependencies to their latest `v6.x` version | ||
| - Check your console and testing environments to see if any deprecation warnings can be seen | ||
| - Remove any usages of deprecated packages and containers | ||
| - Upgrade all Garden React dependencies to their latest `v7.x` version | ||
| - Update any `react-tabs`, `react-pagination`, and `react-loaders` usages affected by the breaking changes listed above | ||
|
|
||
| For this breaking change we were able to allow an open range for our peer dependency of `react-theming` to allow `v6` and `v7` versions. | ||
|
|
||
| This allows you to upgrade each package individually if necessary, ending with `react-theming`. | ||
| If you have any questions about this process please open an issue. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,6 +79,8 @@ export interface ITooltipDialogProps extends Omit<IModalProps, 'isCentered' | 'i | |
| * Positions the modal relative to the provided `HTMLElement` | ||
| */ | ||
| referenceElement?: HTMLElement | null; | ||
| /** @ignore Modifies the placement offset from the reference element (internal only) */ | ||
| offset?: number; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ❤️ |
||
| /** | ||
| * Adjusts the placement of the tooltip | ||
| **/ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#1914 build the case that components should always be wrapped in
ThemeProviderstarting with v9. Do we still need the fallbackDEFAULT_THEME?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My preference is to be consistent with other element-level components for now. If/when we determine to simplify, it should happen across everything.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. 👍 We can always follow-up with a broad sweep. 🧹