Skip to content

Fix docs and typescript types #27

@HironTez

Description

@HironTez

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions