react-canvas README

The project's README from github.com/Flipboard/react-canvas. As one markdown file: README.md.

react-canvas

Introductory blog post

React Canvas adds the ability for React components to render to <canvas> rather than DOM.

This project is a work-in-progress. Though much of the code is in production on flipboard.com, the React canvas bindings are relatively new and the API is subject to change.

Motivation

Having a long history of building interfaces geared toward mobile devices, we found that the reason mobile web apps feel slow when compared to native apps is the DOM. CSS animations and transitions are the fastest path to smooth animations on the web, but they have several limitations. React Canvas leverages the fact that most modern mobile browsers now have hardware accelerated canvas.

While there have been other attempts to bind canvas drawing APIs to React, they are more focused on visualizations and games. Where React Canvas differs is in the focus on building application user interfaces. The fact that it renders to canvas is an implementation detail.

React Canvas brings some of the APIs web developers are familiar with and blends them with a high performance drawing engine.

Installation

React Canvas is available through npm:

npm install react-canvas

React Canvas Components

React Canvas provides a set of standard React components that abstract the underlying rendering implementation.

<Surface>

Surface is the top-level component. Think of it as a drawing canvas in which you can place other components.

<Layer>

Layer is the the base component by which other components build upon. Common styles and properties such as top, width, left, height, backgroundColor and zIndex are expressed at this level.

<Group>

Group is a container component. Because React enforces that all components return a single component in render(), Groups can be useful for parenting a set of child components. The Group is also an important component for optimizing scrolling performance, as it allows the rendering engine to cache expensive drawing operations.

<Text>

Text is a flexible component that supports multi-line truncation, something which has historically been difficult and very expensive to do in DOM.

<Image>

Image is exactly what you think it is. However, it adds the ability to hide an image until it is fully loaded and optionally fade it in on load.

<Gradient>

Gradient can be used to set the background of a group or surface. 

  render() {
    ...
    return (
      <Group style={this.getStyle()}>
        <Gradient style={this.getGradientStyle()} 
                  colorStops={this.getGradientColors()} />
      </Group>
    );
  }
  getGradientColors(){
    return [
      { color: "transparent", position: 0 },
      { color: "#000", position: 1 }
    ]
  }

<ListView>

ListView is a touch scrolling container that renders a list of elements in a column. Think of it like UITableView for the web. It leverages many of the same optimizations that make table views on iOS and list views on Android fast.

Events

React Canvas components support the same event model as normal React components. However, not all event types are currently supported.

For a full list of supported events see EventTypes.

Building Components

Here is a very simple component that renders text below an image:

var React = require('react');
var ReactCanvas = require('react-canvas');

var Surface = ReactCanvas.Surface;
var Image = ReactCanvas.Image;
var Text = ReactCanvas.Text;

var MyComponent = React.createClass({

  render: function () {
    var surfaceWidth = window.innerWidth;
    var surfaceHeight = window.innerHeight;
    var imageStyle = this.getImageStyle();
    var textStyle = this.getTextStyle();

    return (
      <Surface width={surfaceWidth} height={surfaceHeight} left={0} top={0}>
        <Image style={imageStyle} src='...' />
        <Text style={textStyle}>
          Here is some text below an image.
        </Text>
      </Surface>
    );
  },

  getImageHeight: function () {
    return Math.round(window.innerHeight / 2);
  },

  getImageStyle: function () {
    return {
      top: 0,
      left: 0,
      width: window.innerWidth,
      height: this.getImageHeight()
    };
  },

  getTextStyle: function () {
    return {
      top: this.getImageHeight() + 10,
      left: 0,
      width: window.innerWidth,
      height: 20,
      lineHeight: 20,
      fontSize: 12
    };
  }

});

ListView

Many mobile interfaces involve an infinitely long scrolling list of items. React Canvas provides the ListView component to do just that.

Because ListView virtualizes elements outside of the viewport, passing children to it is different than a normal React component where children are declared in render().

The numberOfItemsGetter, itemHeightGetter and itemGetter props are all required.

var ListView = ReactCanvas.ListView;

var MyScrollingListView = React.createClass({

  render: function () {
    return (
      <ListView
        numberOfItemsGetter={this.getNumberOfItems}
        itemHeightGetter={this.getItemHeight}
        itemGetter={this.renderItem} />
    );
  },

  getNumberOfItems: function () {
    // Return the total number of items in the list
  },

  getItemHeight: function () {
    // Return the height of a single item
  },

  renderItem: function (index) {
    // Render the item at the given index, usually a <Group>
  },

});

