Skip to content

futpib/preact-r-dom

Repository files navigation

preact-r-dom Build Status

Preact DOM wrapper. (r-dom fork for Preact).

Usage

var preact = require('preact');
var r = require('preact-r-dom');

var AnotherComponent = require('./another-component');

module.exports = class extends preact.Component {
  render() {
    return (
      r.div({className: 'example'}, [
        r.h1('Hello World!'),
        r.h2('This is React.js markup'),
        r(AnotherComponent, {foo: 'bar'}),
        r.div({
          classSet: { // Automatically use `classnames` module for classSet
            foo: this.props.foo,
            bar: this.props.bar
          },
          isRendered: this.props.foo // div won't render if isRendered is falsy
        })
      ])
    );
  }
};

Documentation

r[tag]([properties], [children])

Returns a React element

  • tag String - A React.DOM tag string
  • properties Object optional - An object containing the properties you'd like to set on the element.
  • children Array|String optional - An array of r children or a string. This will create child elements or a text node, respectively.

r(component, [properties], [children])

Returns a React element

  • component Function - A React.js Component class created with React.createClass
  • properties Object optional - An object containing the properties you'd like to set on the element.
  • children Array|String optional - An array of r children or a string. This will create child elements or a text node, respectively.

Special Properties

  • isRendered "Boolean" optional - If falsy, React will skip rendering the target component.
  • classSet Object optional - Apply classnames and assign to className.

About

r-dom-like Preact DOM wrapper (JSX alternative)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published