Code Monkey home page Code Monkey logo

hamburger-basement's Introduction

hamburger-basement

A hamburger basement component for React, using Topcoat.

Wth

A “hamburger basement” is a common design pattern in mobile apps, where a button with an icon that kinda looks like a hamburger (typically in the top left corner) slides the main content aside and reveals a menu underneath.

This one also uses touch events to allow sliding the content to the side with a finger.

Demo

Go here: http://arnemart.github.io/hamburger-basement/

(Preferably on mobile)

Installation

npm install hamburger-basement or just download hamburger-basement.js and hamburger-basement.css.

Loading

With browserify: var HamburgerBasement = require('hamburger-basement');

With AMD (requires modules react and react-topcoat): require(['hamburger-basement'], function(HamburgerBasement) { // Do stuff })

…or just include in a script tag (after loading react.js and react-topcoat.js first).

Don't forget to include the Topcoat CSS and hamburger-basement.css in your HTML.

Enabling touch events

Touch events are not enabled by default in React as of version 0.9.0. To activate touch events, add the following line before rendering any React components:

React.initializeTouchEvents(true);

Using

Do like this:

var basement = React.createClass({
    render: function() {
        return tc.list({
            header: 'Header',
            items: [{content: 'aa'}, {content: 'bb'}, {content: 'cc'}, {content: 'dd'}]
        });
    }
});

var content = React.createClass({
    render: function() {
        return d.div(
            null,
            'Hello'
        );
    }
});

var hb = hamburgerBasement({
    basement: basement(),
    title: 'Testing testing',
    content: content(),
    basementWidth: 400
});

React.initializeTouchEvents(true);
React.renderComponent(hb, document.getElementById('main'));

Run npm run watch to build the test script.

hamburger-basement's People

Contributors

arnemart avatar dmfrancisco avatar

Stargazers

Angus H. avatar

Watchers

Michael Benin avatar James Cloos avatar

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.