docs: add closeModal() API documentation for embed instructions#46
Open
hariombalhara wants to merge 1 commit intomainfrom
Open
docs: add closeModal() API documentation for embed instructions#46hariombalhara wants to merge 1 commit intomainfrom
hariombalhara wants to merge 1 commit intomainfrom
Conversation
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
- Add comprehensive closeModal() documentation to embed-instructions.mdx - Include usage examples for both namespaced and non-namespaced embeds - Add common use case example in embed-events.mdx - Document supported embed types and error handling - Include migration note from internal API Co-Authored-By: hariom@cal.com <hariombalhara@gmail.com>
aa77d17 to
f26b361
Compare
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: add closeModal() API documentation for embed instructions
Summary
Adds comprehensive documentation for the new
closeModal()API method introduced in cal.com PR #24746. This method allows developers to programmatically close modal-based embeds (pop-ups and floating buttons) instead of using the undocumented internal hack.Changes:
embedding/embed-instructions.mdxwith full API documentationembedding/embed-events.mdxshowing how to close modal after successful bookingReview & Testing Checklist for Human
Cal("closeModal")actually works with pop-up and floating button embeds as documented#close-modalin embed-instructions.mdx renders correctly on the help siteTest Plan
Notes
close()tocloseModal()during development - confirmed the final name from the PR diffbookingSuccessfulV2(not the deprecatedbookingSuccessfulevent) per existing help docsCal(), proper MDX formatting)Link to Devin run: https://app.devin.ai/sessions/8b4ff4e64f8a465384db398b61ac7f2b
Requested by: @hariombalhara (hariom@cal.com)