Textarea github location npm version

This component version is ready to be used but is still in active development.

The vf-form__textarea allows a site visitor to enter text on multiple lines.

Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (exampe), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "form",
  "text_area_rows": 5,
  "text_area_name": "text-area",
  "text_label": {
    "form__label": "Write Some More details",
    "form__label_for": "text-area"
  }
}
 %}
{% include "../path_to/vf-form__textarea/vf-form__textarea.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-form__textarea', {
  "component-type": "form",
  "text_area_rows": 5,
  "text_area_name": "text-area",
  "text_label": {
    "form__label": "Write Some More details",
    "form__label_for": "text-area"
  }
} %}
                
HTML
<div class="vf-form__item">
  <label for="text-area" class="vf-form__label">Write Some More details</label>
  <textarea class="vf-form__textarea" id="text-area" name="text-area" rows="5"></textarea>
</div>
              

Usage

Use the vf-form__textare when you want the site visitor to enter text on multiple lines or when the information they need to input is not short.

If you are wanting the site visitor to answer multiple questions inside a vf-form__textarea it is better to split these question up and use multiple vf-form__inputs.

The vf-from__textarea must be accompanied by a descriptive vf-form__label.

Installation info

This component is distributed with npm. After installing npm, you can install the vf-form__textarea with this command.

$ yarn add --dev @visual-framework/vf-form__textarea

Sass/CSS

The source files included are written in Sass(scss). You can point your Sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/vf-form__textarea/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Changelog

Changelog

1.1.2

  • Implements updated vf-search markup.
  • Changes a few pages on how it works with nunjucks and markdown.

1.1.0

  • updates Design Tokens homepage.
  • adds neutral colour tokens
  • adds 'status banners' for components in the documentation page.
  • Adds the form options as their own set of components in the list.
  • https://github.com/visual-framework/vf-core/pull/1390/files
  • Updates to use 11ty 0.12.1
  • https://github.com/visual-framework/vf-core/pull/1435

1.0.24

  • changes the vf-intro so it's a white background, removes the padding.
  • changes the links in vf-intro to be the 'correct' buttons.

1.0.23

  • small change to cards on homepage

1.0.18

  • dependency bump

1.0.17

  • dependency bump

1.0.16

  • dependency bump

1.0.13

  • dependency bump
  • adds roamap and consultation docs

1.0.12

  • design token documenation now lives in the component libary

1.0.7

  • adds updates blog

1.0.6

  • begin to make more pattern/boilerplate guidance
  • minor templating updates

1.0.5

  • dependency bump

1.0.4

  • uses vf-favicon
  • adds meta attributes

1.0.3

  • run vf-component-assets:everything on local dev
  • remove reference to removed /css/app.css

1.0.2

  • Add 404
  • Fix component CSS generation

1.0.1

  • Also generate per-component CSS with vf-css:generate-component-css

1.0.0

  • Initial release to be used with vf-core 2.2.0

Assets



File system location: components/vf-form__textarea

Find an issue on this page? Propose a change or discuss it.