feat: export type

[kiner-tang]

No description provided.

[zpao]

Can you explain what goal you'd like to achieve with this?

[kiner-tang]

Currently, using internal types is cumbersome and requires complex type calculations, so we want to export them directly from the library.

[zpao]

Are you writing a component that wraps and forwards props? That's fair but not clear if that's your intent. I'm not opposed to exporting types but want to be intentional about additional API surface area.

[etienne-beylier]

Are you writing a component that wraps and forwards props? That's fair but not clear if that's your intent. I'm not opposed to exporting types but want to be intentional about additional API surface area.

Hi there, I was in this scenario it would be nice to have access to types?

[zpao]

There are several variations of what people might need and there are utility types which get there, so I'm inclined to just say no here. Also, as would be written, these types are not the whole truth. They don't include the ref or the DOM properties that are supported. In fact I removed DOM specific style from the types in #357 because we get it for free with forwardRef.

For example, to get the full type of props:

import {QRCodeSVG} from 'qrcode.react';
import type {ComponentProps} from 'react';

type QRCodeSVGProps = ComponentProps<typeof QRCodeSVG>

Admittedly, this may not be precisely what you but it will be accurate. You can go a step further if you need just the explicit props, which I did in the tests. As you can see from the comment though, that's really just the make TypeScript happy when creating a bunch of props objects outside normal usage:

qrcode.react/src/__test__/index.test.tsx

Lines 7 to 23 in 1c88a68

	import type {ComponentPropsWithoutRef} from 'react';
	// We're only using the explicit (non-DOM, non-ref) props for testing, but TS
	// doesn't love us passing our test data as props without actually typing the
	// object. So we'll make sure we give types that work. It's a little messy but
	// gets the job done without being too fancy.
	// Specifically, get the DOM-specific keys and omit them from the also-de-ref'ed
	// component props. Then union together the two types since they may not always
	// be the same.
	type QRCodeCanvasProps = Omit<
	ComponentPropsWithoutRef<typeof QRCodeCanvas>,
	keyof React.CanvasHTMLAttributes<HTMLCanvasElement>
	>;
	type QRCodeSVGProps = Omit<
	ComponentPropsWithoutRef<typeof QRCodeSVG>,
	keyof React.SVGProps<SVGSVGElement>
	>;