15 |
16 | /**
17 | * Render prop type.
18 | * @template P Props
19 | * @example
20 | * const children: RenderProp = (props) => ;
21 | */
22 | export type RenderProp = (props: P) => JSX.Element | null
23 |
24 | /**
25 | * The `as` prop.
26 | * @template P Props
27 | */
28 | export type As
= ElementType
29 |
30 | /**
31 | * The `children` prop that supports a function.
32 | * @template T Element type.
33 | */
34 | export type Children =
35 | | ReactNode
36 | | RenderProp & RefAttributes>
37 |
38 | /**
39 | * Props with the `as` prop.
40 | * @template T The `as` prop
41 | * @example
42 | * type ButtonOptions = Options<"button">;
43 | */
44 | export type Options = { as?: T }
45 |
46 | /**
47 | * Props that automatically includes HTML props based on the `as` prop.
48 | * @template O Options
49 | * @example
50 | * type ButtonHTMLProps = HTMLProps>;
51 | */
52 | export type HTMLProps = {
53 | children?: Children
54 | } & Omit>, keyof O>
55 |
56 | /**
57 | * Options & HTMLProps
58 | * @template O Options
59 | * @example
60 | * type ButtonProps = Props>;
61 | */
62 | export type Props = O & HTMLProps
63 |
64 | /**
65 | * A component that supports the `as` prop and the `children` prop as a
66 | * function.
67 | * @template O Options
68 | * @example
69 | * type ButtonComponent = Component>;
70 | */
71 | export type Component = {
72 | (
73 | props: Omit &
74 | Omit>, keyof O> &
75 | Required>,
76 | ): JSX.Element | null
77 | (props: Props): JSX.Element | null
78 | displayName?: string
79 | }
80 |
--------------------------------------------------------------------------------
/test/index.test.ts:
--------------------------------------------------------------------------------
1 | import { test, assert } from "vitest"
2 |
3 | test("simple", () => {
4 | assert.equal("foo", "foo")
5 | })
6 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "jsx": "react",
4 | "target": "es2020",
5 | "module": "esnext",
6 | "strict": true,
7 | "esModuleInterop": true,
8 | "moduleResolution": "node",
9 | "skipLibCheck": true,
10 | "noUnusedLocals": true,
11 | "noImplicitAny": true,
12 | "allowJs": true,
13 | "resolveJsonModule": true
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
12 |
13 |
14 | 
18 |
19 |