downshift icon indicating copy to clipboard operation
downshift copied to clipboard

Readme code example doesn't work.

Open swbrenneis opened this issue 3 years ago • 0 comments

  • downshift version: 6.1.7
  • node version: 16.11.0
  • npm (or yarn) version: yarn 1.22.15

Relevant code or config

The code is from the example in the readme

What you did:

Tried to use the example code

What happened:

Does not compile. {...getRootProps({}, {suppressRefError: true})} is invalid since the first argument has a required field, refKey. The argument seems to be a GetRootPropsOptions interface, but there is no documentation of what is in that interface or what the required field is.

Reproduction repository:

Problem description:

Unable to use the readme example as a starter.

Suggested solution:

Document the GetRootPropsOptions interface. Fix the readme example.

swbrenneis avatar Jan 18 '22 18:01 swbrenneis