actify icon indicating copy to clipboard operation
actify copied to clipboard

Fix docs and typescript types

Open HironTez opened this issue 1 year ago • 3 comments

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 avatar Nov 14 '24 09:11 HironTez

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

HironTez avatar Nov 14 '24 10:11 HironTez

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.

HironTez avatar Nov 14 '24 10:11 HironTez

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.

lerte avatar Nov 14 '24 10:11 lerte