@markprompt/react
v0.56.0
Published
A headless React component for adding GPT-4 powered search using the Markprompt API.
Downloads
3,784
Readme
Markprompt React
Markprompt's @markprompt/react
library offers you
both a simple, accessible, prebuilt React component that you can include in your
codebase, as well as a set of React primitives that you can use to build your
own custom Markprompt UI.
The <Markprompt />
component is built with Radix'
Dialog component
and allows for limited control over the Markprompt UI, mostly offering you the
ability to change texts as well as how prompt references and search results are
linked to your website.
The Markprompt.*
primitives offer you a fully customizable way to build your
own UI and have full control.
In combination with
@markprompt/css
,
the <Markprompt />
component is a drop-in solution for most websites. You can
also opt to provide your own styles, or override ours to your liking.
Installation
Install @markprompt/react
via NPM or your favorite package manager:
npm install @markprompt/react
Usage
Example:
import `@markprompt/css`;
import { Markprompt } from '@markprompt/react';
export function Component() {
return <Markprompt projectKey="YOUR-PROJECT-KEY" />;
}
replacing YOUR-PROJECT-KEY
with the key associated to your project. It can be
obtained in the project settings on Markprompt.com
under "Project key".
Documentation
The full documentation for the package can be found on the Markprompt docs.
Templates
Get a head start by cloning a fully-fledged AI application from our templates repository.
Community
Authors
This library is created by the team behind Markprompt (@markprompt).