EntitiesOption

type EntitiesOption = {
  onClick?: (entity: Entity) => void;
  onRequestPreview?: (entity: Entity) => Promise<{
    preview: BasicRoot | null;
  }>;
  onTagSearch?: (query: string) => Promise<Entity[]>;
  showComposerMenu?: boolean;
};

Properties

onClick()?

optional onClick: (entity: Entity) => void;

Called when a rendered entity is clicked.

Parameters

Parameter	Type
entity	Entity

Returns

void

---

onRequestPreview()?

optional onRequestPreview: (entity: Entity) => Promise<{
  preview:   | BasicRoot
     | null;
}>;

Use the Widget Studio (https://widget-studio.vercel.app/) to design previews and copy the generated JSON into your integration.

Parameters

Parameter	Type
entity	Entity

Returns

Promise<{ preview: | BasicRoot | null; }>

---

onTagSearch()?

optional onTagSearch: (query: string) => Promise<Entity[]>;

Returns a list of entities for the input query. Powers tag autocomplete within the composer.

Parameters

Parameter	Type
query	string

Returns

Promise<Entity[]>

---

showComposerMenu?

optional showComposerMenu: boolean;

Whether to render a composer button that inserts ”@” into the textarea and triggers a tag search on click. Only renders when EntitiesOption.onTagSearch is provided.

Default

false;