textareaInput

Create multiline text input fields for collecting longer text responses

The textareaInput is created using the textInput method with the multiline parameter set to true.

Overview

The textarea input allows users to enter multiple lines of text, making it ideal for collecting longer responses like feedback, comments, or descriptions.

Method Signature

textInput(
  name: string,
  params: FormFieldSharedParamsType & { multiline: true } & TextInputParamsType
): string

Parameters

name · string · required

The unique identifier for this input field.

Required Parameters

question · string · required

The main question or label displayed to the user.

multiline · boolean · required

Must be set to true to render a textarea element instead of a single-line input.

Input-Specific Parameters

placeholder · string

Sets the placeholder text displayed when the textarea is empty.

placeholder: "Tell us about your experience..."

maxlength · number

Sets the maximum number of allowed characters.

maxlength: 500

value · string

Sets the default value of the textarea.

value: "This is default text"

Shared Parameters

All standard form field parameters are supported. See textInput for the complete list of shared parameters including required, description, fieldSize, disabled, and more.

Examples

Basic Textarea

const composer = new Composer({ title: "Feedback Form" });

composer.textInput("feedback", {
  question: "Tell us about your experience",
  multiline: true,
  required: true,
  placeholder: "Share your thoughts here..."
});

Use Cases

Feedback Forms

Perfect for collecting detailed user feedback, reviews, or testimonials.

composer.textInput("review", {
  question: "How was your experience with our product?",
  multiline: true,
  required: true,
  maxlength: 1000,
  placeholder: "Please share your honest feedback"
});

Application Forms

Collect detailed responses for applications or surveys.

composer.textInput("motivation", {
  question: "Why do you want to join our program?",
  multiline: true,
  required: true,
  maxlength: 750,
  description: "Please provide a detailed response (minimum 200 characters)"
});

Support Tickets

Gather detailed problem descriptions for customer support.

composer.textInput("issueDescription", {
  question: "Describe the issue you're experiencing",
  multiline: true,
  required: true,
  placeholder: "Please include:\n- What you were trying to do\n- What happened\n- What you expected to happen"
});

Best Practices

Setting appropriate character limits

Use maxlength to prevent overly long responses and guide users on expected response length:

• Short responses (bio, tagline): 150-300 characters
• Medium responses (feedback, comments): 500-1000 characters
• Long responses (essays, detailed descriptions): 2000-5000 characters

Helpful placeholders

Use placeholders to show example responses or guide users on what to include:

placeholder: "Example: I love this product because...\n\nIt has helped me to..."

Clear descriptions

Add descriptions to clarify expectations:

description: "Please be as specific as possible. Include examples if relevant."

Return Value

Returns a string containing the Forms.md markup for the textarea input field.

Related Methods

textInput

Single-line text input

emailInput

Email input with validation