Building a site

How to make a project with Visual Framework components.

alpha

This version is in early development and is subject to change and therefore not ready for wide use. There may be other stable versions available.

ELIXIR Banner github location npm version

This should be placed in the footer of sites that are part of the ELIXIR network.


Usage

This is an early version that is largely a port of the VF 1.3 ELIXIR Banner with some notable changes:

Options

The development and future direction of this component can be discussed in issue #1572. While breaking changes are anticipated they are currently not expected.

This component leverages the Sass/CSS of vf-banner, so it should also be installed.

Accessibility

This component targets WCAG 2.1 AA accessibility.

You can also read about the Visual Framework's approach to accessibility.

default

Service Name

A short description about this service's role and function

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": "container",
  "logo": "default",
  "name": "Service Name",
  "description": "A short description about this service's role and function",
  "link": "default"
}
 %}
{% include "../path_to/vf-banner-elixir/vf-banner-elixir.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-banner-elixir', {
  "component-type": "container",
  "logo": "default",
  "name": "Service Name",
  "description": "A short description about this service's role and function",
  "link": "default"
} %}
                
HTML
<div class="vf-banner-elixir vf-banner" data-vf-js-banner-elixir data-vf-js-banner-elixir-logo="" data-vf-js-banner-elixir-name="Service Name" data-vf-js-banner-elixir-description="A short description about this service's role and function" data-vf-js-banner-elixir-link="default">
  <div class="vf-banner__content">
    <p class="vf-banner__text">default</p>
    <p class="vf-banner__text">Service Name</p>
    <p class="vf-banner__text">A short description about this service's role and function</p>
    <p class="vf-banner__text">default</p>
  </div>
</div>
              
Installation info

This repository is distributed with [npm][https://www.npmjs.com/]. After [installing npm][https://www.npmjs.com/get-npm] and yarn, you can install vf-banner-elixir and the supporting vf-banner with this command.

$ yarn add --dev @visual-framework/vf-banner-elixir @visual-framework/vf-banner

JS

You should import this component in ./components/vf-component-rollup/scripts.js or your other JS process:

import { vfBannerElixir } from 'vf-banner-elixir/vf-banner-elixir';
// Or import directly
// import { vfBannerElixir } from '../components/raw/vf-banner-elixir/vf-banner-elixir.js';
vfBannerElixir(); // if needed, invoke it

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 'vf-banner/vf-banner.scss';
@import "@visual-framework/vf-banner-elixir/vf-banner-elixir.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.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-banner-elixir

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