Categories
TypeScript Answers

How to add types for rest props in React and TypeScript?

Spread the love

Sometimes, we want to add types for rest props in React and TypeScript.

In this article, we’ll look at how to add types for rest props in React and TypeScript.

How to add types for rest props in React and TypeScript?

To add types for rest props in React and TypeScript, we can add an index signature into the prop’s type.

For instance, we write

type Props = {
  id: number;
  name: string;
  [x: string]: any;
};

const MyComponent: React.FC<Props> = (props) => {
  //...
};

to add the Props type that has the

[x: string]: any;

index signature that lets us allow any property in props.

Then we can access any property in addition to id and name without errors.

Conclusion

To add types for rest props in React and TypeScript, we can add an index signature into the prop’s type.

By John Au-Yeung

Web developer specializing in React, Vue, and front end development.

One reply on “How to add types for rest props in React and TypeScript?”

This removes type checking completely for the other required props. In your example that would make id and name not required anymore.

Leave a Reply

Your email address will not be published. Required fields are marked *