connect - Connects the User

Documentation Index

Fetch the complete documentation index at: https://docs.overhyped.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

connect : OverhypedAI(“connect”, widgetOptions?)

• This method allows you to programmatically show the OverhypedAI integration in your web app.
• Use the connect method only if you have set autoConnect to false in the initOrg command options.
• Invoke this method whenever you want to display the OverhypedAI integration in your web app after using the initOrg and initUser commands.

// NOTE: This is an optional parameter.
const widgetOptions = {
    /**
     * Show/Hide the widget initially. This has no effect on the modal.
     * 
     * Defaults to true.
     */
    show?: boolean
    /**
     * Used to adjust the position of the widget relative to it's initial position.
     *
     * Defaults to { x: 0, y: 0 }.
     */
    positionOffset?: {
        x?: number | string
        y?: number | string
    }
}

import OverhypedAI from '@overhyped-ai/connect/OverhypedAI';

OverhypedAI("connect", widgetOptions)

• widgetOptions: object (Optional): Options to customize the widget.
  • show: boolean (Optional): Show/Hide the widget initially. This has no effect on the modal.
  • positionOffset: object (Optional): Adjust the position of the widget relative to it’s initial position.
    • x: number | string (Optional): X-axis offset.
    • y: number | string (Optional): Y-axis offset.