Markprompt Web

A prebuilt version of the Markprompt dialog, based on @markprompt/react, built
with Preact for bundle-size savings. Viable for use from vanilla JavaScript or
any framework.

Installation

Install the package from NPM:

``sh
npm add @markprompt/web @markprompt/css
`

Usage

Include the CSS on your page, via a link tag or by importing it in your
JavaScript:

`html


`

`js
import '@markprompt/css';
`

Call the markprompt function with your project key:

`js
import { markprompt } from '@markprompt/web';

const markpromptEl = document.querySelector('#markprompt');

markprompt('YOUR-PROJECT-KEY', markpromptEl, {
references: {
getHref: (reference) => reference.file.path.replace(/\.[^.]+$/, '');
getLabel: (reference) => {
return reference.meta?.leadHeading?.value || reference.file?.title;
}
},
});
`

where YOUR-PROJECT-KEY can be obtained in your project settings on
Markprompt.com.

Options are optional and allow you to configure the texts and links used in the component to some extent. You will most likely want to pass references.getHref and reference.getLabel to transform your prompt references into links to your corresponding documentation, and search.getHref to transform search result paths into links to your documentation.

Styles are easily overridable for customization via targeting classes.
Additionally, see the theming section in our documentation for a full list of variables.

Usage via

`

> [!IMPORTANT]
> Consider locking the versions of your dependencies to avoid breaking changes. Always use versions that have been published at the same time.

API

$3

Render a Markprompt dialog button.

#### Arguments

- projectKey (string): Your Markprompt project key.
- container (HTMLElement | string): The element or selector to render
Markprompt into.
- options (object): Options for customizing Markprompt, see above.

When rendering the Markprompt component, it will render a search input-like
button by default. You have two other options:

- set trigger.floating = true to render a floating button
- set trigger.customElement = true, then
import { openMarkprompt } from '@markprompt/react' and call
openMarkprompt() from your code. This gives you the flexibility to render
your own trigger element and attach whatever event handlers you would like
and/or open the Markprompt dialog programmatically.

$3

Open the Markprompt dialog programmatically.

$3

Close the Markprompt dialog programmatically.

$3

Render the Markprompt chat view standalone, outside of a dialog.

- projectKey (string): Your Markprompt project key.
- container (HTMLElement | string): The element or selector to render
Markprompt into.
- options (object): Options for customizing Markprompt.

$3

Renders a standalone ticket deflection form into the provided container.

- container (HTMLElement | string): The element or selector to render the form into.
- options (object`): Options for customizing the form, see below.

Documentation

Find the full documentation and implementation examples for the SDK on the
Markprompt docs.

Community

- X

Authors

This library is created by the team behind Markprompt
(@markprompt).

License

MIT © Markprompt