CPLAT-9327 Improve forwardRef documentation, add displayName argument

[aaronlademann-wf]

DEPENDS ON UNRELEASED CHANGES IN REACT-DART

Motivation

While grokking our forwardRef API, I found myself wanting some implementation examples which could not be found in the documentation comment.

I also noticed that consumers had no way to define a displayName for the wrapper HOC created by forwardRef.

Changes

These changes address both issues by adding extensive examples in the documentation comment for forwardRef that mirror the analogous ReactJS forwardRef documentation, and by adding a displayName argument to the function which then gets set on the JS side via a call to defineProperty.

Release Notes

Allow custom displayName values for forwardRef wrapper components.

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review: @greglittlefield-wf @joebingham-wk @sydneyjodon-wk

QA Checklist

• Tests were updated and provide good coverage of the changeset and other affected code
• Manual testing was performed if needed
  • Steps from PR author:
  • Anything falling under manual testing criteria outlined in CONTRIBUTING.md

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

• A Client Platform member has reviewed these changes
• There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
• For release PRs - Version metadata in Rosie comment is correct

[aviary2-wf]

Security Insights

No security relevant content was detected by automated scans.

Action Items

• Review PR for security impact; comment "security review required" if needed or unsure
• Verify aviary.yaml coverage of security relevant code

---

Questions or Comments? Reach out on Slack: #support-infosec.

[greglittlefield-wf]

+1

[greglittlefield-wf]

Also, should this go into a function components WIP branch if it's dependent on changes in the react-dart 5.4.0-wip?

[smaifullerton-wk]

Please double check the boilerplate here - I updated this example from what it was previously.

[aaronlademann-wf]

@smaifullerton-wk I don't think the stuff you need from the react package is in the 5.4.0 release. You'll still need to have that 5.4.0/improve-forwardref-examples-and-typing dep override until its released.

[aaronlademann-wf]

Also, should this go into a function components WIP branch if it's dependent on changes in the react-dart 5.4.0-wip?

@greglittlefield-wf is there a function components wip branch here? I see both this - and Sydney's function component PRs with a base branch of master...

[greglittlefield-wf]

@aaronlademann-wf I don't believe there is one, no, but we could make one!

[aaronlademann-wf]

@greglittlefield-wf created the branch / updated the base branch of this PR. (I'll update Sydney's as well)

[greglittlefield-wf]

+10 except for CI failing; looks like generated files just need to be updated (pbr build + commit)

[greglittlefield-wf]

+10

@Workiva/release-management-p