Skip to content

fix(docsite): add example and usage guidance for BaseTypeahead (#2679)#3284

Open
mohitWeb-lab wants to merge 2 commits into
facebook:mainfrom
mohitWeb-lab:docsite/issue-2679-basetypeahead-example
Open

fix(docsite): add example and usage guidance for BaseTypeahead (#2679)#3284
mohitWeb-lab wants to merge 2 commits into
facebook:mainfrom
mohitWeb-lab:docsite/issue-2679-basetypeahead-example

Conversation

@mohitWeb-lab

Copy link
Copy Markdown
Contributor

Summary

The BaseTypeahead docsite page had no meaningful example and no usage guidance, leaving an empty Examples section and no playground link. It was also unclear whether the component was intended for direct use or was a primitive backing higher-level components.

Cause

BaseTypeahead had no usage section in its doc and no example blocks registered under exampleFor: 'BaseTypeahead'. The component is a headless primitive (subComponentOf: 'Typeahead', isHiddenFromOverview: true) used internally by Typeahead and Tokenizer, so no examples were ever authored for it. Without guidance, the page silently showed nothing.

Fix

  • Added a usage section to BaseTypeahead.doc.mjs with a description matching the existing component description, 3 Do / 2 Don't best practices aligned to its "no wrapper, no border, no token rendering" nature, and relatedComponents: ['Typeahead', 'Tokenizer'] to surface links to the correct higher-level components.
  • Added a BaseTypeaheadCustomSearch example block showing BaseTypeahead embedded inside a custom-styled HStack wrapper with its own border and search icon, demonstrating the anchorRef pattern and createStaticSource — the exact composition use case the component is designed for.

Closes #2679

@vercel

vercel Bot commented Jun 30, 2026

Copy link
Copy Markdown

@mohitWeb-lab is attempting to deploy a commit to the Meta Open Source Team on Vercel.

A member of the Team first needs to authorize it.

@meta-cla

meta-cla Bot commented Jun 30, 2026

Copy link
Copy Markdown

Hi @mohitWeb-lab!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jul 1, 2026
@meta-cla

meta-cla Bot commented Jul 1, 2026

Copy link
Copy Markdown

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
astryx Ready Ready Preview, Comment Jul 1, 2026 6:18pm

Request Review

@cixzhang cixzhang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! Looks like build has failed:

Error: src/Typeahead/BaseTypeahead.doc.mjs(11,3): error TS2353: Object literal may only specify known properties, and 'relatedComponents' does not exist in type 'ComponentDoc'.
/home/runner/work/astryx/astryx/packages/core:
 ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL  @astryxdesign/core@0.1.2 typecheck:docs: `tsc --project tsconfig.docs.json`
Exit status 2
 WARN   Local package.json exists, but node_modules missing, did you mean to install?
 ```

…ponentDoc

SubComponentDoc does not support relatedComponents; the field is only
valid on ComponentEntry and HookDoc, causing a typecheck failure.
@mohitWeb-lab mohitWeb-lab requested a review from cixzhang July 2, 2026 04:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] [bug-bash] BaseTypeahead: no meaningful example on docsite

2 participants