Skip to content

widget.mdx

Latest commit

 

History

History
104 lines (88 loc) · 2.47 KB

widget.mdx

File metadata and controls

104 lines (88 loc) · 2.47 KB
title Embed a Widget
icon message-smile
description Embed a Simli Avatar on your website in a few minutes using Simli Auto.

Features

Start using the Simli Widget on your website.

Supported platforms

  • WordPress, Shopify, Squarespace, Wix, Weebly and any website that supports HTML

Customize widget appearance

The Simli Widget can be customized using various parameters in the embed code. Here are the available customization options:

<simli-widget
  token="your-token"
  agentid="your-agent-id"
  position="relative"
  customtext="Call Agent"
  customimage="https://app.simli.com/images/logo.png"
  overlay="false"
>
</simli-widget>

Parameters

  • token (required): Your Simli API token for authentication
  • agentid (required): The unique identifier of your Simli Agent

Default Mode

  • position: Controls the widget's position on the page
    • "relative": Positions the widget in the normal document flow
    • "left": Fixes the widget to the left side of the screen
    • "right": Fixes the widget to the right side of the screen
  • customtext: Custom text to display on the widget button
  • customimage: URL to a custom image to replace the default dotted face animation

Overlay Mode (Custom Trigger Button)

  • overlay: Set to "true" to enable overlay mode, which creates a full-screen experience and enables you to customize the trigger button. Create a trigger button with the ID simliOverlayBtn in your HTML
<button id="simliOverlayBtn">Open Widget</button>
<simli-widget
  token="your-token"
  agentid="your-agent-id"
  position="relative"
  overlay="true"
>
</simli-widget>
Start using the Simli Widget on your website. Make sure to re-update the embded code on your website if you update your API Keys or Allowlist.