@visual-framework/vf-breadcrumbs

    2.0.4 • 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 heirachy.

    Usage

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

    It should list no more than three items, including the current page. 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.

    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.

    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

    Install

    npm i @visual-framework/vf-breadcrumbs

    DownloadsWeekly Downloads

    670

    Version

    2.0.4

    License

    Apache 2.0

    Unpacked Size

    30.7 kB

    Total Files

    15

    Last publish

    Collaborators

    • ebiwebdev
    • nitinja
    • sandykadam
    • khawkins98