Search github location npm version

Variants


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": "block",
  "variant": "default",
  "search_action": "#",
  "search_autofocus": false,
  "search_button": "Search",
  "search_label": "Search",
  "search_placeholder": "Enter your search terms",
  "search_description": false,
  "search_id": "searchitem",
  "search_value_default": ""
}
 %}
{% include "../path_to/vf-search/vf-search.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-search', {
  "component-type": "block",
  "variant": "default",
  "search_action": "#",
  "search_autofocus": false,
  "search_button": "Search",
  "search_label": "Search",
  "search_placeholder": "Enter your search terms",
  "search_description": false,
  "search_id": "searchitem",
  "search_value_default": ""
} %}
                
HTML
<form action="#" class="vf-form | vf-search">
  <div class="vf-form__item | vf-search__item">
    <label class="vf-form__label vf-u-sr-only | vf-search__label" for="searchitem">Search</label>
    <input type="search" placeholder="Enter your search terms" id="searchitem" class="vf-form__input | vf-search__input">
  </div>
  <button type="submit" class="vf-search__button | vf-button vf-button--primary"> Search</button>
</form>
              
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": "block",
  "variant": "inline",
  "search_action": "#",
  "search_autofocus": false,
  "search_button": "Search",
  "search_label": "Inline search",
  "search_placeholder": "Enter your search terms",
  "search_description": "Here are some tips on how your can search. Examples: <a href=\"JavaScript:Void(0);\" class=\"vf-link\">Cheese</a>, <a href=\"JavaScript:Void(0);\" class=\"vf-link\">Brie</a>. You can also use the <a href=\"JavaScript:Void(0);\" class=\"vf-link\">advanced search</a>.",
  "search_id": "inlinesearchitem",
  "search_value_default": ""
}
 %}
{% include "../path_to/vf-search/vf-search.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-search', {
  "component-type": "block",
  "variant": "inline",
  "search_action": "#",
  "search_autofocus": false,
  "search_button": "Search",
  "search_label": "Inline search",
  "search_placeholder": "Enter your search terms",
  "search_description": "Here are some tips on how your can search. Examples: <a href=\"JavaScript:Void(0);\" class=\"vf-link\">Cheese</a>, <a href=\"JavaScript:Void(0);\" class=\"vf-link\">Brie</a>. You can also use the <a href=\"JavaScript:Void(0);\" class=\"vf-link\">advanced search</a>.",
  "search_id": "inlinesearchitem",
  "search_value_default": ""
} %}
                
HTML
<form action="#" class="vf-form | vf-search vf-search--inline">
  <div class="vf-form__item | vf-search__item">
    <label class="vf-form__label vf-u-sr-only | vf-search__label" for="inlinesearchitem">Inline search</label>
    <input type="search" placeholder="Enter your search terms" id="inlinesearchitem" class="vf-form__input | vf-search__input">
  </div>
  <button type="submit" class="vf-search__button | vf-button vf-button--primary"> Search</button>
  <p class="vf-search__description">Here are some tips on how your can search. Examples: <a href="JavaScript:Void(0);" class="vf-link">Cheese</a>, <a href="JavaScript:Void(0);" class="vf-link">Brie</a>. You can also use the <a href="JavaScript:Void(0);" class="vf-link">advanced search</a>.</p>
</form>
              

Usage

Installation info

This repository is distributed with npm. After installing npm and yarn, you can install with this command.

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

Sass/CSS

The style files included are written in Sass. If you're using a VF-core project, you can import it like this:

@import "@visual-framework/vf-search/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.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-search

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