Building a site

How to make a project with Visual Framework components.

Logo github location npm version

A simple component to add the Visual Framework logo to a page. You'll likely want to use this one as a template to add your own logo.

Variants

Variant example: Default
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 = {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "hidden_text": false
}
 %}
{% include "../path_to/vf-logo/vf-logo.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-logo', {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "hidden_text": false
} %}
HTML 
<a href="http://www.embl.de" class="vf-logo | vf-logo--has-text">
  <img class="vf-logo__image" src="https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg" alt="Visual Framework 2.0" loading="eager">
  <span class="vf-logo__text">Visual Framework 2.0</span>
</a>
Variant example: Extreme
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 = {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "override_class": "vf-logo--extreme",
  "hidden_text": false
}
 %}
{% include "../path_to/vf-logo/vf-logo.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-logo', {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "override_class": "vf-logo--extreme",
  "hidden_text": false
} %}
HTML 
<a href="http://www.embl.de" class="vf-logo | vf-logo--has-text | vf-logo--extreme">
  <img class="vf-logo__image" src="https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg" alt="Visual Framework 2.0" loading="eager">
  <span class="vf-logo__text">Visual Framework 2.0</span>
</a>
Variant example: Hidden Text
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 = {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "hidden_text": true
}
 %}
{% include "../path_to/vf-logo/vf-logo.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-logo', {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "hidden_text": true
} %}
HTML 
<a href="http://www.embl.de" class="vf-logo | vf-logo--has-text">
  <img class="vf-logo__image" src="https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg" alt="Visual Framework 2.0" loading="eager">
  <span class="vf-logo__text vf-u-sr-only">Visual Framework 2.0</span>
</a>
Variant example: Extreme With Hidden Text
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 = {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "override_class": "vf-logo--extreme",
  "hidden_text": true
}
 %}
{% include "../path_to/vf-logo/vf-logo.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-logo', {
  "component-type": "element",
  "logo_href": "http://www.embl.de",
  "logo_text": "Visual Framework 2.0",
  "image": "https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg",
  "override_class": "vf-logo--extreme",
  "hidden_text": true
} %}
HTML 
<a href="http://www.embl.de" class="vf-logo | vf-logo--has-text | vf-logo--extreme">
  <img class="vf-logo__image" src="https://assets.emblstatic.net/vf/v2.4.6/assets/vf-logo/assets/logo.svg" alt="Visual Framework 2.0" loading="eager">
  <span class="vf-logo__text vf-u-sr-only">Visual Framework 2.0</span>
</a>
Installation info

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

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

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-logo/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.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-logo

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