@visual-framework/vf-body

vf-body component

Usage no npm install needed!

<script type="module">
  import visualFrameworkVfBody from 'https://cdn.skypack.dev/@visual-framework/vf-body';
</script>

README

Body component

npm version

About

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;
}

Install

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

Help