@mui/joy/Input/InputProps.d.ts

Joy UI is an open-source React component library that implements MUI's own design principles. It's comprehensive and can be used in production out of the box.

import * as React from 'react';
import { OverridableStringUnion, OverrideProps } from '@mui/types';
import { ApplyColorInversion, ColorPaletteProp, SxProps, VariantProp } from '../styles/types';
import { CreateSlotsAndSlotProps, SlotProps } from '../utils/types';
export type InputSlot = 'root' | 'input' | 'startDecorator' | 'endDecorator';
export interface InputSlots {
    /**
     * The component that renders the root.
     * @default 'div'
     */
    root?: React.ElementType;
    /**
     * The component that renders the input.
     * @default 'input'
     */
    input?: React.ElementType;
    /**
     * The component that renders the start decorator.
     * @default 'div'
     */
    startDecorator?: React.ElementType;
    /**
     * The component that renders the end decorator.
     * @default 'div'
     */
    endDecorator?: React.ElementType;
}
export interface InputPropsVariantOverrides {
}
export interface InputPropsColorOverrides {
}
export interface InputPropsSizeOverrides {
}
export type InputSlotsAndSlotProps = CreateSlotsAndSlotProps<InputSlots, {
    root: SlotProps<'div', {}, InputOwnerState>;
    input: SlotProps<'input', {}, InputOwnerState>;
    startDecorator: SlotProps<'span', {}, InputOwnerState>;
    endDecorator: SlotProps<'span', {}, InputOwnerState>;
}>;
export interface InputTypeMap<P = {}, D extends React.ElementType = 'div'> {
    props: P & Pick<React.InputHTMLAttributes<HTMLInputElement>, 'autoComplete' | 'autoFocus' | 'onClick' | 'onChange' | 'onKeyDown' | 'onKeyUp' | 'onFocus' | 'onBlur' | 'defaultValue' | 'value' | 'type' | 'placeholder' | 'readOnly' | 'required' | 'name' | 'id' | 'disabled'> & {
        /**
         * Class name applied to the root element.
         */
        className?: string;
        /**
         * The color of the component. It supports those theme colors that make sense for this component.
         * @default 'neutral'
         */
        color?: OverridableStringUnion<ColorPaletteProp, InputPropsColorOverrides>;
        /**
         * Trailing adornment for this input.
         */
        endDecorator?: React.ReactNode;
        /**
         * If `true`, the `input` will indicate an error.
         * The prop defaults to the value (`false`) inherited from the parent FormControl component.
         * @default false
         */
        error?: boolean;
        /**
         * If `true`, the input will take up the full width of its container.
         * @default false
         */
        fullWidth?: boolean;
        /**
         * Leading adornment for this input.
         */
        startDecorator?: React.ReactNode;
        /**
         * The size of the component.
         * @default 'md'
         */
        size?: OverridableStringUnion<'sm' | 'md' | 'lg', InputPropsSizeOverrides>;
        /**
         * The system prop that allows defining system overrides as well as additional CSS styles.
         */
        sx?: SxProps;
        /**
         * The [global variant](https://mui.com/joy-ui/main-features/global-variants/) to use.
         * @default 'outlined'
         */
        variant?: OverridableStringUnion<VariantProp, InputPropsVariantOverrides>;
    } & InputSlotsAndSlotProps;
    defaultComponent: D;
}
export type InputProps<D extends React.ElementType = InputTypeMap['defaultComponent'], P = {
    component?: React.ElementType;
}> = OverrideProps<InputTypeMap<P, D>, D>;
export default InputProps;
export interface InputOwnerState extends ApplyColorInversion<InputProps> {
    /**
     * If `true`, the input is focused.
     */
    focused: boolean;
    /**
     * @internal
     */
    instanceColor?: OverridableStringUnion<ColorPaletteProp, InputPropsColorOverrides>;
}