Select github location npm version

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

Let site visitors pick one option from a list of options in a 'drop down'.

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"
}
 %}
{% include "../path_to/vf-form__select/vf-form__select.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__select', {
  "component-type": "form"
} %}
                
HTML
<div class="vf-form__item vf-stack">

  <label class="vf-form__label" for="vf-form__select">Choose a pet:</label>

  <select class="vf-form__select" id="vf-form__select">
    <option value="cat">Cat</option>
    <option value="hamster">Hamster</option>
    <option value="parrot">Parrot</option>
    <option value="dog" selected>Dog</option>
    <option value="spider">Spider</option>
    <option value="goldfish">Goldfish</option>
  </select>

</div>
              

Usage

The vf-form__select allows a site visitor to pick an available option from a group of options.

The options inside of a vf-form__select should be in alpabetical order.

When to use

You should try to use the vf-form__select as a last resort for giving site visitors a choice to pick one thing from a group of things. If possible you should use a group vf-form__radio inputs.

When not to use

If the list of options is relatively small you should use a group of vf-form_radio inputs.

Installation info

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

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

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__select/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__select

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