Addon Docs: Fix [Object object] displayName in some JSX components

[yannbf]

Closes #20920, Closes #26503

What I did

This PR reworks the logic in the JSX decorator to account for more use cases, fixing the [Object object] displayName issue.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

There are unit tests for this. You can also test it manually if you'd like:

1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
2. Change its main.ts to use react-typescript-docgen
3. Look at the autodocs page for the Button component
4. Change the Button component to use different formats:

• Nothing, just as is in the boilerplate
• override Button.displayName
• forwardRef()
• memo()

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

[yannbf]

I moved this up because I am assuming that docgenInfo should take precedence over an element's symbol name.

Before, if you had a forwardRef element AND docgenInfo with a displayName of "Button", it would say <React.ForwardRef> instead of <Button>.

Now it will say <Button>.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2961cee. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 1 target

• nx run-many --target=prep --all --parallel=8 --max-parallel=3 -- --reset --optimized

---

Sent with 💌 from NxCloud.

[kasperpeulen]

LGTM