Skip to Content

Input with decorations

Input component with various additional decorations

import * as React from 'react';
import { InputWithDecorations, Icon } from '@itwin/itwinui-react';
import { SvgStar, SvgInfo } from '@itwin/itwinui-icons-react';

export default () => {
  return (
    <InputWithDecorations>
      <InputWithDecorations.Icon>
        <SvgInfo />
      </InputWithDecorations.Icon>
      <InputWithDecorations.Input placeholder='Input with decorations' />
      <InputWithDecorations.Button label='Icon button'>
        <SvgStar />
      </InputWithDecorations.Button>
    </InputWithDecorations>
  );
};

Add icons, buttons and other various subcomponents to input.

import * as React from 'react';
import { InputWithDecorations, Text, Divider } from '@itwin/itwinui-react';
import {
  SvgCaretUpSmall,
  SvgCaretDownSmall,
  SvgSearch,
} from '@itwin/itwinui-icons-react';

export default () => {
  return (
    <InputWithDecorations>
      <InputWithDecorations.Icon>
        <SvgSearch />
      </InputWithDecorations.Icon>
      <InputWithDecorations.Input placeholder='Search...' />
      <Text className='demo-text'>0 / 5</Text>
      <Divider orientation='vertical' />
      <InputWithDecorations.Button label='Next result'>
        <SvgCaretDownSmall />
      </InputWithDecorations.Button>
      <InputWithDecorations.Button label='Previous result'>
        <SvgCaretUpSmall />
      </InputWithDecorations.Button>
    </InputWithDecorations>
  );
};

Status

InputWithDecorations can have positive, warning, or negative statuses.

import * as React from 'react';
import { InputWithDecorations, Icon } from '@itwin/itwinui-react';
import { SvgAdd, SvgPlaceholder } from '@itwin/itwinui-icons-react';

export default () => {
  return (
    <div className='demo-container'>
      <InputWithDecorations status='positive'>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Positive input' />
        <InputWithDecorations.Button label='Add'>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
      <InputWithDecorations status='warning'>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Warning input' />
        <InputWithDecorations.Button label='Add'>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
      <InputWithDecorations status='negative'>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Negative input' />
        <InputWithDecorations.Button label='Add'>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
    </div>
  );
};

Sizes

We support small, default and large size InputWithDecorations.

import * as React from 'react';
import { InputWithDecorations, Icon } from '@itwin/itwinui-react';
import { SvgAdd, SvgPlaceholder } from '@itwin/itwinui-icons-react';

export default () => {
  return (
    <div className='demo-container'>
      <InputWithDecorations size='small'>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Small input' />
        <InputWithDecorations.Button label='Add'>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
      <InputWithDecorations>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Default input' />
        <InputWithDecorations.Button label='Add'>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
      <InputWithDecorations size='large'>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Large input' />
        <InputWithDecorations.Button label='Add'>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
    </div>
  );
};

Disabled

You can also disable whole component or just parts of it.

import * as React from 'react';
import { InputWithDecorations, Icon } from '@itwin/itwinui-react';
import { SvgAdd, SvgPlaceholder } from '@itwin/itwinui-icons-react';

export default () => {
  return (
    <div className='demo-container'>
      <InputWithDecorations isDisabled>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Disabled input' />
        <InputWithDecorations.Button label='Add'>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
      <InputWithDecorations>
        <InputWithDecorations.Icon>
          <SvgPlaceholder />
        </InputWithDecorations.Icon>
        <InputWithDecorations.Input placeholder='Disabled input' />
        <InputWithDecorations.Button label='Add' disabled>
          <SvgAdd />
        </InputWithDecorations.Button>
      </InputWithDecorations>
    </div>
  );
};

Props

