Skip to main content

Widget customization

Configure the chatbot and search widgets by setting HTML attributes. All properties support i18n — override any text property to localize the widget.

biel-button

The <biel-button> component adds a floating AI chat button to your site.

Biel bot

Usage

<biel-button project="YOUR_PROJECT_ID" header-title="Biel.ai chatbot" button-style="dark">Ask AI</biel-button>

Chatbot button properties

PropertyDescription
Layout
projectRequired
Type: string

The project ID.
button-positionType: string
Default value: default
Available values: default, bottom-right, bottom-left, center-right, center-left, custom

Controls the position of the chat button on your webpage. Use custom to position the button using CSS.
button-styleType: string
Default value: default
Available values: default, dark, light

Defines the visual style of the chat button. dark uses a dark theme, light uses a light theme, and default follows your site's theme.
custom-fontType: boolean
Default value: false

When set to true, disables loading of the Inter font. Use this if your site already uses a different font to improve load time and maintain font consistency.
hide-iconType: boolean
Default value: false

When set to true, the button icon hides.
ai-iconType: string
Default value: bot
Available values: bot, sparks, question-mark

Specifies which AI icon to display in the button.
hide-avatarsType: boolean
Default value: false

When set to true, hides avatars in the chat interface.
api-keyType: string
Default value: ``

API key for authenticating requests to private projects. Required for private projects with create_chat and project_read permissions. Not required for public projects.
api-urlType: string
Default value: https://app.biel.ai

Override the base API URL. Use this for self-hosted or custom API endpoints.
embedded-modeType: boolean
Default value: false

Renders the chatbot inline in the page layout instead of as a floating button. See Embedded mode.
show-powered-byType: boolean
Default value: true

Show or hide the "Powered by Biel.ai" text. Hiding requires a Professional plan or above.

Chatbot modal properties

PropertyDescription
Layout
disable-inputType: boolean
Default value: false

When set to true, the user input field is disabled.
emailType: string
Default value: ``
An email address or ID for conversation tracking. This ID will be associated with the chat session in your project dashboard for analytics and user tracking purposes.
metadataType: string
Default value: ``

Custom metadata to attach to chat sessions. Use this to pass additional contextual information (e.g., user plan, page URL, or other identifiers) that will be associated with the conversation for analytics purposes.
expand-modalType: boolean
Default value: false

When set to true, the chat modal opens in its expanded state by default.
hide-close-buttonType: boolean
Default value: false

When set to true, the close icon hides.
hide-expand-buttonType: boolean
Default value: false

When set to true, the expand button icon hides.
hide-refresh-buttonType: boolean
Default value: false

When set to true, the refresh button hides.
hide-feedbackType: boolean
Default value: false

When set to true, removes the feedback options (like thumbs up/down) that users can use to rate AI responses.
hide-sourcesType: boolean
Default value: false

When set to true, hides the sources section from AI responses in the chat interface.
hide-settings-buttonType: boolean
Default value: false

When set to true, hides the settings button (reasoning mode selector) from the chatbot header. Only applies if your project has the reasoning mode plugin enabled.
hide-connect-buttonType: boolean
Default value: false

When set to true, hides the Connect button from the chatbot header. This button allows users to connect to MCP (Model Context Protocol) servers. When hidden, users won't be able to access MCP connection options even if MCP is enabled for the project.
hide-tooltipsType: boolean
Default value: false

When set to true, hides the tooltips that appear when hovering over header icons.
modal-positionType: string
Default value: center
Available values: center, top-center, bottom-right, bottom-left

Determines where the chat modal appears on the screen when opened. Choose the position that best fits your website's layout.
show-terms-modalType: boolean
Default value: false

When set to true, displays a terms and conditions modal before starting the chat.
think-mode-enabledType: boolean
Default value: false

When set to true, selects Think mode by default (instead of Auto) for deeper AI reasoning. Users can still change modes via the settings dropdown unless you also set hide-settings-button to true. Requires the reasoning mode plugin to be enabled for your project. See Reasoning modes for details.
keep-conversationType: boolean
Default value: false

