Visual Framework
Visual Framework
This should be placed in the footer of sites that are part of the ELIXIR network.
This is an early version that is largely a port of the VF 1.3 ELIXIR Banner with some notable changes:
data-name is now data-vf-banner-elixir-name, and similarly for the other options.data-vf-js-banner-elixir-logo="" (optional)
CDR will use the ELIXIR Core Data Resource mark.data-vf-js-banner-elixir-name="Your Service Name" (optional)
data-vf-js-banner-elixir-description="text here" (optional)
data-vf-js-banner-elixir-link="https://url" (optional)
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.
This component targets WCAG 2.1 AA accessibility.
You can also read about the Visual Framework's approach to accessibility.
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.
includeYou'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" %}
renderThis 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",}
%}
<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>
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
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
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
File system location: components/vf-banner-elixir
Find an issue on this page? Propose a change or discuss it.