JS SDK Modal Popup Options Updated #65
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant ReclaimSDK
Developer->>ReclaimSDK: triggerReclaimFlow({ modalOptions })
alt showExtensionInstallButton is true
ReclaimSDK->>Developer: Show extension install button in modal
end
Note over ReclaimSDK: Start modalPopupTimer (default 1 min)
Developer->>ReclaimSDK: Close modal
alt onClose callback defined
ReclaimSDK->>Developer: Invoke onClose callback
end
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
content/docs/advance-options/web-sdk.mdx (2)
490-496: ClarifymodalPopupTimersemantics & add missing type hintsThe new
modalPopupTimerfield is documented “in minutes”. In JavaScript, timers are almost universally expressed in milliseconds – or at least seconds – so minutes may surprise integrators. Consider either
- renaming the option to something explicit (
modalPopupTimeoutMinutes), or- clarifying in the inline comment and in the table that the value must be provided in minutes.
If changing the API is not possible, add a short note such as:
- modalPopupTimer: 1, // Modal popup timer in minutes (default: 1) + // ⬇️ value is in minutes + modalPopupTimer: 1, // Modal popup timer in minutes (default: 1)Likewise, consider showing the expected TypeScript shape in a separate snippet to make the parameter types (
boolean | number | () => void) explicit.
505-513: Minor punctuation & consistency polish• Line 506 begins with “Note:” but the list items that follow don’t terminate with periods, while earlier lists mix punctuation styles.
• The description foronCloseis wordier than earlier bullets and uses “can be called”, which is implied.Suggested tightening:
-Note: All the options are optional and can be used individually. +Note: Each option is optional and can be provided independently. -`onClose` (Default: `undefined`): Callback function that can be called when modal is closed for custom logic +`onClose` (Default: `undefined`): Callback invoked when the modal is closedThis keeps tone and formatting aligned with the rest of the doc.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/docs/advance-options/web-sdk.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/advance-options/web-sdk.mdx
[uncategorized] ~506-~506: Loose punctuation mark.
Context: ... and can be used individually. - title: Custom title for the modal dialog - `de...
(UNLIKELY_OPENING_PUNCTUATION)
Description
JS SDK Modal Popup Options Updated
Type of change
Checklist:
Summary by CodeRabbit