When set to true, persists the conversation across page navigations. The chat history is maintained until the user refreshes or closes the browser.
MCP Integration
mcp-server-urlType: string
Default value: ``

Override the MCP server URL. Use for custom or self-hosted MCP servers, or when authentication is required. Takes priority over the API-provided URL. See MCP Server.
mcp-enabledType: boolean
Default value: false

Enable MCP (Model Context Protocol) integration for the widget.
mcp-server-nameType: string
Default value: ``

Custom display name for the MCP server shown in the connect dialog.
mcp-metadata-tagType: string
Default value: ``

Tag to identify conversations originating from MCP connections.
Text
assistant-labelType: string
Default value: Assistant

Label text displayed above AI responses in the chat.
close-button-textType: string
Default value: Close

Tooltip text for the close button in the chatbot header.
collapse-button-textType: string
Default value: Collapse

Tooltip text for the collapse button in the chatbot header.
error-message-4-0-3Type: string
Default value: Oops! The request URL or API key is invalid or not authorized for this project.

403 unauthorized message.
error-message-4-0-4Type: string
Default value: Oops! We could not find the provided project ID.

404 not found message.
error-message-defaultType: string
Default value: Oops! Please try again later.

500 error message.
expand-button-textType: string
Default value: Expand

Tooltip text for the expand button in the chatbot header.
footer-textType: string
Default value: AI-generated answers may contain errors. Verify official sources before use.

Footer text.
header-titleType: string
Default value: Company Name AI

Title text for the chatbot header.
input-placeholder-textType: string
Default value: Type your message

Placeholder text displayed in the chatbot's input field.
connect-button-textType: string
Default value: Connect

Tooltip text for the Connect button in the chatbot header.
mcp-url-textType: string
Default value: MCP URL

Label for the MCP URL option in the connect dialog.
mcp-url-descriptionType: string
Default value: Copy to clipboard

Description text for the MCP URL option in the connect dialog.
mcp-claude-textType: string
Default value: Claude Code

Label for the Claude Code option in the connect dialog.
mcp-claude-descriptionType: string
Default value: CLI command

Description text for the Claude Code option in the connect dialog.
mcp-copilot-textType: string
Default value: Copilot (VS code)

Label for the Copilot option in the connect dialog.
mcp-copilot-descriptionType: string
Default value: Opens in a new tab

Description text for the Copilot option in the connect dialog.
mcp-cursor-textType: string
Default value: Cursor

Label for the Cursor option in the connect dialog.
mcp-cursor-descriptionType: string
Default value: Opens in a new tab

Description text for the Cursor option in the connect dialog.
mcp-copied-textType: string
Default value: Copied!

Confirmation text shown after copying an MCP value to the clipboard.
mcp-url-copied-descriptionType: string
Default value: URL copied to clipboard

Description text shown after copying the MCP URL.
mcp-claude-copied-descriptionType: string
Default value: Command copied to clipboard

Description text shown after copying the Claude Code command.
refresh-button-textType: string
Default value: Refresh

Tooltip text for the refresh button in the chatbot header.
send-button-textType: string
Default value: Send

Text displayed on the send button next to the input field.
sources-textType: string
Default value: Sources

Text displayed for introducing sources in messages.
suggested-questionsType: array
Default value: []

An array of strings containing questions that will be shown to users when they open the chat. These questions help guide users on what they can ask the AI.
suggested-questions-titleType: string
Default value: Suggested questions

The heading text that appears above the list of suggested questions in the chat interface.
settings-button-textType: string
Default value: Settings

Tooltip text for the settings button (reasoning mode selector) in the chatbot header. Only visible if your project has the reasoning mode plugin enabled.
terms-checkbox-textType: string
Default value: I have read and agree to the Terms & Conditions.

Text displayed next to the terms acceptance checkbox.
terms-descriptionType: string
Default value: Please review our <a href='https://biel.ai/terms' target='_blank' rel='noopener'>Terms & Conditions</a> before proceeding.

