alpha

This version is in early development and is subject to change and therefore not ready for wide use. There may be other stable versions available.

Bookmark element

Indicates if an item has been bookmarked to a list of favourites or similar.

github location npm version

Usage

This component shows if a piece of content has been selected by a user as a favourite using a text label and icon.

No JavaScript functionality is provided and it is expected that the state handling will be done on a case-by-case basis on the project application.

Active state

The active state of the icon is managed by adding the class vf-bookmark--active. This class should be added by your framework or sever-side code.

Options

The component can be configured with a number of options.

  • bookmark_href: defaults to JavaScript:Void(0);
    • Any url that may be required.
  • label_inactive: defaults to Bookmark
  • label_active: defaults to Bookmarked
  • is_active: defaults to true
    • true or false
    • sets vf-bookmark--active CSS class
    • determines the appropriate label_inactive or label_active
  • modifier: defaults to inline
    • inline or button
  • icon: defaults to star
    • star or heart (a bookmark icon may be added in the future)

Accessibility

This component targets WCAG 2.1 AA accessibility.

Note that the SVG icons use aria-hidden="true" as to be ignored by screen readers.

Variants

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",
  "bookmark_href": "JavaScript:Void(0);",
  "label_inactive": "Add as bookmark",
  "label_active": "Bookmarked",
  "is_active": false,
  "modifier": "button",
  "icon": "heart"
}
 %}
{% include "../path_to/vf-bookmark/vf-bookmark.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-bookmark', {
  "component-type": "element",
  "bookmark_href": "JavaScript:Void(0);",
  "label_inactive": "Add as bookmark",
  "label_active": "Bookmarked",
  "is_active": false,
  "modifier": "button",
  "icon": "heart"
} %}
                
HTML
<a href="JavaScript:Void(0);" class="vf-bookmark
 vf-bookmark--button
|
vf-button vf-button--secondary">
  <span class="vf-bookmark--icon vf-bookmark--icon-heart"><svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 140 140" height="140" width="140">
      <g transform="matrix(10,0,0,10,0,0)">
        <path d="M7,12.45l-5.52-5c-3-3,1.41-8.76,5.52-4.1,4.11-4.66,8.5,1.12,5.52,4.1Z"></path>
      </g>
    </svg></span>Add as bookmark</a>
              
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",
  "bookmark_href": "JavaScript:Void(0);",
  "label_inactive": "Add as bookmark",
  "label_active": "Bookmarked",
  "is_active": true,
  "modifier": "button",
  "icon": "heart"
}
 %}
{% include "../path_to/vf-bookmark/vf-bookmark.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-bookmark', {
  "component-type": "element",
  "bookmark_href": "JavaScript:Void(0);",
  "label_inactive": "Add as bookmark",
  "label_active": "Bookmarked",
  "is_active": true,
  "modifier": "button",
  "icon": "heart"
} %}
                
HTML
<a href="JavaScript:Void(0);" class="vf-bookmark
vf-bookmark--active vf-bookmark--button
|
vf-button vf-button--secondary">
  <span class="vf-bookmark--icon vf-bookmark--icon-heart"><svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 140 140" height="140" width="140">
      <g transform="matrix(10,0,0,10,0,0)">
        <path d="M7,12.45l-5.52-5c-3-3,1.41-8.76,5.52-4.1,4.11-4.66,8.5,1.12,5.52,4.1Z"></path>
      </g>
    </svg></span>Bookmarked</a>
              
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",
  "bookmark_href": "JavaScript:Void(0);",
  "label_inactive": "Bookmark",
  "label_active": "Bookmarked",
  "is_active": true,
  "modifier": "inline",
  "icon": "star"
}
 %}
{% include "../path_to/vf-bookmark/vf-bookmark.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-bookmark', {
  "component-type": "element",
  "bookmark_href": "JavaScript:Void(0);",
  "label_inactive": "Bookmark",
  "label_active": "Bookmarked",
  "is_active": true,
  "modifier": "inline",
  "icon": "star"
} %}
                
HTML
<a href="JavaScript:Void(0);" class="vf-bookmark
vf-bookmark--active vf-bookmark--inline
|
vf-link">
  <span class="vf-bookmark--icon vf-bookmark--icon-star"><svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 140 140" height="140" width="140">
      <g transform="matrix(10,0,0,10,0,0)">
        <path d="M7.49,1.09,9.08,4.3a.51.51,0,0,0,.41.3L13,5.12a.54.54,0,0,1,.3.93L10.77,8.56a.53.53,0,0,0-.16.48l.61,3.53a.55.55,0,0,1-.8.58L7.26,11.48a.59.59,0,0,0-.52,0L3.58,13.15a.55.55,0,0,1-.8-.58L3.39,9a.53.53,0,0,0-.16-.48L.67,6.05A.54.54,0,0,1,1,5.12L4.51,4.6a.51.51,0,0,0,.41-.3L6.51,1.09A.54.54,0,0,1,7.49,1.09Z"></path>
      </g>
    </svg></span>Bookmarked</a>
              

Examples

Installation info

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-bookmark with this command.

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

JS

[If your component uses JS]

You should import this component in ./components/vf-component-rollup/scripts.js or your other JS process:

import { vfComponentName } from 'vf-bookmark/vf-bookmark';
// Or import directly
// import { vfComponentName } from '../components/raw/vf-bookmark/vf-bookmark.js';
vfComponentName(); // if needed, invoke it

Sass/CSS

[If your component uses Sass]

The style files included are written in Sass. If you're using a VF-core project, you can import it like this:

@import "@visual-framework/vf-bookmark/vf-bookmark.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

  • Update node-html-parser to 5.1.0
  • Use eleventy v1.0.0-beta.8
  • https://github.com/visual-framework/vf-core/pull/1257

1.1.16

  • Utilise new vf-navigation--on-this-page.
  • Update project boilerplate links at https://stable.visual-framework.dev/building/

1.1.13

  • Documentation updates
  • New release

1.1.12

  • Update milestones and roadmap.

1.1.11

  • Add ELIXIR banner to example EMBL-EBI page.
  • https://stable.visual-framework.dev/patterns/boilerplate-generic-embl-ebi/
  • https://github.com/visual-framework/vf-core/pull/1615

1.1.7

  • Fixed issue of overlapping menu on VF components site
  • https://github.com/visual-framework/vf-core/issues/1518

1.1.6

  • dependency bump

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-bookmark

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