8

Let's say I want to create a custom div component call MyDiv with additional attributes, eg.

interface MyDivProps {
  marginX: string;
  marginY: string;
}

but I still want to have all the type checking for regular HTMLDivElement, so what I want is actually something like:

interface MyDivProps implements JSX.IntrinsicElement.div {
      marginX: string;
      marginY: string;
    }

(I use JSX.IntrinsicElement.div instead of HTMLDivElement because it has additional React div attribute such as ref)

Obviously this won't work because interface cannot implements another interface, also IntrinsicElements is not exposed.

What would be the correct way to do this?

2 Answers 2

8

The syntax you are looking for is:

type DivProps = JSX.IntrinsicElements["div"];
interface MyDivProps extends DivProps {
  marginX: string;
  marginY: string;
}

(TypeScript has a restriction that an interface can only extend a dotted name, so you have to define a type alias for JSX.IntrinsicElements["div"] before you can extend it.)

3
  • but is this a correct way to do it? I haven't seen other places doing this
    – Yichz
    Commented Sep 4, 2018 at 19:49
  • 1
    Come to your own conclusion. There's a similar scenario here, but I like your idea of referencing JSX.IntrinsicElements["div"] directly since its definition might change in future versions of React. Commented Sep 4, 2018 at 19:55
  • I really like this solution, much cleaner than others I tried imo
    – Jeremy
    Commented Aug 25, 2021 at 5:57
0

Intersection type:

type DivProps = JSX.IntrinsicElements['div'] & {
  marginX: string
  marginY: string
}

Not the answer you're looking for? Browse other questions tagged or ask your own question.