Skip to content

Fix typos in documentation - #1509

Open
toyeshhm wants to merge 1 commit into
mlaursen:mainfrom
toyeshhm:fix-doc-typos
Open

toyeshhm wants to merge 1 commit into
mlaursen:mainfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

Copy link
Copy Markdown

Summary

Corrects typos in the documentation site. Two of them change what the docs
tell you the API is.

useElementInteraction publishes a type that does not compile

The Parameters section declares:

export interface ElementInteractionOptions<
  E extends HTMLElement,
> extends Parital<ElementInteractionHandlers<E>> {

Parital is not a TypeScript utility type, so copying this declaration out of
the API docs produces Cannot find name 'Parital'. The source
(packages/core/src/interaction/useElementInteraction.tsx) declares Partial.

useRadioGroup documents a prop name that does not exist

The Returns section lists requried among the props getRadioProps returns,
while the CombinedRadioGroupReturnValue signature immediately below it has
required?: boolean.

Remaining corrections

  • accordian → accordion in the Collapse description and prose, and in the
    alias frontmatter for Collapse and ExpansionPanel — so the correct spelling
    matches when searching the docs
  • constrast → contrast in the keywords frontmatter for contrastColor
    and isContrastCompliant
  • implicity → implicitly in the quoted TypeScript error in the Autocomplete
    demo
  • isntead → instead, simpley → simply, cololrs → colors,
    Diable → Disable (a Button label in the v5-to-v6 guide)
  • doubled words: "the the" in the InitialCoords doc comment on the
    useFixedPositioning page, "to to" in the randomInt description

Documentation only — no source, test or build files touched.

Deliberately left alone

  • transitionIn and initialX/initialY are real prop names, not typos
  • the blog post's exerpt: frontmatter key is misspelled, but blog/data.ts,
    blog/page.tsx and scripts/updateAlgoliaIndex.ts all read exerpt, so
    renaming it here alone would break the blog excerpt. Happy to fix it across
    those files in a separate PR if you want it.

The useElementInteraction API docs published the ElementInteractionOptions
interface as extending `Parital<ElementInteractionHandlers<E>>`. `Parital` is
not a TypeScript utility type, so copying that declaration out of the docs
fails to compile. The source declares `Partial`.

The useRadioGroup docs listed `requried` among the props returned by
`getRadioProps`, contradicting the `required?: boolean` in the type signature
directly below it.

Also corrected in prose, frontmatter and code samples: accordian -> accordion,
constrast -> contrast, implicity -> implicitly, isntead -> instead,
simpley -> simply, cololrs -> colors, Diable -> Disable, and doubled words in
useFixedPositioning ("the the") and randomInt ("to to").
@changeset-bot

changeset-bot Bot commented Sep 25, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2b8fb85

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel

vercel Bot commented Sep 25, 2026

Copy link
Copy Markdown

@toyeshhm is attempting to deploy a commit to the Mikkel Laursen's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the docs label Sep 25, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant