Skip to main content
Version: v6

ion-textarea

scoped

The textarea component is used for multi-line text input. A native textarea element is rendered inside of the component. The user experience and interactivity of the textarea component is improved by having control over the native textarea.

Unlike the native textarea element, the Ionic textarea does not support loading its value from the inner content. The textarea value should be set in the value attribute.

The textarea component accepts the native textarea attributes in addition to the Ionic properties.

Basic Usage

Autogrow

When the autoGrow property is set to true, the textarea will grow and shrink based on its contents.

Clear on Edit

Setting the clearOnEdit property to true will clear the textarea after it has been blurred and then typed in again.

Theming

Interfaces

TextareaChangeEventDetail

interface TextareaChangeEventDetail {
value?: string | null;
}

TextareaCustomEvent

While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.

interface TextareaCustomEvent extends CustomEvent {
detail: TextareaChangeEventDetail;
target: HTMLIonTextareaElement;
}

Properties

autoGrow

DescriptionIf true, the textarea container will grow and shrink based on the contents of the textarea.
Attributeauto-grow
Typeboolean
Defaultfalse

autocapitalize

DescriptionIndicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
Attributeautocapitalize
Typestring
Default'none'

autofocus

Descriptionこの Boolean 属性により、ページロード時にフォームコントロールにInputフォーカスが当たるように指定することができます。
Attributeautofocus
Typeboolean
Defaultfalse

clearOnEdit

Descriptiontrueの場合、編集時にフォーカスされた後、値がクリアされる。デフォルトは type"password" のとき true で、それ以外のときは false です。
Attributeclear-on-edit
Typeboolean
Defaultfalse

color

DescriptionThe color to use from your application's color palette. Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark". For more information on colors, see theming.
Attributecolor
Type"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string & Record<never, never> | undefined
Defaultundefined

cols

Descriptionテキストコントロールの可視幅を、平均文字幅で指定します。指定する場合は、正の整数である必要があります。
Attributecols
Typenumber | undefined
Defaultundefined

debounce

Descriptionキーを押すたびに ionChange イベントが発生するまでの待ち時間をミリ秒単位で設定します。これは ngModelv-model などのフォームバインディングにも影響します。
Attributedebounce
Typenumber
Default0

disabled

Descriptiontrueの場合、ユーザはテキストエリアと対話することができません。
Attributedisabled
Typeboolean
Defaultfalse

enterkeyhint

DescriptionA hint to the browser for which enter key to display. Possible values: "enter", "done", "go", "next", "previous", "search", and "send".
Attributeenterkeyhint
Type"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefined
Defaultundefined

inputmode

DescriptionA hint to the browser for which keyboard to display. Possible values: "none", "text", "tel", "url", "email", "numeric", "decimal", and "search".
Attributeinputmode
Type"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | undefined
Defaultundefined

maxlength

Descriptiontype属性の値が text, email, search, password, tel, または url の場合、この属性はユーザーが入力できる最大文字数を指定します。
Attributemaxlength
Typenumber | undefined
Defaultundefined

minlength

Descriptiontype属性の値が text, email, search, password, tel, または url の場合、この属性はユーザーが入力できる最小文字数を指定します。
Attributeminlength
Typenumber | undefined
Defaultundefined

mode

Descriptionmodeは、どのプラットフォームのスタイルを使用するかを決定します。
Attributemode
Type"ios" | "md"
Defaultundefined

name

Descriptionフォームデータとともに送信されるコントロールの名前。
Attributename
Typestring
Defaultthis.inputId

placeholder

Description入力が値を持つ前に表示される指示文。
Attributeplaceholder
Typestring | undefined
Defaultundefined

readonly

Descriptiontrueの場合、ユーザーは値を変更することができません。
Attributereadonly
Typeboolean
Defaultfalse

required

Descriptiontrueの場合、ユーザーはフォームを送信する前に値を入力する必要があります。
Attributerequired
Typeboolean
Defaultfalse

rows

Descriptionコントロールの可視テキスト行数。
Attributerows
Typenumber | undefined
Defaultundefined

spellcheck

Descriptiontrueの場合、その要素のスペルチェックと文法チェックが行われる。
Attributespellcheck
Typeboolean
Defaultfalse

value

Descriptiontextareaの値です。
Attributevalue
Typenull | string | undefined
Default''

wrap

Descriptionコントロールがテキストをどのように折り返すかを示します。
Attributewrap
Type"hard" | "off" | "soft" | undefined
Defaultundefined

Events

NameDescription
ionBlurInputのフォーカスが外れたときに発行されます。
ionChange入力値が変化したときに発行されます。
ionFocusInputにフォーカスが当たったときに発行されます。
ionInputキーボード入力が発生したときに発行されます。

Methods

getInputElement

Description要素の内部で使用されるネイティブの <textarea> 要素を返します。
SignaturegetInputElement() => Promise<HTMLTextAreaElement>

setFocus

DescriptionSets focus on the native textarea in ion-textarea. Use this method instead of the global textarea.focus().
SignaturesetFocus() => Promise<void>

CSS Shadow Parts

No CSS shadow parts available for this component.

CSS Custom Properties

NameDescription
--backgroundtextareaの背景
--border-radiusテキストエリアの境界半径
--color本文の色
--padding-bottomテキストエリアのBottom Padding
--padding-endテキストエリアの方向が左から右の場合はRight Padding、右から左の場合はLeft Paddingを使用します。
--padding-starttextareaの方向が左から右の場合はLeft Padding、右から左の場合はRight Padding。
--padding-toptextareaのTop Padding
--placeholder-colorPlaceholderテキストの色
--placeholder-font-stylePlaceholderテキストのスタイル
--placeholder-font-weightPlaceholderテキストの重さ
--placeholder-opacityPlaceholderテキストの不透明度

Slots

No slots available for this component.