upstream-tldraw/packages/mentions/api-report.api.md

API Report File for "@tldraw/mentions"

Do not edit this file. It is a report generated by API Extractor.

import { Editor } from 'tldraw';
import { ForwardRefExoticComponent } from 'react';
import { JsonObject } from 'tldraw';
import { JSX } from 'react/jsx-runtime';
import { MentionNodeAttrs } from '@tiptap/extension-mention';
import { MentionOptions } from '@tiptap/extension-mention';
import { Node as Node_2 } from 'tldraw';
import { ReactNode } from 'react';
import { RefAttributes } from 'react';
import type { SuggestionOptions } from '@tiptap/suggestion';

// @public
export function Avatar({ author }: AvatarProps): JSX.Element;

// @public (undocumented)
export interface AvatarProps {
    // (undocumented)
    author: CommentAuthor;
}

// @public
export interface CommentAuthor {
    color?: string;
    image?: string;
    meta?: JsonObject;
    // (undocumented)
    name: string;
}

// @public
export function createMentionExtension({ resolveName, suggestion }?: MentionExtensionOptions): Node_2<MentionOptions<any, MentionNodeAttrs>, any>;

// @public
export function createMentionSuggestion(getSuggestions: (query: string) => MentionMember[] | Promise<MentionMember[]>, options?: MentionSuggestionOptions): Omit<SuggestionOptions<MentionMember, MentionNodeAttrs>, 'editor'>;

// @public
export function filterMentionMembers(members: MentionMember[], query: string): MentionMember[];

// @public
export function isMentionPickerOpen(): boolean;

// @public
export function Mention({ name }: MentionProps): JSX.Element;

// @public (undocumented)
export interface MentionExtensionOptions {
    resolveName?(id: string): string | undefined;
    suggestion?: MentionOptions['suggestion'];
}

// @public
export const MentionList: ForwardRefExoticComponent<MentionListProps & RefAttributes<HTMLDivElement>>;

// @public (undocumented)
export interface MentionListProps {
    activeIndex?: number;
    emptyLabel?: string;
    members: MentionMember[];
    onSelect?(member: MentionMember): void;
    renderMember?(member: MentionMember): ReactNode;
}

// @public
export interface MentionMember extends CommentAuthor {
    [key: string]: unknown;
    // (undocumented)
    id: string;
    secondary?: string;
    you?: boolean;
}

// @public (undocumented)
export interface MentionProps {
    // (undocumented)
    name: string;
}

// @public (undocumented)
export interface MentionSuggestionOptions {
    editor?: null | Editor;
    renderMember?(member: MentionMember): ReactNode;
}

// (No @packageDocumentation comment for this package)