Skip to content

Incorrect README example to import components directly #190

@wozzo

Description

@wozzo

From the readme

// Or you can import components directly
import Button from 'nhsuk-react-components/lib/components/button';

But the typescript definitions are in the dist directory so they cannot be found by tsc leading to this error

Could not find a declaration file for module 'nhsuk-react-components/lib/components/button'. '/nodebox/node_modules/.store/nhsuk-react-components@3.0.0/node_modules/nhsuk-react-components/lib/components/button/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/nhsuk-react-components` if it exists or add a new declaration (.d.ts) file containing `declare module 'nhsuk-react-components/lib/components/button';`typescript(7016)

See example sandbox.

If the rollup operation was modified to output to the lib folder then this would mean the types will all be present, but I'm not familiar enough with rollup to know what other effects this could have.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions