Skip to Content
Docs

Options

Every option Helpwren.init takes, for one page.

All are optional. Settings → Branding sets the defaults for every site, and options given here win over it for this page.

index.html
Helpwren.init({
  source: "web",
  launcher: true,
  appearance: { position: "left", accent: "#1d4ed8" },
  layout: { width: 420, height: 720 },
});
OptionWhat it does
sourceWhich of the install's sources this page is. Default web.
launcherfalse hides the round button, for a site that opens the chat from its own.
triggerYour own buttons or links that open and close the chat: a CSS selector, an element or a list of elements. Each gets aria-expanded.
modefloating (default) is a launcher and a panel. inline puts the chat straight into container, always open, with no launcher.
containerAn element, or a CSS selector for one. Inline, the chat fills it. Floating, the launcher and panel sit inside it and it must be positioned.
appearanceYour own position (right or left), offsetX, offsetY (pixels, up to 120), accent, accentTo, accentInk (six-digit hex) and launcher icon.
layoutwidth (320 to 640, default 400) and height (420 to 900, default 680) of the floating panel in pixels, and zIndex.
welcomefalse keeps the welcome message and quick replies from showing beside the launcher.
opentrue starts with the chat open.

Note

Values outside a range are brought into it, and anything that is not a valid colour, number or address is ignored, so a mistake leaves the widget as it was.

Appearance covers appearance and layout in more detail, and how to change them after init.