Git Product home page Git Product logo

create-menu's Introduction

CreateMenu

Create Menu creates an HTML menu from a JSON object. It also includes CSS and ES5 compatible JS to operate the menu.

Table of Contents

  • Installation

  • Usage

  • JSON Structure

  • @param {JSON} navObj a (JSON) object of the nav

  • @param {string} optional siteHeaderHTML a string containing the blank site header

  • @param {string} optional menuStub a stub to replace in the siteHeaderHTML, ex: <!-- MENU_STUB -->

@returns {string} the generated menu HTML

JSON Structure

See example/example-menu.json

CreateMenuTaskRunner with Node

createMenu can run from the command line with a small taskRunner file. It's executed by running, node createMenuTaskRunner.js

Webpack integration

/* global require */
const fs = require('fs')
const createMenu = require('createMenu')
const menuJSON = require('./menu.json')

const MENU_STUB = '<!-- MENU_STUB -->'
let blankSiteHeader
fs.readFile('./public/site-header/site-header.html', function (err, data) {
  if (err) throw err
  blankSiteHeader = data.toString()
})

const menu = createMenu.create(menuJSON, blankSiteHeader, MENU_STUB)
console.log(menu)

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.