Explainer github location npm version

Life science websites love a bit of jargon and complicated concepts and "explainers" help for terms like: ORCID, transcript isoform, and lymphoblastoid cell lines.

/* vf-explainer template file */
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": "element"
}
 %}
{% include "../path_to/vf-explainer/vf-explainer.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-explainer', {
  "component-type": "element"
} %}
                
HTML
<div class="vf-explainer">
  /* vf-explainer template file */
</div>
              

Usage

This will likely be similar to "tooltips" or "foldable info tabs".

Conceptual code:

<span aria-describedby="whatis-orcid">ORCID</span>

<div id="whatis-orcid" class="vf-explainer"> <dfn class="vf-explainer--dfn">ORCID</dfn> is a unique identifier for researchers to distinguish themselves, and make it easier to find specific work; <a href="https://orcid.org" target="_blank" class="vf-explainer__link">learn more</a> </div>

This is a draft component, it is not yet functional. Background on the implementation, goals and work plan can be found in the issue.

Installation info

This repository is distributed with npm. After installing npm, you can install vf-explainer with this command.

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

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

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