Skip to content

ashraf-ainia/circular-side-nav

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Definition

A simple React circular side nav component.

Demo

Local demo:

git clone https://github.com/ashraf-ainia/circular-side-nav.git
cd circular-side-nav
npm i && npm start

Installation

npm i circular-side-nav

Example

import React from 'react';
import CircularSideNav from 'circular-side-nav';

function App() {
  return(
    <CircularSideNav
        backgroundColor='#ccc'
        navSize={15}
        elements={[
            <div></div>,
            <p></p>
            ]}
        animation='sequence'
        animationPeriod={0.04}
      />
  )
}

Component Props

backgroundImg: String

backgroundColor: String

navSize: number

elements: JSX.Element[]

animation: String | 'sequence'

animationPeriod: number

License

MIT