@quarks-js/hamburger v1.0.1

@quarks-js/hamburger

Quark Hamburger:

Simple React component plugin with typescript support.

Easily customizable. You can set your own preferences for size, color or accentColor.

It works with its own inner state, but also supports your own state or click handler.

Installation

npm install @quarks-js/hamburger --save

Setup

Install the package and use import statement in your application

import { Hamburger } from '@quarks-js/hamburger';

Basic Usage

Your jsx|tsx file:

import { Hamburger } from '@quarks-js/hamburger';
import { useState } from "react";

function Component() {
    const [isOpen, setIsOpen] = useState(false)
    
    return (
        <div>
            {/* Basic usage require no props at all */}
            <Hamburger />

            {/* But you can for example provide your own state like this */}
            <Hamburger toggled={isOpen} toggle={setIsOpen} />

            {/* Or change some of its props */}
            <Hamburger size={20} color={'#F356A9'} />
        </div>
    )
}

Docs

Full docs with more examples are coming soon, sorry for the inconvenience.

Source code at GitHub Repository

Support

If you found this Quark useful, please support us by starring its GitHub repository.