Prop Tags

Prop tags change the behavior of input controls.

@group

All props with the same group name will be displayed together in the UI.

interface Props {
  /** @group Accessibility */
  label: number;
}

@step

Changes the step amount when using the number increment/decrement buttons.

interface Props {
  /** @step 1 */
  value: number;
}

Supported on prop types: number.

@min

Sets the minimum value for the number control.

interface Props {
  /** @min -3 */
  value: number;
}

Supported on prop types: number.

@max

Sets the maximum value for the number control.

interface Props {
  /** @max 3 */
  value: number;
}

Supported on prop types: number.

Was this page helpful?