Skip to content

Input

EInput allows users to enter and amend text or numeric values on a single line. Demo Here

Import

jsx
import EInput from "@components/Form/EInput";

Usage

jsx
const InputExample = () => {
    const [value, setValue] = useState("");

    const changeHandler = (event) => {
        setValue(event.value.target);
    };

    return <EInput label="First Name" onChange={changeHandler} value={value}/>;
};

export default InputExample;

Props

For EInput component, the following props are available:

PropTypeDefaultNote
valueString-The value of the input element, required for a controlled component.
labelnode-Component's label
idString-HTML id attribute.
disabledBooleanfalseDisables the EInput.
typeString"text"Html input type attribute.
width[String, Number]-Sets the component's width. Default unit is px.
variantString"fill"The EInput element can be represented in four ways: fill and border.
messageString-Adds a message below the input.
squareBooleanfalseSquares the corners of the input.
classNameString-Overrides or extends the component's styles.
nameString-HTML name attribute..
requiredBooleanfalseIndicates that the user must specify a value for the input.
readOnlyBooleanfalseSame as readonly in native input makes the element not mutable.
sizeString"md"The EInput element has three predefined sizes: sm, md, lg.
validateOnString"input"Triggers validation on @values: submit, input, blur.
rulesArray-Validation rules. For more info refer to Form Validation.
stateString-Validates the user-provided data against established criteria and performs display validation. States can be none if no validation is necessary, danger if the selected is valid, or success if it is acceptable.
placeholderString-Defines a placeholder displayed in a form control when the control has no value.
colorString"primary"The given color is applied to the element - utility colors are supported (e.g primary or danger). you'll find a list of built-in classes on the src/styles/_vars.scsspage.
appendIconObject-Inserts a custom EIcon element to the input that is located after the input value. More Info here.
prependIconObject-Inserts a custom EIcon element to the input that is located before the input value. More Info here.

Callback Functions

The EInput component contains following callback functions.

FunctionDescription
onChangeControls the input. function(event: React.SyntheticEvent) => void 👇

event: The event triggers every time after a value is modified by the user.
onAppendIconClickFires a function when the append icon is clicked.
onPrependIconClickFires a function when the prepend icon is clicked.

COPYRIGHT