Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ship-components/ship-components-grid
React masonry grid
https://github.com/ship-components/ship-components-grid
babel javascript javascript-library jsx loader masonry react ship-components-grid webpack
Last synced: about 2 months ago
JSON representation
React masonry grid
- Host: GitHub
- URL: https://github.com/ship-components/ship-components-grid
- Owner: ship-components
- License: mit
- Created: 2016-08-24T22:14:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-06T20:16:59.000Z (about 6 years ago)
- Last Synced: 2024-10-13T22:21:19.128Z (3 months ago)
- Topics: babel, javascript, javascript-library, jsx, loader, masonry, react, ship-components-grid, webpack
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ship-components-grid
- Size: 47.9 KB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ship-components-grid
[React](http://facebook.github.io/react/) [masonry](http://masonry.desandro.com/) layout. Exports a commonjs module that can be used with [webpack](http://webpack.github.io/). Source is in ES6 and is compiled down to ES5 using [Babel](https://babeljs.io/).
[](https://www.npmjs.com/package/ship-components-grid)
[](https://travis-ci.org/ship-components/ship-components-grid)
[](https://coveralls.io/github/ship-components/ship-components-grid)
[](https://david-dm.org/ship-components/ship-components-grid?type=dev)
## Usage
### ES6/JSX (Recommended)
The component is written using ES6/JSX therefore Babel is recommended to use it. The below example is based on using [webpack](http://webpack.github.io/) and [babel-loader](https://github.com/babel/babel-loader).
```js
import React from 'react';
import Grid from 'ship-components-grid';
export default class View extends React.Component {
render() {
return (
{this.props.items.map(item => {
return (
)
})}
);
}
}
```
## Examples and Development
Examples can be found in the `examples/` folder. A development server can be run with:
```shell
$ npm install
$ npm start
```
This will live reload any changes you make and serve them at http://localhost:8080.
### Webpack Configuration
This module is designed to be used with webpack but requires a few loaders if you are pulling the source into another project.
```shell
$ npm install webpack babel-loader --save-dev
```
Below are is a sample of how to setup the loaders:
```js
/**
* Relevant Webpack Configuration
*/
{
[...]
module: {
loaders: [
// Setup support for ES6
{
test: /\.(jsx?|es6)$/,
exclude: /node_modules/,
loader: 'babel'
},
// ES6/JSX for external ship-components modules
{
test: /\.(jsx?|es6)$/,
include: [
/ship-components\-.*\/src/
],
loader: 'babel'
}
]
}
[...]
}
```
## Tests
1. `npm install`
2. `npm test`
## History
* 0.3.0 - Updates to the latest babel configurations (babel-preset-env)
* 0.2.4 - Updates Jests, Travis CI and Coveralls as well as minor ESLint and React warning messages
* 0.2.3 - Added Internet Explorer(10 & 11) onResize event support
* 0.2.2 - Added more fixes for narrow screens
* 0.2.1 - Added a fix to not update layout when masonry isn't active
* 0.2.0 - Added option to disable under certain widths
* 0.1.0 - Initial
## License
The MIT License (MIT)
Copyright (c) 2016 SHIP
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.