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><CDBInputGrouphint="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><CDBInputGroupcontainerClassName="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><CDBInputGroupicon="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><CDBInputGroupcontainerClassName="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><CDBInputGroupcontainerClassName="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><CDBInputGroupprepend={<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.
| Name | Type | Default | Description | Example |
|---|---|---|---|---|
| className | String | Adds custom classes | Adds custom classes | <CDBInputGroup className="myClass" ... /> |
| containerClassName | String | Adds custom class to wrapper div | <CDBInputGroup containerClassName="wrapper" ... /> | |
| containerId | String | Adds custom Id to wrapper div | <CDBInputGroup containerId="id" ... /> | |
| hint | String | Sets the placeholder for the Input | <CDBInputGroup hint="placeholder" ... /> | |
| id | String | Required! Set the id of the input element | <CDBInputGroup id="myId" ... /> | |
| input | node | Replaces 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>} .../> | |
| tag | String | div | Changes default input tag | <CDBInputGroup tag="section" ... /> |
| label | String or Boolean | div | Adds label for your input | <CDBInputGroup group ... /> |
| labelClassName | String | div | Adds custom class to the label | <CDBInputGroup labelClassName="labelCustomClass" ... /> |
| append | Node or String | null | Adds suffix for your input | <CDBInputGroup append={ Send } ... /> <CDBInputGroup append="@gmail.com" .../> |
| appendClassNames | String | Adds custom class to Input Group append element | <CDBInputGroup appendClassNames="font-italic" .../> | |
| prependClassNames | String | Adds custom class to Input Group prepend element | <CDBInputGroup prependClassNames="font-italic" .../> | |
| size | String | lg | Changes size of the component; available lg and sm | <CDBInputGroup size="lg" ... /> |
| type | String | text | The type of the input element | <CDBInputGroup type="textarea" ... /> |
| validate | Boolean | false | Adds .validate class to the Input component | <CDBInputGroup validate .../> |
| value | Number, Boolean or String | The value of the input element (use with the controlled input) | <CDBInputGroup value="I am controlled" onChange={this.handleChange} ... /> | |
| valueDefault | Number or String | The default value of the input (use with the uncontrolled input) | <CDBInputGroup valueDefault="I am uncontrolled" ... /> | |
| arialLabel | String | Adds custom aria-label text for input element | <CDBInputGroup arialLabel="close" .../> | |
| material | Boolean | false | Changes component styles for material theme | <CDBInputGroup material .../> |