react-floating-buttons-lleaotech

v1.0.0

Published

a year ago

A lightweight, customizable and cool ⚛️ react navigation buttons

Downloads

0High
0Medium
0Low

lleaotech

react-floating-buttons

A lightweight, customizable and animated ⚛️ react floating buttons

Install

npm install --save react-floating-buttons-lleaotech

Usage

import React, { Component } from 'react'

import FloatingButtons from 'react-floating-buttons-lleaotech'

import icon1 from  './assets/icon1.svg'
import icon2 from  './assets/icon2.svg'

class Example extends Component {

  this.buttonsList = [
    { onClick: ()=> alert('clicked icon1'), src: icon1 },
    { onClick: ()=> alert('clicked icon2'), src: icon2 },
  ]

  render() {
    return <FloatingButtons buttonType='plus' dimension={50} buttonsList={this.buttonsList}  top={'calc(50% - 25px)'} left={'5%'} direction="right" />
  }
}

Props

buttonType

type: string, isRequired: false, default: 'hamburger'

The toggler button type, accepts: hamburger, plus, vert-dots or hori-dots

dimension

type: number, isRequired: false, default: 40

The buttons dimensions { width, height }

top

type: number | string, isRequired: false, default: 0

The offsetTop position of the toggler button

left

type: number | string, isRequired: false, default: 0

The offsetLeft position of the toggler button

backgroundColor

type: string, isRequired: false, default: '#f8f9fa'

The toggler button background color

buttonColor

type: string, isRequired: false, default: '#313131'

The toggler button color ( the dots color, the plus color ... )

itemBackgroundColor

type: string, isRequired: false, default: '#f8f9fa'

The toggler button color ( the dots color, the plus color ... )

direction

type: string, isRequired: false, default: 'circular'

The direction of the nav when opened, accepts: left, right, up, down or circular

distance

type: number, isRequired: false, default: 100

The distance between the toggler button and the buttons, used only with direction='circular'

degree

type: number, isRequired: false, default: 180

The angle of the circle, used only with direction='circular'

buttonsList

type: [{ onClick: () => {}, src: '' }], isRequired: true

The buttons item, a list of object where each object must have: onClick function to handle on click button and src the source of the icon of that button.

Examples

To run the exemple you need to:

clone this repo: git clone https://github.com/lleaotech/react-floating-buttons-lleaotech.git
inside the react-floating-buttons folder run: yarn or npm i
inside the example folder run: yarn or npm i then run: yarn start or npm start