Giter Site home page Giter Site logo

vue-hierarchical-navigation's Introduction

Hierarchical navigation with Vue

Demo: http://nav.ftes.de

This is a shopping cart demo. Navigation occurs across three levels:

  1. shopping cart list
  2. shopping cart details with list of items
  3. shopping cart item details

Consistent "hierarchical" navigation across these levels is achieved using vue-router and the PagingMixin.

What does "hierarchical" navigation mean?

A better term might be hierarchy-aware navigation. The idea is to preserve a hierarchical history in addition to the regular linear browser history.

      Upwards:       go back to most recent state of an ancestor in the navigation hierarchy
         ^
         |
         |
<----------------->
      Sideways:      switch between items within a level of the navigation hierarchy (honor the sorting/filter of the items)

Navigate upwards in hierarchy

A user should be able to jump upwards in the hierarchy (e.g. from cart details (2) to cart list (1)). This upward navigation in the hierarchy skips all intermediate states in the browser history, where the user navigated on lower levels.

This navigation is exposed in the title bar via

  • a Back button,
  • breadcrumbs.

Navigate sidways in hierarchy

A user should be able to navigate sidways in the hierarchy (e.g. switching between the detail views of different shopping carts). This navigation should honor the sorting/filter/etc. of the parent in the hierarchy.

Example

A user sorts shopping carts by name in descending order:

  • Wooden
  • Steel
  • Soft

He navigates down the hierarchy by clicking on the first shopping cart "Wooden". When he now navigates sideways to the next shopping cart, he expects to see "Steel", as this is the next cart by descending name.

Details

For every level in the hierarchy, the most recent state is stored.

Each level in the hierarchy that has children can add metadata. This is used to enrich the breadcrumbs and enable sideways navigation.

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

# run unit tests
npm run unit

# run all tests
npm test

For a detailed explanation on how things work, check out the guide and docs for vue-loader.

vue-hierarchical-navigation's People

Contributors

ftes avatar

Stargazers

Frederik Hahne avatar Julian Maicher avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.