https://github.com/ship-components/ship-components-responsive
React component to pass the parent container dimensions to a child component
https://github.com/ship-components/ship-components-responsive
Last synced: 25 days ago
JSON representation
React component to pass the parent container dimensions to a child component
- Host: GitHub
- URL: https://github.com/ship-components/ship-components-responsive
- Owner: ship-components
- Created: 2017-07-25T22:22:39.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-26T16:42:11.000Z (almost 9 years ago)
- Last Synced: 2026-05-19T11:00:02.734Z (about 1 month ago)
- Language: JavaScript
- Size: 38.1 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ship-components-responsive
React component to wrap another component and pass the parent container dimensions to it's children
[](https://www.npmjs.com/package/ship-components-responsive)
[](https://coveralls.io/github/ship-components/ship-components-responsive)
[](https://travis-ci.org/ship-components/ship-components-responsive)
[](https://david-dm.org/ship-components/ship-components-responsive)
[](https://david-dm.org/ship-components/ship-components-responsive?type=dev)
## Basic Usage
```js
import React from 'react';
import ResponsiveContainer from 'ship-components-responsive';
/**
* Example Embed Player
* @param {Object} props
* @constructor
*/
function EmbedPlayer(props) {
const {
src,
// The following two props are passed from ResponsiveContainer
containerWidth,
containerHeight
} = props;
return (
);
}
/**
* Warp the the component in a responsive container so it fits the space
* @param {Object} props
* @constructor
*/
export default function EmbedPlayerWrapper(props) {
return (
);
}
```
## Tests
1. `npm install`
2. `npm test`
## To do
* Add min/max height and widths
## History
* 0.1.0 - Initial
## License
The MIT License (MIT)
Copyright (c) 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.