Body github location npm version

The Body component can be used to create a centered layout to add your content. This should be added to the body element in the markup.


Usage

The vf-body layout should be added to the body element in your mark up and therefore should only be added once.

This layout component sets a maximum width to the 'page' and centers it. The maximum width of the page is set as a default to 80em or 1280px but can be changed using the CSS custom property --vf-body-width if needed. As the web is, by default, a fluid medium the vf-body needs to give some inline spacing when the browswer viewport is smaller than 1280px like on a tablet or mobile device. This is made possible using padding: 0 1em which is the same as padding-left: 1em; padding-right: 1em.

<body class="vf-body | vf-stack vf-stack--400">...</body>

<body> <div class="my-app | vf-body"> ... </div> </body>

CSS

.vf-body {
  display: block;
  margin: 0 auto;
  max-width: 80em;
  max-width: var(--vf-body-width, 80em);
  padding: 0 1em;
}

This is for example purposes only. Please use the vf-body class on the body element only.

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": "layout"
}
 %}
{% include "../path_to/vf-body/vf-body.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-body', {
  "component-type": "layout"
} %}
                
HTML
<div class="vf-body">
  <div class="vf-box vf-box--normal vf-box-theme--primary">
    <p class="vf-ui-color--white vf-u-margin--0 vf-u-type__text-body--2">This is for example purposes only. Please use the <code>vf-body</code> class on the <code>body</code> element only.</p>
  </div>
</div>
              
Installation info

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

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

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

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