Conversation
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").
|
|
@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. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects typos in the documentation site. Two of them change what the docs
tell you the API is.
useElementInteractionpublishes a type that does not compileThe Parameters section declares:
Paritalis not a TypeScript utility type, so copying this declaration out ofthe API docs produces
Cannot find name 'Parital'. The source(
packages/core/src/interaction/useElementInteraction.tsx) declaresPartial.useRadioGroupdocuments a prop name that does not existThe Returns section lists
requriedamong the propsgetRadioPropsreturns,while the
CombinedRadioGroupReturnValuesignature immediately below it hasrequired?: boolean.Remaining corrections
accordian→accordionin the Collapse description and prose, and in thealiasfrontmatter for Collapse and ExpansionPanel — so the correct spellingmatches when searching the docs
constrast→contrastin thekeywordsfrontmatter forcontrastColorand
isContrastCompliantimplicity→implicitlyin the quoted TypeScript error in the Autocompletedemo
isntead→instead,simpley→simply,cololrs→colors,Diable→Disable(a Button label in the v5-to-v6 guide)InitialCoordsdoc comment on theuseFixedPositioning page, "to to" in the
randomIntdescriptionDocumentation only — no source, test or build files touched.
Deliberately left alone
transitionInandinitialX/initialYare real prop names, not typosexerpt:frontmatter key is misspelled, butblog/data.ts,blog/page.tsxandscripts/updateAlgoliaIndex.tsall readexerpt, sorenaming it here alone would break the blog excerpt. Happy to fix it across
those files in a separate PR if you want it.