Summary Container github location npm version

An arrangement of vf-summary in a three-column container.

Projects

What is Cancer?

Cancer is a group of diseases involving abnormal cell growth with the potential to invade or spread to other parts of the body.

Cancer and EMBL

EMBL researchers use both computational and traditional lab research to try and understand why cancer happens and how cancer grows and spreads. They can sample and test how tumours and drugs react and find unique molecular data to identify diseases.

What does Cancer look like?

Cancer is caused by uncontrolled cell division. These cells are tiny, but but can quickly add up and cancerous cells can look very different from healthy ones.

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": "container",
  "section-title": "Learn about Cancer",
  "item01": {
    "summary__title": "What is Cancer?",
    "summary__text": "Cancer is a group of diseases involving abnormal cell growth with the potential to invade or spread to other parts of the body."
  },
  "item02": {
    "summary__title": "Cancer and EMBL",
    "summary__text": "EMBL researchers use both computational and traditional lab research to try and understand why cancer happens and how cancer grows and spreads. They can sample and test how tumours and drugs react and find unique molecular data to identify diseases."
  },
  "item03": {
    "summary__title": "What does Cancer look like?",
    "summary__text": "Cancer is caused by uncontrolled cell division. These cells are tiny, but but can quickly add up and cancerous cells can look very different from healthy ones."
  }
}
 %}
{% include "../path_to/vf-summary-container/vf-summary-container.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-summary-container', {
  "component-type": "container",
  "section-title": "Learn about Cancer",
  "item01": {
    "summary__title": "What is Cancer?",
    "summary__text": "Cancer is a group of diseases involving abnormal cell growth with the potential to invade or spread to other parts of the body."
  },
  "item02": {
    "summary__title": "Cancer and EMBL",
    "summary__text": "EMBL researchers use both computational and traditional lab research to try and understand why cancer happens and how cancer grows and spreads. They can sample and test how tumours and drugs react and find unique molecular data to identify diseases."
  },
  "item03": {
    "summary__title": "What does Cancer look like?",
    "summary__text": "Cancer is caused by uncontrolled cell division. These cells are tiny, but but can quickly add up and cancerous cells can look very different from healthy ones."
  }
} %}
                
HTML
<section class="vf-summary-container | embl-grid">


  <div class="vf-section-header">
    <h2 class="vf-section-header__heading">Projects</h2>
  </div>
  <div class="vf-section-content | vf-grid vf-grid__col-3">

    <article class="vf-summary">
      <h3 class="vf-summary__title">
        <a href="" class="vf-summary__link">What is Cancer?</a>
      </h3>
      <p class="vf-summary__text">Cancer is a group of diseases involving abnormal cell growth with the potential to invade or spread to other parts of the body.</p>
    </article>
    <article class="vf-summary">
      <h3 class="vf-summary__title">
        <a href="" class="vf-summary__link">Cancer and EMBL</a>
      </h3>
      <p class="vf-summary__text">EMBL researchers use both computational and traditional lab research to try and understand why cancer happens and how cancer grows and spreads. They can sample and test how tumours and drugs react and find unique molecular data to identify diseases.</p>
    </article>
    <article class="vf-summary">
      <h3 class="vf-summary__title">
        <a href="" class="vf-summary__link">What does Cancer look like?</a>
      </h3>
      <p class="vf-summary__text">Cancer is caused by uncontrolled cell division. These cells are tiny, but but can quickly add up and cancerous cells can look very different from healthy ones.</p>
    </article>

  </div>

</section>
              

Usage

Installation info

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

$ yarn add --dev @visual-framework/vf-summary-container

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-summary-container/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-summary-container

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