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.

Textarea

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.

Hintus textus elare volare cantare hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis.

<label class="form-label" for="152b7268-cce0-43d7-b931-41a57370f9a0--default">Label</label>
<textarea
  id="152b7268-cce0-43d7-b931-41a57370f9a0--default"
  class="form-control"
  placeholder=""
  rows=""
></textarea>
<p class="form-text">
  Hintus textus elare volare cantare hendrerit in vulputate velit esse molestie consequat, vel illum
  dolore eu feugiat nulla facilisis.
</p>
NameDescriptionDefaultControl
General
Label
Describes the content/topic of the component.
string
-
Floating Label
Defines how the components label is rendered.
boolean
-
Hidden Label
Renders the component with or without a visible label.There are accessibility concerns with hidden labels.
Please read our label accessibility guide.
boolean
-
Size
Sets the size of the component's appearance.
string
-
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 state accessibility guide.
boolean
-
Validation
Controls the validation state appearance of the component.
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/index.scss';

To import only the styles required for this component:

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

// required if you use floating-labels
@use '@swisspost/design-system-styles/components/floating-label.scss';
// required if you use validation feedbacks
@use '@swisspost/design-system-styles/components/form-feedback.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.

We're deprecating and simplifying size classes for text input, textarea and select:

  • Floating form elements will support only the default size (all size modifiers are deprecated).
  • Standard form elements will support only .form-control-sm and the default size.

.form-control-rg, .form-control-md and .form-control-lg will be completely removed in the next major version.

The size can be changed by simply adding one of four classes:

  • Small: .form-control-sm
  • Regular: .form-control-rg
  • Medium: default or .form-control-md
  • Large: .form-control-lg

Regular and medium size classes are not available on floating-label elements

NameDescriptionDefaultControl
General
Size
Sets the size of the component's appearance.
string
-

Simply add the classes .is-valid or .is-invalid to the <textarea> element to show it in the expected state.
When the component has been validated, don't forget to add a <p className="valid-feedback">...</p> or <p className="invalid-feedback">...</p> element after the textarea element to explain what went wrong. This enables the user to correct the mistake.

Eraro okazis!