Skip to content

Commit 1d3349e

Browse files
committed
docs: upgrade guide fixes
1 parent 9e8f300 commit 1d3349e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/contributor-docs/upgrade-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ order: 7
1212
1313
### React 19
1414

15-
InstUI v11 added support for React 19. But upgrading to React 19 might cause issues because InstUI needs to access the native DOM in some cases and React introduced a breaking change here by [removing `ReactDOM.findDOMNode()`](<https://www.google.com/search?q=%5Bhttps://react.dev/blog/2024/04/25/react-19-upgrade-guide%23removed-reactdom-finddomnode%5D(https://react.dev/blog/2024/04/25/react-19-upgrade-guide%23removed-reactdom-finddomnode)>). If you are upgrading to React 19, you will need to add `ref`s to some of your custom components that use InstUI utilities, see [this guide](https://www.google.com/search?q=/%23accessing-the-dom). We suggest to check your code thoroughly for errors, especially places where you use your own components as some kind of popovers or its triggers (e.g. Menu, Popover, Tooltip, Drilldown,..).
15+
InstUI v11 added support for React 19. But upgrading to React 19 might cause issues because InstUI needs to access the native DOM in some cases and React introduced a breaking change here by [removing `ReactDOM.findDOMNode()`](https://react.dev/blog/2024/04/25/react-19-upgrade-guide#removed-reactdom-finddomnode). If you are upgrading to React 19, you will need to add `ref`s to some of your custom components that use InstUI utilities, see [this guide](/#accessing-the-dom). We suggest to check your code thoroughly for errors, especially places where you use your own components as some kind of popovers or its triggers (e.g. Menu, Popover, Tooltip, Drilldown,..).
1616

1717
If you are using React 18 you might just see error messages like (`Error: ${elName} doesn't have "ref" property.`), but your code should work the same as with InstUI v10.
1818

@@ -22,7 +22,7 @@ If you are using React 18 you might just see error messages like (`Error: ${elNa
2222

2323
With React 19, support for **PropTypes was dropped** from the core library. While it's still possible to use them with third-party libraries, InstUI has decided to no longer support them based on user feedback.
2424

25-
**Tip:** To see how the removal of `propTypes` might affect your application's business logic, you can use a Babel plugin like **`babel-plugin-transform-react-remove-prop-types`** to strip them out during your build process for testing.
25+
**Tip:** To see how the removal of `propTypes` might affect your application's business logic, you can use a Babel plugin like [babel-plugin-transform-react-remove-prop-types](https://github.com/oliviertassinari/babel-plugin-transform-react-remove-prop-types) to strip them out during your build process for testing.
2626

2727
---
2828

@@ -38,7 +38,7 @@ As a result of this change, the **`ALWAYS_APPEND_UI_TESTABLE_LOCATORS`** Node.js
3838

3939
### InstUISettingsProvider
4040

41-
[InstUISettingsProvider](https://www.google.com/search?q=/%23InstUISettingsProvider)'s `as` prop was removed, it will always render as a `<span>` (note: it will only render anything to the DOM if you provide a value to the `dir` prop.). The provided codemod will remove this prop automatically (see below).
41+
[InstUISettingsProvider](/#InstUISettingsProvider)'s `as` prop was removed, it will always render as a `<span>` (note: it will only render anything to the DOM if you provide a value to the `dir` prop.). The provided codemod will remove this prop automatically (see below).
4242

4343
### Theming engine changes
4444

@@ -65,7 +65,7 @@ The **`<CodeEditor>` component** from the `ui-code-editor` package has been **re
6565

6666
### Table
6767

68-
[Table](https://www.google.com/search?q=/%23Table) is now using [TableContext](https://www.google.com/search?q=%23TableContext) to pass down data to its child components, the following props are no longer passed down to their children (This should only affect you if you have custom table rows or cells):
68+
[Table](/#Table) is now using [TableContext](#TableContext) to pass down data to its child components, the following props are no longer passed down to their children (This should only affect you if you have custom table rows or cells):
6969

7070
| Component | prop | Substitute / Notes |
7171
| :-------- | :---------- | :------------------------------ |

0 commit comments

Comments
 (0)