blocks/faq-chat

Import

Import

import * as api from "@fungi.computer/caps/blocks/faq-chat";

Exports

Kind	Export	Description
Ttype alias	FaqChatEntry	One reviewed question and its fixed answer.
Ttype alias	FaqChatFallback	The reply for a typed question that matches no entry.
Ttype alias	FaqChatProps	Props accepted by FaqChat.
constconstant	FaqChat	A chat-shaped FAQ. Visitors pick or type a question and get the caller’s reviewed answer with its next steps. Message rows follow Parakeet: the visitor’s turn sits on the surface with a primary rule, the answer is plain.
fnfunction	matchFaqEntry()	Routes a typed question to the entry whose keywords it mentions most. Returns undefined when nothing matches, so the caller can answer honestly.

FaqChatEntryTtype alias

Signature

type FaqChatEntry = object;

One reviewed question and its fixed answer.

Properties

id

Signature

id: string;

Stable identity for the entry.

question

Signature

question: string;

The question as a visitor would ask it. Also shown as a suggestion.

answer

Signature

answer: ReactNode;

The reviewed answer. The chat never generates text of its own.

keywords?

Signature

optional keywords?: readonly string[];

Lowercase words or phrases that route a typed question here.

actions?

Signature

optional actions?: ReactNode;

Caller-owned next steps shown under the answer, such as links.

---

FaqChatFallbackTtype alias

Signature

type FaqChatFallback = object;

The reply for a typed question that matches no entry.

Properties

answer

Signature

answer: ReactNode;

actions?

Signature

optional actions?: ReactNode;

---

FaqChatPropsTtype alias

Signature

type FaqChatProps = Omit<HTMLAttributes<HTMLElement>, "title"> & object;

Props accepted by FaqChat.

Type Declaration

Name	Type	Description
entries	readonly FaqChatEntry[]	-
greeting	ReactNode	The first agent message, shown before any question.
fallback	FaqChatFallback	-
title	ReactNode	Visible heading and accessible name of the chat.
note?	ReactNode	A short honest note about where answers come from.
avatar?	ReactNode	Optional mark shown beside the title, such as a logo.
inputLabel?	string	Accessible label of the typed-question field.
placeholder?	string	-
submitLabel?	string	-

FaqChatconstconstant

Signature

const FaqChat: ForwardRefExoticComponent<
  Omit<HTMLAttributes<HTMLElement>, "title"> &
    object &
    RefAttributes<HTMLElement>
>;

A chat-shaped FAQ. Visitors pick or type a question and get the caller’s reviewed answer with its next steps. Message rows follow Parakeet: the visitor’s turn sits on the surface with a primary rule, the answer is plain.

matchFaqEntry()fnfunction

Signature

function matchFaqEntry(entries, text): FaqChatEntry | undefined;

Routes a typed question to the entry whose keywords it mentions most. Returns undefined when nothing matches, so the caller can answer honestly.

Parameters

Parameter	Type
entries	readonly FaqChatEntry[]
text	string

Returns

FaqChatEntry | undefined