Giter VIP home page Giter VIP logo

energize's Introduction

Energize

React components (plus some styles) for Materialize CSS

Style Guide

JavaScript

  • Use ES6 features wherever possible, but avoid anything that requires es6-shim (Map, Set)
  • No jQuery or other large external dependencies
  • No direct DOM manipulation

Component State

UI components should strive to be as stateless as possible. However, there cases where this is not possible or desirable.

Any time we provide a stateful component, we should allow it to operate in "controlled" and "uncontrolled" mode, similar to how React handles form inputs.

We should always allow the user to provide one or more onChange (or similar) handlers as props. The component may perform any internal state bookkeeping whether or not change handlers are provided. If a change handler is provided, we should pass back any relevant events unchanged, along with any relevant data. If no change handlers are provided, we should preventDefault on any triggered events.

If a value prop (or whatever is appropriate for the component) is provided, then the component should defer to the given value instead of using its internal state. When a value prop is not provided, the component should track state internally.

Sass

  • Align property values on adjacent lines
  • Use scss-lint
  • Avoid changing Materialize styles wherever possible in order to maintain forward-compatibility

Class names

import cx from 'classnames';

const SpecialDiv = React.createClass({
  render() {
    // any classes we want to apply should come last so they override anything
    // set in this.props.className
    let classes = cx(this.props.className, 'top-nav');

    return (
      <div className={classes}>
        {this.props.children}
      </div>
    );
  }
});

energize's People

Contributors

bjyoungblood avatar calebmorris avatar isaiahdw avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  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.