Skip to content

Commit

Permalink
mention async updates in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adidahiya committed Oct 15, 2020
1 parent 1eff91a commit fdfdffb
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion packages/core/src/components/forms/text-inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Blueprint provides two ways to create a text input:

@## Input group

An input group allows you to add icons and buttons _within_ a text input to expand its
Input groups are a basic building block used to render text inputs across many Blueprint components.
They allow you to add icons and buttons _within_ a text input to expand its appearance and
functionality. For example, you might use an input group to build a visibility toggle for a password
field.

Expand All @@ -28,6 +29,12 @@ a controlled or uncontrolled fashion. In addition to its own props, it supports
all valid props for HTML `<input>` elements and proxies them to that element in
the DOM; the most common ones are detailed below.

If controlled with the `value` prop, `InputGroup` has support for _asynchronous updates_, which may
occur with some form handling libraries like `redux-form`. This is not generally encouraged (a value
returned from `onChange` should generally be sent back to the component as a controlled `value` synchronously),
but there is basic support for it. Note that the input cursor may jump to the end of the input if the speed
of text entry (time between change events) is faster than the speed of the async update.

@interface IInputGroupProps

@### CSS
Expand Down

0 comments on commit fdfdffb

Please sign in to comment.