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

Figure element

The vf-figure component can be used to display and caption diagrams, illustrations, photos, etc. This is to be used as a 'single' item of content that if it was removed from the page or have its position moved in the DOM it would not affect the pages other content.

github location npm version



Usage

The vf-figure component can be used within any existing Visual Framework layout component. The size of the vf-figure is dictated by the size of the image rather and responds to the browser viewport if the viewport is smaller. The vf-figure component also has some alignment class selectors available which can float or centre the component in and around the other content on the page.

Class Selectors

  • vf-figure--align: required to align the component depending on where it is needed. The class also changes the display to display: table so that we can confine the figcaption inside of the figure HTML element without any overflow.
  • vf-figure--align-inline-start: This class adds float: left;.
  • vf-figure--align-inline-end: This class adds float: right;.
  • vf-figure--align-inline-centered: This class adds margin: 0 auto;.

Nunjucks Props

To avoid any mistyping, forgetfulness, and to aid in future proofing the component. We are using 'pseudo props' in nunjucks to determine which CSS selectors to use. All props do nothing unless included in your data for the component.

Props available

  • vf_figure__align_inline_start: if set to true (vf_figure__align_inline_start: true) it will apply the class selectors vf-figure--align vf-figure--align-inline-start to vf-figure.
  • vf_figure__align_inline_end: if set to true (vf_figure__align_inline_end: true) it will apply the class selectors vf-figure--align vf-figure--align-inline-end to vf-figure.
  • vf_figure__align_inline_centered: if set to true (vf_figure__align_inline_centered: true) it will apply the class selectors vf-figure--align vf-figure--align-inline-centered to vf-figure.

Variants

hello alt text
Version, 1982, Adenovirus with 217 dots
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 (example), 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 = {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png"
}
 %}
{% include "../path_to/vf-figure/vf-figure.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-figure', {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png"
} %}
                
HTML
<figure class="vf-figure">

  <img class="vf-figure__image" src="../../assets/vf-figure/assets/figure-example.png" alt="hello alt text" loading="lazy">

  <figcaption class="vf-figure__caption">Version, 1982, Adenovirus with 217 dots</figcaption>

</figure>
              
hello alt text
Version, 1982, Adenovirus with 217 dots
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 (example), 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 = {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png",
  "vf_figure__align_inline_start": true
}
 %}
{% include "../path_to/vf-figure/vf-figure.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-figure', {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png",
  "vf_figure__align_inline_start": true
} %}
                
HTML
<figure class="vf-figure vf-figure--align vf-figure--align-inline-start">

  <img class="vf-figure__image" src="../../assets/vf-figure/assets/figure-example.png" alt="hello alt text" loading="lazy">

  <figcaption class="vf-figure__caption">Version, 1982, Adenovirus with 217 dots</figcaption>

</figure>
              
hello alt text
Version, 1982, Adenovirus with 217 dots
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 (example), 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 = {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png",
  "vf_figure__align_inline_end": true
}
 %}
{% include "../path_to/vf-figure/vf-figure.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-figure', {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png",
  "vf_figure__align_inline_end": true
} %}
                
HTML
<figure class="vf-figure vf-figure--align vf-figure--align-inline-end">

  <img class="vf-figure__image" src="../../assets/vf-figure/assets/figure-example.png" alt="hello alt text" loading="lazy">

  <figcaption class="vf-figure__caption">Version, 1982, Adenovirus with 217 dots</figcaption>

</figure>
              
hello alt text
Version, 1982, Adenovirus with 217 dots
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 (example), 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 = {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png",
  "vf_figure__align_centered": true
}
 %}
{% include "../path_to/vf-figure/vf-figure.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-figure', {
  "exampleMultiColumns": "false",
  "component-type": "element",
  "text": "Version, 1982, Adenovirus with 217 dots",
  "alttext": "hello alt text",
  "imageUrl": "../../assets/vf-figure/assets/figure-example.png",
  "vf_figure__align_centered": true
} %}
                
HTML
<figure class="vf-figure vf-figure--align vf-figure--align-centered">

  <img class="vf-figure__image" src="../../assets/vf-figure/assets/figure-example.png" alt="hello alt text" loading="lazy">

  <figcaption class="vf-figure__caption">Version, 1982, Adenovirus with 217 dots</figcaption>

</figure>
              

Examples

Installation info

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

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

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-figure/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.13

  • Documentation updates
  • New release

1.1.12

  • Update milestones and roadmap.

1.1.11

  • Add ELIXIR banner to example EMBL-EBI page.
  • https://stable.visual-framework.dev/patterns/boilerplate-generic-embl-ebi/
  • https://github.com/visual-framework/vf-core/pull/1615

1.1.7

  • Fixed issue of overlapping menu on VF components site
  • https://github.com/visual-framework/vf-core/issues/1518

1.1.6

  • dependency bump

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-figure

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