Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.43 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.43 KB

Bench Web Navigation Component

Module for Bench's navigation across all Bench-based websites.

Usage

Simply use bower to install this component and then link the CSS and the JS files into the head of your site.

  1. Installing via bower
bower install bench-menu --save
  1. Add link to the JS and CSS files in your sites header
<link rel="stylesheet" type="text/css" media="screen" href="/bower-components/bench-menu/build/css/cookie-policy.css" />
<script src="/bower-components/bench-menu/build/js/global.js"></script>
<script>bench.benchMenu.setup();</script>

The Bench menu component should now appear across the top of the website.

Note: You can specify the directory in which you want your bower components installed in a .bowerrc. For example:

{
  "directory": "static/components/"
}

Contributing

If you would like to help improve this project, here is a list of commands to help you get started.

Building the Global nav

To build the JS and CSS into the build folder, run:

gulp build

You can view the build files in action by opening the index.html in the root of this project.

Hacking

When developing this project you can run the following command to listen to changes in the src/js/*js and src/sass/*scss and builds them into the /build folder.

gulp dev

Before submitting your pull request. Run the lint, which checks both the JS and Sass for errors.

gulp test