Blockquote element

A way to quote and highlight text.

github location npm version

Usage

The pullquote variant will be a decorative variation but has yet to be implemented, it may take inspiration from the VF 1.3 pullquote.

Variants

"Look back to move forwards" is a well-known saying. Thus, I recently turned to VF’s archivist, Anne-Flore Laloë, who helped me to search VF’s amazing archive to learn how VF has depicted itself through the years. Maybe knowing more about our first visual identity could help us better.

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": "element",
  "blockquote_text": "\"Look back to move forwards\" is a well-known saying. Thus, I recently turned to VF’s archivist, Anne-Flore Laloë, who helped me to search VF’s amazing archive to learn how VF has depicted itself through the years. Maybe knowing more about our first visual identity could help us better.",
  "blockquote_citation": "Someone <a href=\"#\">Really F. Amous</a> said this."
}
 %}
{% include "../path_to/vf-blockquote/vf-blockquote.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-blockquote', {
  "component-type": "element",
  "blockquote_text": "\"Look back to move forwards\" is a well-known saying. Thus, I recently turned to VF’s archivist, Anne-Flore Laloë, who helped me to search VF’s amazing archive to learn how VF has depicted itself through the years. Maybe knowing more about our first visual identity could help us better.",
  "blockquote_citation": "Someone <a href=\"#\">Really F. Amous</a> said this."
} %}
                
HTML
<blockquote class="vf-blockquote | vf-stack vf-stack--400">
  <p class="vf-blockquote__text">"Look back to move forwards" is a well-known saying. Thus, I recently turned to VF’s archivist, Anne-Flore Laloë, who helped me to search VF’s amazing archive to learn how VF has depicted itself through the years. Maybe knowing more about our first visual identity could help us better.</p>

  <footer class="vf-blockquote__footer">
    <cite class="vf-blockquote__citation">Someone <a href="#">Really F. Amous</a> said this.</cite>
  </footer>

</blockquote>
              

Examples

Installation info

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

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

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-blockquote/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.2.0

  • adds context if statement to make it useable in vf-11ty.
  • adds cite element.
  • adds vf-stack.
  • kept `` so it shouldn't break

1.1.1

  • changes any set- style functions to cleaner version

1.1.0

  • removes --pullquote variant as it was never properly finalised and implemented.

1.0.1 (2020-01-24)

  • Makes the CSS linter happy

1.0.0 (2019-12-17)

  • Initial stable release

Assets



File system location: components/vf-blockquote

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