Skip to content

docs(suggestion-menu): document the suggestion menu - #537

Merged
kianbazza merged 1 commit into
ui-565-add-attachtexttrigger-for-inputs-and-textareasfrom
ui-566-document-the-suggestion-menu
Sep 29, 2026
Merged

kianbazza merged 1 commit into
ui-565-add-attachtexttrigger-for-inputs-and-textareasfrom
ui-566-document-the-suggestion-menu

Conversation

@kianbazza

@kianbazza kianbazza commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Documents SuggestionMenu: a docs page and an API reference, with a live primitive example (@ mentions in a textarea).

The page covers:

  • connecting a host through the handle;
  • text fields with useTextTrigger, including trigger options and replacing the match;
  • editors, with a ProseMirror plugin recipe that includes Escape stickiness;
  • async results, with a TanStack @ mention search using placeholderData: keepPreviousData and debounce, plus the note that deep search's 'block' still shows Loading between searches. A "searching…" indicator reads isAnyFetching from useAsyncMenuCoordinator(), which returns null without asyncContent;
  • noResults;
  • the keymap;
  • placement;
  • accessibility: host attributes by element, aria-activedescendant, the result summary and getAriaResultsText.

SuggestionMenu joins the docs type entry so the API reference tables render. The sidebar lists the page, and the page ends with a link to the API reference, as the dropdown menu's does.

Evidence

  • Forced type-gen adds the SuggestionMenu types, and every type the reference names exists.
  • fumadocs-mdx compiles both pages.
  • apps/web type-checks.
  • Every claim in the page was checked against the code.

Merge Danger

Door: two-way

Blast Radius: docs only (private page)

Closes UI-566

@vercel

vercel Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
ui-canary Ready Ready Preview Sep 29, 2026 2:31pm UTC

Request Review

@kianbazza
kianbazza added this pull request to stack #526 September 29, 2026 02:50
@linear-code

linear-code Bot commented Sep 29, 2026

Copy link
Copy Markdown

UI-566

@kianbazza
kianbazza force-pushed the ui-566-document-the-suggestion-menu branch from d6f3a9f to cdb9e94 Compare September 29, 2026 14:29
@kianbazza
kianbazza marked this pull request as ready for review September 29, 2026 14:46
@kianbazza
kianbazza merged commit b5555d6 into canary Sep 29, 2026
6 of 8 checks passed

This branch was successfully deployed

1 active deployment
Preview – ui-canary — cdb9e943 Deployed Sep 29, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant