Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UncontrolledTextInput wrong typings & docs #72

Open
jrson83 opened this issue Apr 18, 2022 · 0 comments
Open

UncontrolledTextInput wrong typings & docs #72

jrson83 opened this issue Apr 18, 2022 · 0 comments

Comments

@jrson83
Copy link

jrson83 commented Apr 18, 2022

The docs describe the usage of UncontrolledTextInput:

<UncontrolledTextInput onSubmit={handleSubmit} />

With an optional prop initialValue.

The prop typings are wrong. The required/expected prop instead of onSubmit is onChange and it does not accept initialValue at all, instead requires a value.

So the required syntax is:

<UncontrolledTextInput value="whatever" onChange={() => { console.log('whatever')}} />

Also Except should be replaced with Omit to fix:

interface UncontrolledProps extends Omit<Props, 'value' | 'onChange'> {
  /**
   * Initial value.
   */
  initialValue?: string
}
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

No branches or pull requests

1 participant