Skip to content

Project is poorly documented / needs a re-documentation #254

@stavlocker

Description

@stavlocker

I'm editing this once again for another problem that also has to do with the documentation.

Hi. I love this project, it's helped me a lot. But it's really underdocumented. The first thing that's not documented at all is programmatically clearing the input's value. It took me a lot of time to find the solution, which is the Typeahead ref

//In constructor:
this.typeaheadRef = React.createRef();
//Prop on the Typeahead component:
ref={this.typeaheadRef}
//Resetting:
this.typeaheadRef.current.setEntryText("");

Not only this feature isn't documented here, the word ref isn't mentioned once in the README.md. Once. (Ctrl + F > ref)

Another feature that's not documented that I luckily found out about is that Typeahead actually does support arrow key navigation between options, but it doesn't show - it just gives the hover class to the element in focus. That's fine as a solution, but once again it's not mentioned anywhere.

The project really needs a re-documentation or just a fixing of the documentation to include all those features that make the project even better but aren't shown anywhere.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions