Giter Club home page Giter Club logo

jsxr's Introduction

jsxr (JSX Real)

jsxr is a transform for rendering real DOM nodes without React. It supports custom components and inline styles. Custom component variables must be PascalCase to work correctly with the Babel JSX transpiler. Inline styles should be camelCase (marginTop instead of margin-top).

Installation

npm install jsxr

Example Usage

jsxPragma

import jsxr from 'jsxr';

// The jsxPragma can also be configured in Babel
/** @jsx jsxr */

// Note that custom components should be written in PascalCase.
// Otherwise, the Babel JSX transpiler will pass the variable name
// as a string instead of a reference to the component.
const Letters = (
  <ul>
    {['A', 'B', 'C'].map(item => <li>{ item }</li>)}
  </ul>
);

const styles = {
  backgroundColor: '#fff',
  padding: '0 5px',
};

const Container = (
  <div className='letters' style={ styles }>
    <Letters />
  </div>
);

Browserify + Babelify

import fs from 'fs';
import browserify from 'browserify';
import babelify from 'babelify';

browserify('./script.js', { debug: true })
  .transform(babelify.configure({
    jsxPragma: 'jsxr'
  }))
  .bundle()
  .on('error', function (err) {
    console.log(`Error : ${ err.message }`);
  })
  .pipe(fs.createWriteStream('bundle.js'));

// script.js
// jsxr variable must be defined
import jsxr from 'jsxr';

Gulp + Babel + Mocha

// gulpfile.babel.js
import gulp from 'gulp';
import babel from 'babel/register';
import mocha from 'gulp-mocha';

gulp.task('test', function() {
  return gulp.src(['test/**/*.js'])
    .pipe(mocha({
      compilers: {
        js: babel({
          jsxPragma: 'jsxr'
        })
      }
    }));
});

// test/**/*.js
// jsxr variable must be defined
import jsxr from 'jsxr';

Acknowledgments

Inspired by callumlocke/plain-jsx. It adds support for custom component elements, inline styles and using DOM property names (e.g. className instead of class), in order to add consistency for React developers.

License

The MIT License (MIT)

Copyright (c) 2015 Casey R. White

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

jsxr's People

Contributors

casecode avatar

Stargazers

İnanç Gümüş avatar Ingwie Phoenix avatar timelyportfolio avatar Li Yi avatar

Watchers

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