Skip to main content

Interface: Options

Defined in: index.ts:21

Properties​

app?​

optional app?: string

Defined in: index.ts:23

The name Leuria shows when the reader connects the site. Default: the site's title.

askButton?​

optional askButton?: "navbar" | "floating" | "none"

Defined in: index.ts:36

Where the Ask button goes: navbar (default), floating (bottom right), or none (you place <leuria-ask-button> yourself).

connectButton?​

optional connectButton?: boolean

Defined in: index.ts:44

Also put the "Connect your AI" button in the navbar. Default false: the Ask panel offers it when needed.

docsPluginIds?​

optional docsPluginIds?: string[]

Defined in: index.ts:69

Only these docs plugin instances. Default: every one.

fallback?​

optional fallback?: "ask" | "auto"

Defined in: index.ts:67

Readers without Leuria: ask (default) proposes Leuria first, and this browser's AI or your server answer only once the reader picks one (for the page); auto uses them at once.

needs?​

optional needs?: object

Defined in: index.ts:59

What the Ask panel needs, so Leuria recommends a model that fits and no bigger. Default { tools: true, effort: "light" }: it searches and reads your pages, then answers.

context?​

optional context?: number

effort?​

optional effort?: "light" | "standard" | "deep"

images?​

optional images?: boolean

tools?​

optional tools?: boolean

pageEmbeddings?​

optional pageEmbeddings?: boolean

Defined in: index.ts:53

A small embedding model in the page (@leuria/web-embed, about 40 MB, downloaded when the reader agrees) for readers whose AI can't embed. Its runtime comes from a CDN (jsDelivr) and the model from Hugging Face. Install @leuria/web-embed to use it. Default false.

optional search?: boolean

Defined in: index.ts:42

Add a search to the navbar (⌘K), by words and by meaning. For sites without one: leave it off next to Algolia DocSearch or a local search. Default false.

server?​

optional server?: object

Defined in: index.ts:61

Your server as the last resort, for readers with no AI of their own.

url​

url: string

site?​

optional site?: string

Defined in: index.ts:25

The name the assistant gives the docs. Default: the site's title.

suggestions?​

optional suggestions?: string[]

Defined in: index.ts:29

Questions offered before the first one.

system?​

optional system?: string

Defined in: index.ts:31

Replaces the assistant's instructions.

title?​

optional title?: string

Defined in: index.ts:27

The Ask panel's title. Default "Ask the docs".

webmcp?​

optional webmcp?: boolean

Defined in: index.ts:46

Offer the docs tools to the browser's own agents (WebMCP). Default true.