Description text shown in the terms and conditions modal.
terms-titleType: string
Default value: Chatbot Terms & Conditions

Title text for the terms and conditions modal.
copy-button-textType: string
Default value: Copy

Tooltip text for the copy button on code snippets.
copied-button-textType: string
Default value: Copied!

Text shown after copying a code snippet.
think-mode-auto-textType: string
Default value: Auto

Label for the Auto reasoning mode in the settings dropdown.
think-mode-auto-descriptionType: string
Default value: Balances speed and quality

Description for the Auto reasoning mode.
think-mode-fast-textType: string
Default value: Instant

Label for the Instant reasoning mode in the settings dropdown.
think-mode-fast-descriptionType: string
Default value: Quick answers for simple questions

Description for the Instant reasoning mode.
think-mode-think-textType: string
Default value: Think

Label for the Think reasoning mode in the settings dropdown.
think-mode-think-descriptionType: string
Default value: Deep reasoning for complex questions

Description for the Think reasoning mode.
welcome-messageType: string
Default value: ""

A custom greeting message that appears when users first open the chat.

biel-search-button

The <biel-search-button> component adds an AI-powered search bar to your site.

Biel search

Usage

<biel-search-button project="YOUR_PROJECT_ID" button-style="rounded" search-placeholder="Search here...">Search</biel-search-button>

Search button properties

PropertyDescription
Layout
projectRequired
Type: string

The project ID.
button-styleType: string
Default value: default
Available values: default, rounded

Style of the button.
custom-fontType: boolean
Default value: false

When set to true, the Inter font will not be loaded. Useful if your site already uses a different font, enabling a quicker load time.
hide-ctrl-kType: boolean
Default value: false

When set to true, the Ctrl+K text hides.
hide-iconType: boolean
Default value: false

When set to true, the button icon hides.
ai-iconType: string
Default value: bot
Available values: bot, sparks, question-mark

Specifies which AI icon to display in the search button.
hide-avatarsType: boolean
Default value: false

When set to true, hides avatars in the chat interface.
api-keyType: string
Default value: ``

API key for authenticating requests to private projects. Required for private projects with create_chat, project_search, and project_read permissions. Not required for public projects.

Search modal properties

PropertyDescription
Layout
hide-ask-ai-buttonType: boolean
Default value: false

When set to true, the "Ask AI" button is hidden from the search results.
hide-descriptionsType: boolean
Default value: false

When set to true, hides descriptions in search results for a cleaner interface.
hide-filtersType: boolean
Default value: true

When set to false, enables the source filter bar in the search modal, allowing users to narrow results by category. Requires at least one active search filter configured in your project settings. For more details, see Search filters.
hide-navigation-buttonsType: boolean
Default value: false

When set to true, hides navigation buttons (up and down arrows, enter, escape) in the search modal for a simplified interface.
modal-positionType: string
Default value: top-center
Available values: center, top-center, top-right, bottom-left

Position of the modal.
stackedType: boolean
Default value: false

When set to true, displays search results in a stacked layout.
clean-titlesType: boolean
Default value: false

When set to true, removes site names from page titles that follow the format "Page Title
Text
ai-result-fragmentType: string
Default value: "Ask AI to answer your question"

Text displayed in the AI result section of the search modal.
search-placeholderType: string
Default value: "Search or ask AI..."

Placeholder for the search input.

Search chatbot modal properties

Most properties that can be defined in <biel-button> for configuring the chatbot modal can be set in the biel-search-button.

For details, see Chatbot modal properties.

Common customizations

Change the chatbot title

By default, the chatbot header displays "Company Name AI". Set the header-title property to show your own title:

<biel-button project="YOUR_PROJECT_ID" header-title="Acme AI">Ask AI</biel-button>

Change the button text

Replace the inner text of the element to change what the button says:

<biel-button project="YOUR_PROJECT_ID">Help</biel-button>