See the timeline example for a more complete example.

Currently, ListView requires that each item is of the same height. Future versions will support variable height items.

Text sizing

React Canvas provides the measureText function for computing text metrics.

The Page component in the timeline example contains an example of using measureText to achieve precise multi-line ellipsized text.

Custom fonts are not currently supported but will be added in a future version.

css-layout

There is experimental support for using css-layout to style React Canvas components. This is a more expressive way of defining styles for a component using standard CSS styles and flexbox.

Future versions may not support css-layout out of the box. The performance implications need to be investigated before baking this in as a core layout principle.

See the css-layout example.

Accessibility

This area needs further exploration. Using fallback content (the canvas DOM sub-tree) should allow screen readers such as VoiceOver to interact with the content. We've seen mixed results with the iOS devices we've tested. Additionally there is a standard for focus management that is not supported by browsers yet.

One approach that was raised by Bespin in 2009 is to keep a parallel DOM in sync with the elements rendered in canvas.

Running the examples

npm install
npm start

This will start a live reloading server on port 8080. To override the default server and live reload ports, run npm start with PORT and/or RELOAD_PORT environment variables.

A note on NODE_ENV and React: running the examples with NODE_ENV=production will noticeably improve scrolling performance. This is because React skips propType validation in production mode.

Using with webpack

The brfs transform is required in order to use the project with webpack.

npm install -g brfs
npm install --save-dev transform-loader brfs

Then add the brfs transform to your webpack config

module: {
  postLoaders: [
    { loader: "transform?brfs" }
  ]
}

Contributing

We welcome pull requests for bug fixes, new features, and improvements to React Canvas. Contributors to the main repository must accept Flipboard's Apache-style Individual Contributor License Agreement (CLA) before any changes can be merged.

react-canvas (Flipboard/react-canvas)

touch
Searching Database…

13.2K ·GitHub
React-canvas
What is this?React Canvas is an open-source library from Flipboard that lets React components render to a canvas instead of the DOM, for building faster, app-like mobile web interfaces.
So how does it fit into my app — is it a library of components?Yes: an npm library of standard React components — Surface, Layer, Group, Text, Image, Gradient and ListView. You write regular React code; rendering to canvas is an implementation detail.
How do I start using it?Install it from npm, place your UI inside a Surface, and position Layer children with styles like top, left, width, height and backgroundColor. The bundled examples run with npm start on a live-reloading server, port 8080.
What do I need alongside it — anything special for bundling?npm pulls in its dependencies (fbjs, linebreak, scroller) automatically. If you build with webpack, you must add the brfs transform to your webpack config — that's the one non-obvious requirement.
Is it production-ready?Mostly: much of the code runs in production on flipboard.com, but the project is a work-in-progress and the canvas bindings are relatively new, so the API is subject to change.
Is this aimed at mobile web apps specifically?Yes — Flipboard built it because mobile web apps felt slow next to native apps, and it relies on hardware accelerated canvas in modern mobile browsers, with ListView copying iOS and Android list optimizations.
Can I use it in my own project, and any strings attached?The code is under the permissive BSD-3-Clause license. One catch: contributors to the main repository must accept Flipboard's Apache-style CLA before changes can be merged.
How does ListView handle long scrolling lists?It's a touch scrolling container like UITableView for the web: ListView virtualizes items outside the viewport, so you supply data via numberOfItemsGetter, itemHeightGetter and itemGetter props instead of normal children. Items must currently share the same height.
Do regular React events still work on canvas-drawn components?Yes — the components support the same event model as normal React components, though not all event types are supported yet; the supported list lives in EventTypes.
Can I use custom fonts or precise multi-line text?Custom fonts aren't supported yet. For layout, measureText computes text metrics so you can achieve precise multi-line ellipsized text, as the timeline example shows.
Will screen readers be able to read a canvas-rendered interface?That's still exploratory. Fallback DOM content in the canvas subtree should let screen readers like VoiceOver interact with it, but results were mixed on iOS, and browsers don't yet support the needed focus management standard.
What are similar projects?react-native-skia, phaser, react-native-skia, better-scroll, konva, matter-js, pretext, three.js
Which topics is it in?touch, layout, html5, canvas, rendering, graphics, ui-components, mobile, ui, web-development, performance, react
Creator
Flipboard
Size
0.1 MB
Stars
13.2K
Updated
CommitMar 27
Age
11y
Commits · 90 Days