No Preview

Sorry, but you either have no stories or none are selected somehow.

If the problem persists, check the browser console, or the terminal you've run Storybook from.

The component failed to render properly, likely due to a configuration issue in Storybook. Here are some common causes and how you can address them:

  1. Missing Context/Providers: You can use decorators to supply specific contexts or providers, which are sometimes necessary for components to render correctly. For detailed instructions on using decorators, please visit the Decorators documentation.
  2. Misconfigured Webpack or Vite: Verify that Storybook picks up all necessary settings for loaders, plugins, and other relevant parameters. You can find step-by-step guides for configuring Webpack or Vite with Storybook.
  3. Missing Environment Variables: Your Storybook may require specific environment variables to function as intended. You can set up custom environment variables as outlined in the Environment Variables documentation.

This is a pre-release version and is not production ready. For new and ongoing projects, please refer to the latest Design System version.

Textarea

Figma Design

Customize the native <textarea> with CSS that changes the element’s initial appearance.

Custom textarea elements need only the class .form-control to trigger the custom styles.

This is helpful text that provides guidance or additional information to assist the user in filling out this field correctly.

<div class="form-floating">
  <textarea
    placeholder="My placeholder"
    id="152b7268-cce0-43d7-b931-41a57370f9a0--default"
    class="form-control"
    rows=""
    aria-describedby="form-hint-152b7268-cce0-43d7-b931-41a57370f9a0--default"
  ></textarea>
  <label class="form-label" for="152b7268-cce0-43d7-b931-41a57370f9a0--default">Label</label>
  <p class="form-hint" id="form-hint-152b7268-cce0-43d7-b931-41a57370f9a0--default">
    This is helpful text that provides guidance or additional information to assist the user in
    filling out this field correctly.
  </p>
</div>
NameDescriptionDefaultControl
General
Label
Describes the content/topic of the component.
string
-
Floating Label
Defines how the components label is rendered.
boolean
-
Helper Text
Text to place in the help text area of the component.
string
-
Rows
Attribute to set the initial height, in lines of text, of the textarea element.
-
-
States
Disabled
When set to true, disables the component's functionality and places it in a disabled state.

There are accessibility concerns with the disabled state.
Please read our disabled elements guidelines.

boolean
-
Validation
Defines the validation state of the textarea and controls the display of the corresponding return message.

Please read our validation guidelines here.

string
-
Required / Optional
Whether the field is required or optional.
string
-

Make sure the @swisspost/design-system-styles package is already present in your project or follow the installation guidelines.

To import all Design System styles:

@use '@swisspost/design-system-styles/post-compact.scss';

To import only the styles required for this component:

@use '@swisspost/design-system-styles/basics.scss';
@use '@swisspost/design-system-styles/components/form-textarea.scss';

// required if you use validation feedbacks
@use '@swisspost/design-system-styles/components/validation.scss';

The following examples show the different characteristics of the component. These can differ in the type of visualization, the HTML structure, as well as when, how and why they are displayed.

Wrap a pair of <textarea> and <label> elements in a .form-floating container to enable floating labels.
But note that the <textarea> element must come first, so we can ensure the correct styles.