GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 18:31:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Rename newREactRootApi to newRootApi

Browse Source
This commit is contained in:
Valentin Palkovič 2022-02-10 12:20:18 +01:00
parent d1d8cffb97
commit b50177d62a
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
app/react/src/client/preview/render.tsx
View File

@ -65,10 +65,10 @@ const unmountElement = (el: Element) => {
};
const getReactRoot = (el: Element): IRoot | null => {
if (FRAMEWORK_OPTIONS?.newReactRootApi) {
if (FRAMEWORK_OPTIONS?.newRootApi) {
if (!(ReactDOM as any).createRoot) {
throw new Error(
"Your React version doesn't support the new React Root Api. Please use react and react-dom in version 18.x or set the storybook feature 'newReactRootApi' to false"
"Your React version doesn't support the new React Root Api. Please use react and react-dom in version 18.x or set the storybook feature 'newRootApi' to false"
);
}
let root = nodes.get(el);

5
docs/faq.md
View File

@ -92,14 +92,13 @@ You can set the following properties in your `.storybook/main.js` files:
```js
module.exports = {
reactOptions: {
newReactRootApi: true,
newRootApi: true,
},
};
```
After enabling it, it is possible to use React's newest [concurrent features](https://reactjs.org/docs/concurrent-mode-intro.html).
<div class="aside">
💡 The new React Root API (React.createRoot) only works with React 18 and above.
</div>
@ -398,4 +397,4 @@ const StoryMeta: ComponentMeta<typeof Button> = {
export default meta;
```
Although valid, it introduces additional boilerplate code to the story definition. Instead, we're working towards implementing a safer mechanism based on what's currently being discussed in the following [issue](https://github.com/microsoft/TypeScript/issues/7481). Once the feature is released, we'll migrate our existing examples and documentation accordingly.
Although valid, it introduces additional boilerplate code to the story definition. Instead, we're working towards implementing a safer mechanism based on what's currently being discussed in the following [issue](https://github.com/microsoft/TypeScript/issues/7481). Once the feature is released, we'll migrate our existing examples and documentation accordingly.