[DX-629] Add Chat React API references

[m-hulbert]

Description

This PR adds an API reference for Chat in React using the new NestedTable and MethodSignature components. It should have parity with the TypeDoc references.

There is 1 commit per file, however I haven't yet updated the references in the conceptual content to point to these references yet to keep this PR smaller for review feedback. I will add that as a final commit once we are happy with this content.

Checklist

• Commits have been rebased.
• Linting has been run against the changed file(s).
• The PR adheres to the writing style guide and contribution guide.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 2c8dfbce-fb19-4a69-a358-2f562363cd42

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dx-629-chat-react-api-refs

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

Migrating from UI to YAML configuration.

Use the @coderabbitai configuration command in a PR comment to get a dump of all your UI settings in YAML format. You can then edit this YAML file and upload it to the root of your repository to configure CodeRabbit programmatically.

[splindsay-92]

Just a few things so far, but mostly looks good!

[splindsay-92]

Suggested change

	| options | Optional | Options to use when creating the room. Must be memoized to prevent unnecessary room recreations. Room options are immutable after creation; differing options for the same room name cause errors. | <Table id='RoomOptions'/> |
	| options | Optional | Options to use when creating the room. Must be memoized to prevent unnecessary room recreations. Room options are immutable after creation; differing options for the same room name will reject with a `RoomExistsWithDifferentOptions` error. | <Table id='RoomOptions'/> |

[splindsay-92]

Suggested change

	| children | Optional | Child components that will have access to the room context. | ReactNode or ReactNode[] |
	| children | Optional | Child components that will have access to the room context. | ReactNode, ReactNode[] or null |

[splindsay-92]

Can we highlight the default values so they are clear please?

[splindsay-92]

This is now incorrect, ably-js lists this as an errorInfo only I believe, chat is likely using the same type now. I'll double check and update the codebase if I've not already done so :)

[splindsay-92]

I think the 'clipped' flag is missing from these summary event types.

[splindsay-92]

Suggested change

	| historyBeforeSubscribe | Retrieves messages sent before the subscription was established. Only available when a `listener` is provided. | [historyBeforeSubscribe()](#historyBeforeSubscribe) |
	| historyBeforeSubscribe | Retrieves messages sent before the subscription was established, up to the point of attachment. Only available when a `listener` is provided. | [historyBeforeSubscribe()](#historyBeforeSubscribe) |