@visual-framework/vf-breadcrumbs

2.0.6 • Public • Published

Breadcrumbs component

npm version

About

The vf-breadcrumb component is a navigational item that can identify to the site visitor their location on the website. They are a visual representation of the site's hierarchy.

Usage

The vf-breadcrumb component should follow the vf-global-header in the page layout.

Each link in the component is separated by a > chevron. The page you are on should display an 'active' state in the breadcrumbs which is bold with no underline.

Ensure that the complete navigational path is displayed in the breadcrumbs on the desktop, exceptions can be made in the case where the related items component is used with the breadcrumbs, in this case it should list no more than three items, including the current page.

Related breadcrumbs

The "Related" variant allows you to indicate related items as additional navigation to the page the site visitor is on. They should be placed inside the vf-breadcrumbs <nav> element and be a seperate unordered list.

When to use

Use the breadcrumb when users would need to understand their current location in a website’s navigation structure

When not to use

Breadcrumbs should not be used for websites that have a single level of hierarchy. The breadcrumb nodes should not include parent categories which do not have separate pages. The only inactive link should be the current page’s node.

Responsive

On smaller screens it is recommended that the paths of the breadcrumbs shown should be shortened. Configure the breadcrumbs to show only the direct parent node in the information architecture. This allows the user to see and navigate one step above in the website's hierarchy. The breaking point for the responsive breadcrumb is implemented at width below 768px.

Accessibility

This component targets WCAG 2.1 AA accessibility.

Install

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

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

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-breadcrumbs/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Help

Readme

Keywords

Package Sidebar

Install

npm i @visual-framework/vf-breadcrumbs

Weekly Downloads

458

Version

2.0.6

License

Apache 2.0

Unpacked Size

33.5 kB

Total Files

15

Last publish

Collaborators

  • bhushan-ebi
  • pacope92
  • ebiwebdev
  • sandykadam
  • khawkins98