InputGroup

InputGroup

Input group is used for collecting data entered by users. It usually contains buttons, text areas or other inputs. With this component, your forms are attractive and easy to customize.

Basic input with appended text after

Default InputGroup example.

@example.com
import React from "react";
import { CDBInputGroup, CDBContainer } from "cdbreact";
const InputGroup = () => {
return (
<CDBContainer>
<CDBInputGroup
hint="Recipient's username"
containerClassName="mb-3 mt-0"
append="@example.com"
/>
</CDBContainer>
);
};
export default InputGroup;

Basic input with appended text before

@
import React from "react";
import { CDBInputGroup, CDBContainer } from "cdbreact";
const InputGroup = () => {
return (
<CDBContainer>
<CDBInputGroup
containerClassName="flex-nowrap mb-3"
prepend="@"
hint="Username"
/>
</CDBContainer>
);
};
export default InputGroup;

Run function on icon click

import React from "react";
import { CDBInputGroup, CDBContainer } from "cdbreact";
const InputGroup = () => {
return (
<CDBContainer>
<CDBInputGroup
icon="bell"
onIconClick={() => alert("Wait! This is an alert!")}
/>
</CDBContainer>
);
};
export default InputGroup;

Small input group

Small
import React from "react";
import { CDBInputGroup, CDBContainer } from "cdbreact";
const InputGroup = () => {
return (
<CDBContainer>
<CDBInputGroup
containerClassName="mb-2 mt-0"
prepend="Small"
size="sm"
/>
</CDBContainer>
);
};
export default InputGroup;

Large input group

Large
import React from "react";
import { CDBInputGroup, CDBContainer } from "cdbreact";
const InputGroup = () => {
return (
<CDBContainer>
<CDBInputGroup
containerClassName="mb-2 mt-0"
prepend="Large"
size="lg"
/>
</CDBContainer>
);
};
export default InputGroup;

Input group with checkbox

import React from "react";
import { CDBInputGroup, CDBInput, CDBContainer } from "cdbreact";
const InputGroup = () => {
return (
<CDBContainer>
<CDBInputGroup
prepend={
<div className="input-group-text md-addon">
<input type="checkbox"/>
</div>
}
/>
</CDBContainer>
);
};
export default InputGroup;

Basic input

import React from "react";
import { CDBInputGroup, CDBInput, CDBContainer } from "cdbreact";
const InputGroup = () => {
return (
<CDBContainer>
<CDBInputGroup/>
</CDBContainer>
);
};
export default InputGroup;

API

In this section you will find advanced information about the InputGroup component. You will find out which modules are required, what are the possibilities of configuring the component, and what events and methods you can use to work with it.

Contrast InputGroup Import Statement

You need to import the Contrast InputGroup component first before using it.

import { CDBInputGroup } from "cdbreact";

API Reference: Contrast InputGroup Properties

The table below shows the configuration options of the CDBInputGroup component.

NameTypeDefaultDescriptionExample
classNameStringAdds custom classesAdds custom classes<CDBInputGroup className="myClass" ... />
containerClassNameStringAdds custom class to wrapper div<CDBInputGroup containerClassName="wrapper" ... />
containerIdStringAdds custom Id to wrapper div<CDBInputGroup containerId="id" ... />
hintStringSets the placeholder for the Input<CDBInputGroup hint="placeholder" ... />
idStringRequired! Set the id of the input element<CDBInputGroup id="myId" ... />
inputnodeReplaces default input for your custom elements<MDBInputGroup inputs={ <select className="browser-default custom-select" ...> <option value="0" ...>Choose< .../option> <option value="1" ...>One< .../option> <... /select>} .../>
tagStringdivChanges default input tag<CDBInputGroup tag="section" ... />
labelString or BooleandivAdds label for your input<CDBInputGroup group ... />
labelClassNameStringdivAdds custom class to the label<CDBInputGroup labelClassName="labelCustomClass" ... />
appendNode or StringnullAdds suffix for your input<CDBInputGroup append={
Send
} ... /> <CDBInputGroup append="@gmail.com" .../>
appendClassNamesStringAdds custom class to Input Group append element<CDBInputGroup appendClassNames="font-italic" .../>
prependClassNamesStringAdds custom class to Input Group prepend element<CDBInputGroup prependClassNames="font-italic" .../>
sizeStringlgChanges size of the component; available lg and sm<CDBInputGroup size="lg" ... />
typeStringtextThe type of the input element<CDBInputGroup type="textarea" ... />
validateBooleanfalseAdds .validate class to the Input component<CDBInputGroup validate .../>
valueNumber, Boolean or StringThe value of the input element (use with the controlled input)<CDBInputGroup value="I am controlled" onChange={this.handleChange} ... />
valueDefaultNumber or StringThe default value of the input (use with the uncontrolled input)<CDBInputGroup valueDefault="I am uncontrolled" ... />
arialLabelStringAdds custom aria-label text for input element<CDBInputGroup arialLabel="close" .../>
materialBooleanfalseChanges component styles for material theme<CDBInputGroup material .../>