Prop Description Default
ref
RefObject<HTMLDivElement> | ((instance: HTMLDivElement) => void)
key
Key
defaultChecked
boolean
defaultValue
string | number | readonly string[]
suppressContentEditableWarning
boolean
suppressHydrationWarning
boolean
accessKey
string
autoFocus
boolean
className
string
contentEditable
Booleanish | "inherit"
contextMenu
string
dir
string
draggable
Booleanish
hidden
boolean
id
string
lang
string
nonce
string
placeholder
string
slot
string
spellCheck
Booleanish
style
CSSProperties
tabIndex
number
title
string
translate
"yes" | "no"
radioGroup
string
role
AriaRole
about
string
content
string
datatype
string
inlist
any
prefix
string
property
string
rel
string
resource
string
rev
string
typeof
string
vocab
string
autoCapitalize
string
autoCorrect
string
autoSave
string
color
string
itemProp
string
itemScope
boolean
itemType
string
itemID
string
itemRef
string
results
number
security
string
unselectable
"on" | "off"
inputMode
Hints at the type of data that might be entered by the user while editing the element or its contents @see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
"search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal"
is
Specify that a standard HTML element should behave like a defined custom built-in element @see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is
string
aria-activedescendant
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
string
aria-atomic
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Booleanish
aria-autocomplete
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
"list" | "none" | "inline" | "both"
aria-braillelabel
Defines a string value that labels the current element, which is intended to be converted into Braille. @see aria-label.
string
aria-brailleroledescription
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. @see aria-roledescription.
string
aria-busy
Booleanish
aria-checked
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected.
boolean | "true" | "false" | "mixed"
aria-colcount
Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex.
number
aria-colindex
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan.
number
aria-colindextext
Defines a human readable text alternative of aria-colindex. @see aria-rowindextext.
string
aria-colspan
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan.
number
aria-controls
Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns.
string
aria-current
Indicates the element that represents the current item within a container or set of related elements.
boolean | "time" | "step" | "true" | "false" | "page" | "location" | "date"
aria-describedby
Identifies the element (or elements) that describes the object. @see aria-labelledby
string
aria-description
Defines a string value that describes or annotates the current element. @see related aria-describedby.
string
aria-details
Identifies the element that provides a detailed, extended description for the object. @see aria-describedby.
string
aria-disabled
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly.
Booleanish
aria-dropeffect
Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1
"link" | "none" | "copy" | "execute" | "move" | "popup"
aria-errormessage
Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby.
string
aria-expanded
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Booleanish
aria-flowto
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
string
aria-grabbed
Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1
Booleanish
aria-haspopup
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"
aria-hidden
Indicates whether the element is exposed to an accessibility API. @see aria-disabled.
Booleanish
aria-invalid
Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage.
boolean | "true" | "false" | "grammar" | "spelling"
aria-keyshortcuts
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
string
aria-label
Defines a string value that labels the current element. @see aria-labelledby.
string
aria-labelledby
Identifies the element (or elements) that labels the current element. @see aria-describedby.
string
aria-level
Defines the hierarchical level of an element within a structure.
number
aria-live
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
"off" | "assertive" | "polite"
aria-modal
Indicates whether an element is modal when displayed.
Booleanish
aria-multiline
Indicates whether a text box accepts multiple lines of input or only a single line.
Booleanish
aria-multiselectable
Indicates that the user may select more than one item from the current selectable descendants.
Booleanish
aria-orientation
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
"horizontal" | "vertical"
aria-owns
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. @see aria-controls.
string
aria-placeholder
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
string
aria-posinset
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize.
number
aria-pressed
Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected.
boolean | "true" | "false" | "mixed"
aria-readonly
Indicates that the element is not editable, but is otherwise operable. @see aria-disabled.
Booleanish
aria-relevant
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic.
"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
aria-required
Indicates that user input is required on the element before a form may be submitted.
Booleanish
aria-roledescription
Defines a human-readable, author-localized description for the role of an element.
string
aria-rowcount
Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex.
number
aria-rowindex
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan.
number
aria-rowindextext
Defines a human readable text alternative of aria-rowindex. @see aria-colindextext.
string
aria-rowspan
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan.
number
aria-selected
Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed.
Booleanish
aria-setsize
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset.
number
aria-sort
Indicates if items in a table or grid are sorted in ascending or descending order.
"none" | "ascending" | "descending" | "other"
aria-valuemax
Defines the maximum allowed value for a range widget.
number
aria-valuemin
Defines the minimum allowed value for a range widget.
number
aria-valuenow
Defines the current value for a range widget. @see aria-valuetext.
number
aria-valuetext
Defines the human readable text alternative of aria-valuenow for a range widget.
string
dangerouslySetInnerHTML
{ __html: string | TrustedHTML; }
onCopy
ClipboardEventHandler<HTMLDivElement>
onCopyCapture
ClipboardEventHandler<HTMLDivElement>
onCut
ClipboardEventHandler<HTMLDivElement>
onCutCapture
ClipboardEventHandler<HTMLDivElement>
onPaste
ClipboardEventHandler<HTMLDivElement>
onPasteCapture
ClipboardEventHandler<HTMLDivElement>
onCompositionEnd
CompositionEventHandler<HTMLDivElement>
onCompositionEndCapture
CompositionEventHandler<HTMLDivElement>
onCompositionStart
CompositionEventHandler<HTMLDivElement>
onCompositionStartCapture
CompositionEventHandler<HTMLDivElement>
onCompositionUpdate
CompositionEventHandler<HTMLDivElement>
onCompositionUpdateCapture
CompositionEventHandler<HTMLDivElement>
onFocus
FocusEventHandler<HTMLDivElement>
onFocusCapture
FocusEventHandler<HTMLDivElement>
onBlur
FocusEventHandler<HTMLDivElement>
onBlurCapture
FocusEventHandler<HTMLDivElement>
onChange
FormEventHandler<HTMLDivElement>
onChangeCapture
FormEventHandler<HTMLDivElement>
onBeforeInput
FormEventHandler<HTMLDivElement>
onBeforeInputCapture
FormEventHandler<HTMLDivElement>
onInput
FormEventHandler<HTMLDivElement>
onInputCapture
FormEventHandler<HTMLDivElement>
onReset
FormEventHandler<HTMLDivElement>
onResetCapture
FormEventHandler<HTMLDivElement>
onSubmit
FormEventHandler<HTMLDivElement>
onSubmitCapture
FormEventHandler<HTMLDivElement>
onInvalid
FormEventHandler<HTMLDivElement>
onInvalidCapture
FormEventHandler<HTMLDivElement>
onLoad
ReactEventHandler<HTMLDivElement>
onLoadCapture
ReactEventHandler<HTMLDivElement>
onError
ReactEventHandler<HTMLDivElement>
onErrorCapture
ReactEventHandler<HTMLDivElement>
onKeyDown
KeyboardEventHandler<HTMLDivElement>
onKeyDownCapture
KeyboardEventHandler<HTMLDivElement>
onKeyPress
@deprecated
KeyboardEventHandler<HTMLDivElement>
onKeyPressCapture
@deprecated
KeyboardEventHandler<HTMLDivElement>
onKeyUp
KeyboardEventHandler<HTMLDivElement>
onKeyUpCapture
KeyboardEventHandler<HTMLDivElement>
onAbort
ReactEventHandler<HTMLDivElement>
onAbortCapture
ReactEventHandler<HTMLDivElement>
onCanPlay
ReactEventHandler<HTMLDivElement>
onCanPlayCapture
ReactEventHandler<HTMLDivElement>
onCanPlayThrough
ReactEventHandler<HTMLDivElement>
onCanPlayThroughCapture
ReactEventHandler<HTMLDivElement>
onDurationChange
ReactEventHandler<HTMLDivElement>
onDurationChangeCapture
ReactEventHandler<HTMLDivElement>
onEmptied
ReactEventHandler<HTMLDivElement>
onEmptiedCapture
ReactEventHandler<HTMLDivElement>
onEncrypted
ReactEventHandler<HTMLDivElement>
onEncryptedCapture
ReactEventHandler<HTMLDivElement>
onEnded
ReactEventHandler<HTMLDivElement>
onEndedCapture
ReactEventHandler<HTMLDivElement>
onLoadedData
ReactEventHandler<HTMLDivElement>
onLoadedDataCapture
ReactEventHandler<HTMLDivElement>
onLoadedMetadata
ReactEventHandler<HTMLDivElement>
onLoadedMetadataCapture
ReactEventHandler<HTMLDivElement>
onLoadStart
ReactEventHandler<HTMLDivElement>
onLoadStartCapture
ReactEventHandler<HTMLDivElement>
onPause
ReactEventHandler<HTMLDivElement>
onPauseCapture
ReactEventHandler<HTMLDivElement>
onPlay
ReactEventHandler<HTMLDivElement>
onPlayCapture
ReactEventHandler<HTMLDivElement>
onPlaying
ReactEventHandler<HTMLDivElement>
onPlayingCapture
ReactEventHandler<HTMLDivElement>
onProgress
ReactEventHandler<HTMLDivElement>
onProgressCapture
ReactEventHandler<HTMLDivElement>
onRateChange
ReactEventHandler<HTMLDivElement>
onRateChangeCapture
ReactEventHandler<HTMLDivElement>
onResize
ReactEventHandler<HTMLDivElement>
onResizeCapture
ReactEventHandler<HTMLDivElement>
onSeeked
ReactEventHandler<HTMLDivElement>
onSeekedCapture
ReactEventHandler<HTMLDivElement>
onSeeking
ReactEventHandler<HTMLDivElement>
onSeekingCapture
ReactEventHandler<HTMLDivElement>
onStalled
ReactEventHandler<HTMLDivElement>
onStalledCapture
ReactEventHandler<HTMLDivElement>
onSuspend
ReactEventHandler<HTMLDivElement>
onSuspendCapture
ReactEventHandler<HTMLDivElement>
onTimeUpdate
ReactEventHandler<HTMLDivElement>
onTimeUpdateCapture
ReactEventHandler<HTMLDivElement>
onVolumeChange
ReactEventHandler<HTMLDivElement>
onVolumeChangeCapture
ReactEventHandler<HTMLDivElement>
onWaiting
ReactEventHandler<HTMLDivElement>
onWaitingCapture
ReactEventHandler<HTMLDivElement>
onAuxClick
MouseEventHandler<HTMLDivElement>
onAuxClickCapture
MouseEventHandler<HTMLDivElement>
onClick
MouseEventHandler<HTMLDivElement>
onClickCapture
MouseEventHandler<HTMLDivElement>
onContextMenu
MouseEventHandler<HTMLDivElement>
onContextMenuCapture
MouseEventHandler<HTMLDivElement>
onDoubleClick
MouseEventHandler<HTMLDivElement>
onDoubleClickCapture
MouseEventHandler<HTMLDivElement>
onDrag
DragEventHandler<HTMLDivElement>
onDragCapture
DragEventHandler<HTMLDivElement>
onDragEnd
DragEventHandler<HTMLDivElement>
onDragEndCapture
DragEventHandler<HTMLDivElement>
onDragEnter
DragEventHandler<HTMLDivElement>
onDragEnterCapture
DragEventHandler<HTMLDivElement>
onDragExit
DragEventHandler<HTMLDivElement>
onDragExitCapture
DragEventHandler<HTMLDivElement>
onDragLeave
DragEventHandler<HTMLDivElement>
onDragLeaveCapture
DragEventHandler<HTMLDivElement>
onDragOver
DragEventHandler<HTMLDivElement>
onDragOverCapture
DragEventHandler<HTMLDivElement>
onDragStart
DragEventHandler<HTMLDivElement>
onDragStartCapture
DragEventHandler<HTMLDivElement>
onDrop
DragEventHandler<HTMLDivElement>
onDropCapture
DragEventHandler<HTMLDivElement>
onMouseDown
MouseEventHandler<HTMLDivElement>
onMouseDownCapture
MouseEventHandler<HTMLDivElement>
onMouseEnter
MouseEventHandler<HTMLDivElement>
onMouseLeave
MouseEventHandler<HTMLDivElement>
onMouseMove
MouseEventHandler<HTMLDivElement>
onMouseMoveCapture
MouseEventHandler<HTMLDivElement>
onMouseOut
MouseEventHandler<HTMLDivElement>
onMouseOutCapture
MouseEventHandler<HTMLDivElement>
onMouseOver
MouseEventHandler<HTMLDivElement>
onMouseOverCapture
MouseEventHandler<HTMLDivElement>
onMouseUp
MouseEventHandler<HTMLDivElement>
onMouseUpCapture
MouseEventHandler<HTMLDivElement>
onSelect
ReactEventHandler<HTMLDivElement>
onSelectCapture
ReactEventHandler<HTMLDivElement>
onTouchCancel
TouchEventHandler<HTMLDivElement>
onTouchCancelCapture
TouchEventHandler<HTMLDivElement>
onTouchEnd
TouchEventHandler<HTMLDivElement>
onTouchEndCapture
TouchEventHandler<HTMLDivElement>
onTouchMove
TouchEventHandler<HTMLDivElement>
onTouchMoveCapture
TouchEventHandler<HTMLDivElement>
onTouchStart
TouchEventHandler<HTMLDivElement>
onTouchStartCapture
TouchEventHandler<HTMLDivElement>
onPointerDown
PointerEventHandler<HTMLDivElement>
onPointerDownCapture
PointerEventHandler<HTMLDivElement>
onPointerMove
PointerEventHandler<HTMLDivElement>
onPointerMoveCapture
PointerEventHandler<HTMLDivElement>
onPointerUp
PointerEventHandler<HTMLDivElement>
onPointerUpCapture
PointerEventHandler<HTMLDivElement>
onPointerCancel
PointerEventHandler<HTMLDivElement>
onPointerCancelCapture
PointerEventHandler<HTMLDivElement>
onPointerEnter
PointerEventHandler<HTMLDivElement>
onPointerEnterCapture
PointerEventHandler<HTMLDivElement>
onPointerLeave
PointerEventHandler<HTMLDivElement>
onPointerLeaveCapture
PointerEventHandler<HTMLDivElement>
onPointerOver
PointerEventHandler<HTMLDivElement>
onPointerOverCapture
PointerEventHandler<HTMLDivElement>
onPointerOut
PointerEventHandler<HTMLDivElement>
onPointerOutCapture
PointerEventHandler<HTMLDivElement>
onGotPointerCapture
PointerEventHandler<HTMLDivElement>
onGotPointerCaptureCapture
PointerEventHandler<HTMLDivElement>
onLostPointerCapture
PointerEventHandler<HTMLDivElement>
onLostPointerCaptureCapture
PointerEventHandler<HTMLDivElement>
onScroll
UIEventHandler<HTMLDivElement>
onScrollCapture
UIEventHandler<HTMLDivElement>
onWheel
WheelEventHandler<HTMLDivElement>
onWheelCapture
WheelEventHandler<HTMLDivElement>
onAnimationStart
AnimationEventHandler<HTMLDivElement>
onAnimationStartCapture
AnimationEventHandler<HTMLDivElement>
onAnimationEnd
AnimationEventHandler<HTMLDivElement>
onAnimationEndCapture
AnimationEventHandler<HTMLDivElement>
onAnimationIteration
AnimationEventHandler<HTMLDivElement>
onAnimationIterationCapture
AnimationEventHandler<HTMLDivElement>
onTransitionEnd
TransitionEventHandler<HTMLDivElement>
onTransitionEndCapture
TransitionEventHandler<HTMLDivElement>
isDisabled
boolean
status
"positive" | "warning" | "negative"
size
"small" | "large"
as
"div" | ("div" & (ComponentClass<unknown, any> | FunctionComponent<unknown>))