@wordpress/components/src/number-control/types.ts

UI components for WordPress.

/**
 * Internal dependencies
 */
import type { InputControlProps } from '../input-control/types';

export type NumberControlProps = Omit<
	InputControlProps,
	'isDragEnabled' | 'min' | 'max' | 'required' | 'step' | 'type' | 'value'
> & {
	/**
	 * If true, the default `input` HTML arrows will be hidden.
	 *
	 * @deprecated
	 * @default false
	 */
	hideHTMLArrows?: boolean;
	/**
	 * The type of spin controls to display. These are buttons that allow the
	 * user to quickly increment and decrement the number.
	 *
	 * - 'none' - Do not show spin controls.
	 * - 'native' - Use browser's native HTML `input` controls.
	 * - 'custom' - Use plus and minus icon buttons.
	 *
	 * @default 'native'
	 */
	spinControls?: 'none' | 'native' | 'custom';
	/**
	 * If true, enables mouse drag gestures.
	 *
	 * @default true
	 */
	isDragEnabled?: InputControlProps[ 'isDragEnabled' ];
	/**
	 * If true, pressing `UP` or `DOWN` along with the `SHIFT` key will increment the
	 * value by the `shiftStep` value.
	 *
	 * @default true
	 */
	isShiftStepEnabled?: boolean;
	/**
	 * The maximum `value` allowed.
	 *
	 * @default Infinity
	 */
	max?: number;
	/**
	 * The minimum `value` allowed.
	 *
	 * @default -Infinity
	 */
	min?: number;
	/**
	 * If `true` enforces a valid number within the control's min/max range.
	 * If `false` allows an empty string as a valid value.
	 *
	 * @default false
	 */
	required?: InputControlProps[ 'required' ];
	/**
	 * Amount to increment by when the `SHIFT` key is held down. This shift value is
	 * a multiplier to the `step` value. For example, if the `step` value is `5`,
	 * and `shiftStep` is `10`, each jump would increment/decrement by `50`.
	 *
	 * @default 10
	 */
	shiftStep?: number;
	/**
	 * Amount by which the `value` is changed when incrementing/decrementing.
	 * It is also a factor in validation as `value` must be a multiple of `step`
	 * (offset by `min`, if specified) to be valid. Accepts the special string value `any`
	 * that voids the validation constraint and causes stepping actions to increment/decrement by `1`.
	 *
	 * @default 1
	 */
	step?: InputControlProps[ 'step' ];
	/**
	 * Optional multiplication factor in spin changes. i.e. A spin changes
	 * by `spinFactor * step` (if `step` is "any", 1 is used instead).
	 *
	 * @default 1
	 */
	spinFactor?: number;
	/**
	 * The `type` attribute of the `input` element.
	 *
	 * @default 'number'
	 */
	type?: InputControlProps[ 'type' ];
	/**
	 * The value of the input.
	 */
	value?: number | string;
	/**
	 * Do not throw a warning for the deprecated 36px default size.
	 * For internal components of other components that already throw the warning.
	 *
	 * @ignore
	 */
	__shouldNotWarnDeprecated36pxSize?: boolean;
};