Updating Props

Considerations

Components should be performant, accessible, and maintainable. When contributing a new prop or updating the types of an existing prop, ask yourself how your change might:

  • Be backwards compatible
  • Increase or maintain performance
  • Improve or maintain accessibility
  • Address a pain point in the consumer experience
  • Reduce complexity of the source code

If a component isn't flexible enough to meet your project's requirements, or if you're unsure whether a component is right for your use case, contact our UX to discuss and evaluate. We're happy to collaborate to find a solution.


How to contribute

To add or update a prop:

  1. Explore and align on whether to add a new prop or update the types of an existing prop.
  2. Add your change to the props interface.
  3. Write or update the prop's description comment in the same change. Write it in present tense, start with a verb and end with a period, for example Controls the size of the input. One sentence is enough for most props; add a second when the prop only applies under a condition or needs more detail. The docs site shows it in the props table, so a prop without one is incomplete.
  4. Update the @default value if relevant in the props interface.
  5. Add tests to cover the changes.
  6. Commit your changes and open a pull request.





Last updated: 15 October 2026

Did this help?