carbon-custom-elements/es/components-react/textarea/textarea.d.ts

A Carbon Design System variant that's as easy to use as native HTML elements, with no framework tax, no framework silo.

/**
 * @license
 *
 * Copyright IBM Corp. 2019, 2020
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
import { Component } from 'react';
interface ComponentProps {
  /**
   * May be any of the standard HTML autocomplete options
   */
  autocomplete?: string;
  /**
   * Sets the textarea to be focussed automatically on page load. Defaults to false
   */

  autofocus?: boolean;
  /**
   * The color scheme.
   */

  colorScheme?: string;
  /**
   * The number of columns for the textarea to show by default
   */

  cols?: string;
  /**
   * Controls the disabled state of the textarea
   */

  disabled?: boolean;
  /**
   * The helper text.
   */

  helperText?: string;
  /**
   * ID to link the `label` and `textarea`
   */

  id?: string;
  /**
   * Controls the invalid state and visibility of the `validityMessage`
   */

  invalid?: boolean;
  /**
   * The label text.
   */

  labelText?: string;
  /**
   * Name for the textarea in the `FormData`
   */

  name?: string;
  /**
   * Pattern to validate the textarea against for HTML validity checking
   */

  pattern?: string;
  /**
   * Value to display when the textarea has an empty `value`
   */

  placeholder?: string;
  /**
   * Controls the readonly state of the textarea
   */

  readonly?: boolean;
  /**
   * Boolean property to set the required status
   */

  required?: boolean;
  /**
   * The special validity message for `required`.
   */

  requiredValidityMessage?: string;
  /**
   * The number of rows for the textarea to show by default
   */

  rows?: string;
  /**
   * The validity message.
   */

  validityMessage?: string;
  /**
   * The value of the text area.
   */

  value?: string;
}
/**
 * Text area.
 * @element bx-textarea
 * @slot helper-text - The helper text.
 * @slot label-text - The label text.
 * @slot validity-message - The validity message. If present and non-empty, this input shows the UI of its invalid state.
 */

declare class BXTextarea extends Component<ComponentProps> {}

export default BXTextarea;