https://github.com/jedwatson/react-container

A flexible container for laying out React apps. Part of TouchstoneJS.
https://github.com/jedwatson/react-container

Last synced: 13 days ago
JSON representation

A flexible container for laying out React apps. Part of TouchstoneJS.

• Host: GitHub
• URL: https://github.com/jedwatson/react-container
• Owner: JedWatson
• License: mit
• Created: 2015-06-09T09:15:51.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-15T12:03:52.000Z (almost 9 years ago)
• Last Synced: 2024-10-10T12:08:04.835Z (about 1 month ago)
• Language: JavaScript
• Size: 439 KB
• Stars: 57
• Watchers: 5
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Container

A flexible container for laying out React apps. Built for [TouchstoneJS](http://touchstonejs.io).

## Demo & Examples

Live demo: [JedWatson.github.io/react-container](http://JedWatson.github.io/react-container/)

To build the examples locally, run:

```

npm install

npm start

```

Then open [`localhost:8000`](http://localhost:8000) in a browser.

## Installation

The easiest way to use react-container is to install it from NPM and include it in your own React build process (using [Browserify](http://browserify.org), [Webpack](http://webpack.github.io/), etc).

You can also use the standalone build by including `dist/react-container.js` in your page. If you use this, make sure you have already included React, and it is available as a global variable.

```

npm install react-container --save

```

## Usage

> Coming Soon

```

var Container = require('react-container');

Example

```

### Properties

> Coming Soon

## Development (`src`, `lib` and the build process)

**NOTE:** The source code for the component is in `src`. A transpiled CommonJS version (generated with Babel) is available in `lib` for use with node.js, browserify and webpack. A UMD bundle is also built to `dist`, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run `npm start`. If you just want to watch changes to `src` and rebuild `lib`, run `npm run watch` (this is useful if you are working with `npm link`).

## License

The MIT License (MIT)

Copyright (c) 2015 Jed Watson

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.