Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 1.01 KB

README.md

File metadata and controls

42 lines (23 loc) · 1.01 KB

MoxiWorks Left Navigation Component

Source for the MoxiWorks Left Navigation Component Proposal

Development

  1. Fork and clone repository
  2. From terminal run yarn install'
  3. From terminal run npm run dev
  4. Dev and have fun

Install Instructions

In your project run:

npm i @moxiworks/moxi-left-nav --save-dev

or if using yarn

yarn add @moxiworks/moxi-left-nav -D

Importing the Library for use in Frameworks

import '@moxiworks/moxi-left-nav'

Using the Component Standalone

You'll want to source the following library from WebComponents.org:

<script src="https://cdnjs.cloudflare.com/ajax/libs/webcomponentsjs/2.3.0/webcomponents-bundle.js"></script>

Then source the component:

<script src="https://cdn.jsdelivr.net/npm/@moxiworks/moxi-left-nav@latest/build/moxi-left-nav.min.js"></script>

You'll need the following tag in your DOM for the component to mount to:

<moxi-left-nav></moxi-left-nav>

Demo

CodePen showing standalone implementation