storybook: [Bug]: Code of React components showing as

Describe the bug

I’m using the generated React components of Stencil Output React inside a Storybook instance running with React, everything works perfectly but when I click to check the component code it appears as follows:

<forwardRef>
  Button
</forwardRef>

The correct view should be:

<MyButton>
  Button
</MyButton>

I haven’t found anything that could help me with this, especially since these wrappers are automatically generated by the Stencil and I have no way of modifying the output.

Can anyone help me?

To Reproduce

No response

System

Environment Info:
  System:
    OS: macOS 13.2.1
    CPU: (8) x64 Apple M1 Pro
  Binaries:
    Node: 18.13.0 - ~/.nvm/versions/node/v18.13.0/bin/node
    Yarn: 1.22.10 - /usr/local/bin/yarn
    npm: 8.19.3 - ~/.nvm/versions/node/v18.13.0/bin/npm
  Browsers:
    Chrome: 111.0.5563.64
    Firefox: 109.0.1
    Safari: 16.3
  npmPackages:
    @storybook/addon-a11y: ^7.0.1 => 7.0.2 
    @storybook/addon-docs: ^7.0.1 => 7.0.7 
    @storybook/addon-essentials: ^7.0.1 => 7.0.7 
    @storybook/addon-mdx-gfm: ^7.0.2 => 7.0.2 
    @storybook/addons: ^7.0.1 => 7.0.2
    @storybook/preset-typescript: ^3.0.0 => 3.0.0 
    @storybook/react: ^7.0.7 => 7.0.7 
    @storybook/react-webpack5: ^7.0.1 => 7.0.7 
    @storybook/theming: ^7.0.1 => 7.0.2

Additional context

image

About this issue

  • Original URL
  • State: open
  • Created 4 years ago
  • Reactions: 27
  • Comments: 15 (3 by maintainers)

Most upvoted comments

Hey @felipefialho thanks for reporting the issue. It will be fixed in the next patch release of Storybook 8!

Antes tarde do que nunca 🤞!

Please reopen as the issue still exists in 8.4.7

I’m on storybook version 8.3.6. In our case, we are using a component imported directly from MUI in our stories. If we wrap the component and use the wrapped one in storybook, we see what we are looking for, otherwise we see <React.ForwardedRef...

our implementation is basically this:

import { Button } from '@mui/material';
...
export const SingleButton: Story = {
  render: (args) => <Button {...args}>Single Button</Button>,
};

Our code snippet looks like so:

<React.ForwardRef
  endIcon=""
  size="medium"
  startIcon=""
  variant="contained"
>
  Single Button
</React.ForwardRef>

We fixed problem via patching Mui components:

// file: patch-mui-displayName.tsx

import * as Mui from '@mui/material';
import * as MuiIcons from '@mui/icons-material';

const componentsList = Object.keys(Mui).filter(item => {
  return item[0] === item[0].toUpperCase();
});

for (const componentName of componentsList) {
  // NOTE: Check if Mui[componentName] is a React component by the presence of "render"
  if (Mui[componentName].render) {
    Mui[componentName].displayName = componentName;
  }
}

for (const iconName of Object.keys(MuiIcons)) {
  MuiIcons[iconName].displayName = iconName;
}

file: .storybook/preview.tsx

import './patch-mui-displayName.tsx';

// other imports...

storybook 8.3.2 is out, and issue is still here right ?

Issue is still here!

I got the same

** Disclaimer** This information might be inaccurate, due to it being generated automatically This is a known limitation with how Storybook handles React.forwardRef components. To display the proper component name, you can use the component parameter in your story to specify the display name:

MyButton.story = {
  parameters: {
    component: MyButton, // Reference your Stencil-generated component
  }
};

Alternatively, you can set the displayName property on the forwarded component:

MyButton.displayName = 'MyButton';

About Greptile

This response provides a starting point for your research, not a precise solution.

Help us improve! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

Edit Issue Bot Settings · Greptile

@dosandk thanks! Issue still exists in 9.0.4, but your patch works.

@dosandk your solution worked, thanks