Skip to main content

<Input />

Input components support editing text directly inside the widget.

For usage examples, see the Text Editing guide.

InputProps

onTextEditEnd: ({ characters: string }: TextEditEvent) => void

A method that is called when a user exits text edit mode (similar to onBlur in React). This method is called with an object containing the characters in the editable text field.

The onTextEditEnd event can always be triggered via clicking out of the element, hitting Escape, or Cmd + Enter. See inputBehavior for other ways to trigger onTextEditEnd and blur the input.


value: string | null

The value of the editable text. Typically, this value will be a synced variable that will be set in the onTextEditEnd callback.


placeholder?: string

Placeholder text that shows whenever value is null or an empty string.


placeholderProps?: PlaceholderProps

Props to customize the text placeholder. Use this prop if you want the placeholder to render differently compared to the editable text.

All relevant props on the Input component will automatically be are applied to both the editable text and the placeholder. Any additional props specified here will then be applied only to the placeholder.


inputFrameProps?: Omit<AutoLayoutProps, 'width'>

Props to customize the Autolayout frame that parents the editable text and placeholder.


width?: Size

The width of the editable text. The text will wrap around if the user types beyond the width. Defaults to 200.


inputBehavior?: 'wrap' | 'truncate' | 'multiline'

Allows you to specify some interactions and resizing behavior of the Input component.

valuedescription
"wrap" (default)Typing Enter blurs the input and triggers onTextEditEnd. On overflow, the text will wrap to the next line and the height of the input will autoresize.
"truncate"Typing Enter blurs the input and triggers onTextEditEnd. On overflow, the text will truncate.
"multiline"Typing Enter will create a new line. On overflow, the text will wrap to the next line and the height of the input will resize automatically.

Text Style Props

href?: string

If specified, turns the text node into a link that navigates to the specified href on click.


fontFamily?: string

The font family (e.g. "Inter"). The supported fonts are all the fonts in the Google Fonts library.


letterSpacing?: number

The spacing between the individual characters.


textDecoration?: 'none' | 'strikethrough' | 'underline'

Whether the text is underlined or has a strikethrough.


fontSize?: number

The size of the font. Has minimum value of 1.


italic?: boolean

Whether or not to italicize the text content.


textCase?: 'upper' | 'lower' | 'title' | 'original' | 'small-caps' | 'small-caps-forced'

Overrides the case of the raw characters in the text node.


fontWeight?: FontWeight

The font weight eg. 400, 500 or 'medium', 'bold'.


fill?: HexCode | Color | Paint | (SolidPaint | GradientPaint)[]

The paints used to fill in the text.


paragraphIndent?: number

The indentation of paragraphs (offset of the first line from the left).


paragraphSpacing?: number

The vertical distance between paragraphs.


horizontalAlignText?: 'left' | 'right' | 'center' | 'justified'

The horizontal alignment of the text with respect to the Text node.


verticalAlignText?: 'top' | 'center' | 'bottom'

The vertical alignment of the text with respect to the Text node.


lineHeight?: number | string | 'auto'

The spacing between the lines in a paragraph of text.


stroke?: HexCode | Color | SolidPaint | GradientPaint | (SolidPaint | GradientPaint)[]

The paints used to fill the area of the node's stroke.


strokeWidth?: number

The thickness of the stroke, in pixels. This value must be non-negative and can be fractional.


strokeAlign?: StrokeAlign

The alignment of the stroke with respect to the boundaries of the node.

Center-aligned stroke means the center of the stroke falls exactly on the geometry. Inside-aligned stroke shifts the stroke so it lies completely inside the shape, and outside-aligned stroke is vice versa.

info

Inside and outside stroke are actually implemented by doubling the stroke weight and masking the stroke by the fill. This means inside-aligned stroke will never draw strokes outside the fill and outside-aligned stroke will never draw strokes inside the fill.


rotation?: number

The rotation of the node in degrees. Expects values from -180 to 180.

The rotation is with respect to the top-left of the object. Therefore, it is independent from the position of the object.


BaseProps

name?: string

The name of the component. This is useful to specify a data-layer attribute to make things more debuggable when you inspect the sublayers of your widget.


hidden?: boolean

Toggles whether to show the component.


onClick?: (event: WidgetClickEvent) => Promise<any> | void

Attach a click handler on the given node. If the given function is async or returns a promise, the widget is only terminated when the async function has completed and the promise has been resolved. The click handler is also passed a WidgetClickEvent object that contains additional information about the click.

See also: Handling User Events.


key?: string | number

The key of the component.


hoverStyle?: HoverStyle

The style to be applied when the mouse is hovering over the component.


tooltip?: string

The tooltip that is shown to the user when hovering over the component.


positioning?: 'auto' | 'absolute'

This value is ignored unless the node is a direct child of an AutoLayout frame.

valuedescription
'auto'Layout this node according to auto-layout rules.
'absolute'Take this node out of the auto-layout flow, while still nesting it inside the auto-layout frame. This allows explicitly setting x, y, width, and height.

BlendProps

blendMode?: BlendMode

The blendMode of the component.


opacity?: number

The opacity of the component.


effect?: Effect | Effect[]

The effect of the component.


ConstraintProps

x?: number | HorizontalConstraint

The x position of the node.

This value is ignored if the node is a child of an AutoLayout frame and has positioning set to 'auto'.


y?: number | VerticalConstraint

The y position of the node.

This value is ignored if the node is a child of an AutoLayout frame and has positioning set to 'auto'.


Default Props

PropDefaults
name""
hiddenfalse
x0
y0
blendMode"pass-through"
opacity1
effect[]
width200
height"hug-contents"
rotation0
flipVerticalfalse
fontFamily"Inter"
horizontalAlignText"left"
verticalAlignText"top"
letterSpacing0
lineHeight"auto"
textDecoration"none"
textCase"original"
fontSize16
italicfalse
fill"#000000"
blendMode"normal"
fontWeight400
paragraphIndent0
paragraphSpacing0
placeholderProps{ opacity: 0.3 }