Skip to content
Accessibility: Full
Translations: Not Needed

Text Area (Inline)

Minimalist textarea that appears as text until focused, perfect for in-place editing. The inline textarea will show an ellipsis and tooltip for long overflowing text.

Required Prop

Set inline to true to enable inline mode and set type to textarea.

Basic Usage

Click to edit...
Vue
html
<template>
  <HLInput
    v-model:modelValue="inputModelValue"
    id="example-textarea-inline"
    type="textarea"
    inline
    placeholder="Click to edit..."
    :showInlineBottomBorder="false"
    rows="3"
  />
</template>
<script setup lang="ts">
  import { HLInput } from '@platform-ui/highrise'
  import { ref } from 'vue'
  const inputModelValue = ref('')
</script>

Inline Textarea with CTA Buttons

Inline textarea with confirm and cancel actions for explicit user control.

Click to edit with confirm/cancel...
Vue
html
<template>
  <HLInput
    v-model:modelValue="inputModelValue"
    type="textarea"
    inline
    showInlineCTA
    placeholder="Click to edit with confirm/cancel..."
    :showInlineBottomBorder="false"
    rows="3"
  />
</template>
<script setup lang="ts">
  import { HLInput } from '@platform-ui/highrise'
  import { ref } from 'vue'
  const inputModelValue = ref('')
</script>

Accessibility

  • Connect the field to visible labels via id / for or supply aria-label when the label is hidden.
  • Reference helper and error copy through aria-describedby, and toggle aria-invalid when validation fails.
  • Manage suggestion lists with aria-expanded, aria-controls, and (when applicable) aria-autocomplete so assistive tech understands the relationship.
  • Use inputProps prop to pass attributes to the internal <input> element.

Imports

ts
import { HLInput } from '@platform-ui/highrise'

Props

Inline Props

NameTypeDefaultDescription
inlinebooleanfalseMust be set to true to enable inline mode. Transforms textarea into inline editable field
showInlineCTAbooleanfalseShows confirm/cancel buttons during editing
showInlineBottomBorderbooleantrueControls bottom border visibility in inline mode
showSavedIconbooleanfalseDeprecated: Use triggerSavedIcon() and clearSavedIcon() methods instead to programmatically control saved icon visibility

Common Props

NameTypeDefaultDescription
id *string | undefinedundefinedThe id of the element
modelValuestring''The value of the input
readonlybooleanfalseIf true, the input is read-only
rowsnumber3Number of rows for textarea
clearablebooleanfalseIf true, a clear button is shown
size'lg' | 'md' | 'sm' | 'xs' | '2xs' | '3xs''sm'The size of the input
placeholderstring | undefinedundefinedPlaceholder text for the input
autosizeboolean | AutosizeConfig | undefinedundefinedIf true, the textarea auto-resizes
maxlengthnumber | undefinedundefinedMaximum number of characters allowed
minlengthnumber | undefinedundefinedMinimum number of characters required
loadingboolean | undefinedundefinedIf true, a loading indicator is shown
showCountboolean | undefinedundefinedIf true, character count is shown
disabledboolean | undefinedundefinedIf true, the input is disabled
inputPropsObjectundefinedAdditional properties for the input element
prefixIconstring | undefinedundefinedsrc of the image to render
suffixIconstring | undefinedundefinedsrc of the image to render
suffixIconTooltipContentstring | undefinedundefinedTooltip content of suffix icon
textAlign'start' | 'center' | 'end'startText,Placeholder alignment of the input
fontSizestring | undefinedundefinedFont size of the input text area
fontWeightstring | undefinedundefinedFont weight of the input text area

Types

ts
// Configuration for auto-sizing textarea
interface AutosizeConfig {
  minRows?: number
  maxRows?: number
}

Type Details

AutosizeConfig

  • minRows: Minimum number of rows for textarea
  • maxRows: Maximum number of rows for textarea

Emits

Inline Emits

NameParametersDescription
@confirm(value: string)Emitted when user confirms the input in inline mode. The confirmed value is passed as the parameter
@cancel() => voidEmitted when user cancels the input in inline mode. The value is automatically restored to the previous value

Common Emits

NameDefaultTrigger
@update:modelValue(value: string | [string, string] | number | null) => voidWhen the input value changes
@change(value: string) => voidWhen native change event is fired
@focus(FocusEvent) => voidWhen the input is focused
@blur(FocusEvent) => voidWhen the input is blurred
@keydown(event: KeyboardEvent) => voidWhen the keydown event is fired

Slots

Inline Slots

NameDescription
edit-actionsContent to show on hover in inline mode

Common Slots

NameParametersDescription
default()The default content slot
prefix()Prefix content slot
suffix()Suffix content slot

Methods

Inline Methods

MethodTypeDescription
triggerSavedIcon()() => voidProgrammatically triggers the saved icon to appear. Useful for showing confirmation after async operations
clearSavedIcon()() => voidProgrammatically clears the saved icon. Useful for resetting the saved state

Common Methods

MethodTypeDescription
focus()() => voidFocuses the input
blur()() => voidBlurs the input
select()() => voidSelects the input
scrollTo(value: number)(value: number) => voidScrolls the input to a specific position