Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TextFieldContainerOptions

Hierarchy

Index

Properties

dense?: boolean

Boolean if the form components should be using the dense spec to reduce the sizing slightly.

error?: boolean

Boolean if the text field should gain the error state and update the colors.

inline?: boolean

Boolean if the component should be rendered inline with display: inline-flex instead of display: flex.

isLeftAddon?: boolean

Boolean if the left children should be wrapped in the TextFieldAddon component. This is enabled by default since this is normally the behavior that is desired so that icons can be positioned correctly.

isRightAddon?: boolean

Boolean if the right children should be wrapped in the TextFieldAddon component. This is enabled by default since this is normally the behavior that is desired so that icons can be positioned correctly.

leftChildren?: ReactNode

An optional addon to apply to the left of the text field. This should normally be an icon. This element will not have pointer events so it can be "clicked through" to focus the text field instead.

rightChildren?: ReactNode

An optional addon to apply to the right of the text field. This should be a clickable button such as a password field toggle or a reset button for the field.

stretch?: boolean

Boolean if the component should gain flex: 1 1 auto; which is useful for full-width behavior within flex containers.

defaultvalue

false

remarks

@since 5.0.0

theme?: FormTheme

The current theme type.

underlineDirection?: FormUnderlineDirection

The current underline direction.

Generated using TypeDoc