Components: enhancements to TypeScript migration guidelines

[ciampo]

What?

• Add link to TypeScript migration guide in TOC
• Add a point about props destructuring
• Expand point about WordPressComponentProps

Why?

Iteratively improve the TypeScript migration guidelines as we gather insights from the initial work on the matter

[ciampo]

Points 3, 4 and 5 here are unchanged apart from their index, that shiftet by 1 after adding a new point (now no. 2)

[mirka]

Good clarification with the example 👍

[mirka]

Should we add the stuff about the ref?

[ciampo]

Pushed some changes in cb34385, let me know what you think!

Main changes:

• moved down the point re. making sure that there's a name export
• added a new point re. ref forwarding (either via forwardRef or via contextConnect)
• updated index of remaining points as needed

[walbo]

Maybe update the section with @example as well? The code example doesn't appear in the stories Docs tab if you add @example before the code. See #40915 (comment)

[mirka]

🚀

[mirka]

Maybe update the section with @example as well? The code example doesn't appear in the stories Docs tab if you add @example before the code. See #40915 (comment)

Good point. I was kind of on the fence about showing the @example snippets in the Storybook — on one hand they're a bit redundant given the actual story code snippets, but on the other hand the @example snippets are more complete with the import and useState statements. I don't feel strongly either way though. Do y'all have a preference?

[ciampo]

I've updated the point about the @example keyword in ff88bb5 , discouraging its usage.

Do y'all have a preference?

Let's go with showing the extra snippet in the StoryBook docs, for now. As you say, these snippets can offer a more complete example (with imports and useStates).

Also, sometimes the dynamic code snippet from StoryBook are not as helpful (e.g. sometimes they show function noRefCheck(){} for callback props), so I believe it's probably a good thing to have an extra code snippet.