Skip to content

docs: Add aiAssistantTools and autoOpenFirstItem widget config props#337

Merged
swapnil-cometchat merged 2 commits intomainfrom
ENG-34381
Apr 23, 2026
Merged

docs: Add aiAssistantTools and autoOpenFirstItem widget config props#337
swapnil-cometchat merged 2 commits intomainfrom
ENG-34381

Conversation

@birendraprasad-gupta
Copy link
Copy Markdown
Contributor

Summary

Adds documentation for two new Chat Widget configuration properties: aiAssistantTools and autoOpenFirstItem.

Changes

ai-agents/chat-widget.mdx

  • Added aiAssistantTools prop to all three auth flow examples (Guest, UID, Auth Token).
  • Includes example tool definitions (getCurrentWeather, createTicket) showing how to wire up client-side tool handlers that the AI agent can invoke.

widget/html/integration.mdx

  • Added autoOpenFirstItem as a commented-out optional prop in all three auth flow code blocks (Guest, UID, Auth Token).
  • Added autoOpenFirstItem row to each "Update these values" settings table with description: when set to false, the widget does not automatically open the first conversation on load (defaults to true).

Testing

  • Verified the Mintlify dev preview renders all updated code blocks and tables correctly.

…widget

- Add aiAssistantTools configuration block with getCurrentWeather tool example
- Add createTicket tool example demonstrating ticket creation functionality
- Include tool examples across all three authentication flow code samples
- Provide clear comments explaining tool implementation patterns
- Help developers understand how to define and integrate custom tools with AI agents
…gration

- Add `autoOpenFirstItem` configuration parameter to all three integration examples
- Document `autoOpenFirstItem` option in configuration tables with description and default behavior
- Clarify that setting to `false` prevents automatic opening of first conversation on widget load
- Defaults to `true` to maintain existing behavior
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Apr 23, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Apr 23, 2026, 11:47 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@swapnil-cometchat swapnil-cometchat merged commit ded8cdd into main Apr 23, 2026
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants