[App Gen] Updated Docs For Modal Bug in App Gen

[Tumph]

Background

Resolves shop/issues-sidekick/issues/#2055

Improves the TypeScript definitions for the Modal component's overlay control methods.

Problem

The documentation for modal overlay methods (hideOverlay, showOverlay, and toggleOverlay) lacks clarity on how these methods should be used programmatically versus through user interactions..

Solution

This PR updates the TypeScript definitions for the Modal component by moving the overlay control methods (hideOverlay, showOverlay, and toggleOverlay) from the excluded props list to be properly defined as methods with detailed JSDoc comments.

The added documentation clarifies that these methods are meant to be called imperatively on the modal element instance (via refs) rather than being passed as props. It also provides guidance on the proper usage patterns for controlling modal visibility through user interactions.

🎩

• Verify that TypeScript correctly recognizes these methods when using refs with Modal components
• Check that the documentation appears correctly in IDE tooltips

Checklist

• I have 🎩'd these changes
• I have updated relevant documentation

[Tumph]

• [App Gen] Updated Docs For Modal Bug in App Gen #3579 👈 (View in Graphite)
• 2025-10

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

[davebcn87]

I don't think that will work, that typescript definition only affects the docs, but the real component won't have those methods.

Let's discuss possible other solutions.

[spiderbites]

I don't think that will work, that typescript definition only affects the docs, but the real component won't have those methods.

Let's discuss possible other solutions.

Correct me if I'm wrong but the real component does have these methods. They weren't added here, just documented

[Tumph]

Yeah we just want it to use the methods properly, rather than incorrectly. Here is the diff before and after this change: https://docs.google.com/document/d/10NzJe2FEFfL0g4xrWIE8sMDRmZq111RWD6OFYCfqecc/edit?tab=t.0