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

Fix docs and typescript types #27

Open
HironTez opened this issue Nov 14, 2024 · 3 comments
Open

Fix docs and typescript types #27

HironTez opened this issue Nov 14, 2024 · 3 comments

Comments

@HironTez
Copy link
Contributor

HironTez commented Nov 14, 2024

Describe the bug

  • Please fix the docs.

The docs are often misleading. For example, it says there is a "disabled" property in the TextField component when it's actually "isDisabled".

Also, I would never know that you should use "onPress" instead of "onClick" if I hadn't seen react-aria's warning in the browser console. The onClick doesn't work on mobile.

And there's a plenty of properties missing in the docs, like Checkbox "variant".

  • Please fix the typescript types.

Some properties are missing in types, e.g. "label" in TextField. Types of some components just don't work, for example types of Checkbox and Button

Desktop.

  • OS: Ubuntu 24
  • Browser: Chrome, Firefox
  • Version: latest

Smartphone.

  • OS: Android 15
  • Browser: Chrome Android, Firefox Android
  • Version: latest

I like this library overall and look forward to seeing improvements

@HironTez
Copy link
Contributor Author

Upd: it's very strange but all the types have been fixed once i installed "@react-spectrum/toast"

@HironTez
Copy link
Contributor Author

I've checked it multiple times and types don't work correctry without react-spectrum. As a temporary fix i've added it to the devDependencies in my package.json.

@lerte
Copy link
Contributor

lerte commented Nov 14, 2024

You are right, I am currently refactoring my components to use react-aria.
So the documentation is not up to date.
Thanks for your feedback.

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

2 participants