Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robbestad/react-iframe
Simple solution for using iframes in React
https://github.com/robbestad/react-iframe
Last synced: 13 days ago
JSON representation
Simple solution for using iframes in React
- Host: GitHub
- URL: https://github.com/robbestad/react-iframe
- Owner: robbestad
- License: isc
- Created: 2015-05-06T10:25:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-06T18:32:46.000Z (7 months ago)
- Last Synced: 2024-05-15T13:09:11.816Z (6 months ago)
- Language: TypeScript
- Size: 1.68 MB
- Stars: 423
- Watchers: 7
- Forks: 78
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# React Iframe
Simple React component for including an iframed page.
The component is fully typescript-supported.
## Usage
```jsx
import Iframe from 'react-iframe'
```
### Properties
**url** **(required)** - *string* the iframe url.
_all other attributes are optional_
**src** - *string* if set, overrides _url_.
**scrolling** - *string* not set if if not provided (deprecated in HTML5).
**overflow** - *string* default to "hidden".
**loading** - *string* (not added to DOM if not provided).
**frameBorder** - *number* default to "0" (deprecated in HTML5).
**position** - *string* (not added to DOM if not provided).
**id** - *string* if set, adds the id parameter with the given value.
**className** - *string* if set, adds the class parameter with the given value.
**display** - *string* defaults to "block"
**height** - *string* (1px > any number above 0, or 1% to 100%)
**width** - *string* (1px > any number above 0, or 1% to 100%)
**allowFullScreen** - if set, applies the allowFullScreen param (deprecated in HTML5). If set, *adds allow="fullscreen"*.
**sandbox** - add optional sandbox values. For single value, add as string. For multiple values, add as array ({"allow-scripts", "allow-same-origin"}). Valid values are `"allow-forms allow-pointer-lock allow-popups allow-same-origin allow-scripts allow-top-navigation"`
**allow** - add optional [_allow_](https://dev.chromium.org/Home/chromium-security/deprecating-permissions-in-cross-origin-iframes#TOC-To-continue-to-use-permissions-from-iframes-on-your-website) values ("geolocation microphone camera midi encrypted-media & more")
**styles** - add any additional styles here. Will (intentionally) override any of the props
above. For instance:
```jsx
```
will set the height to 25px even though it was specified as 100% in the props.
A comprehensive overview of the iframe element is available from the [MDN web docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe).
# Development
All source code resides in the `src/` folder. The other code paths are generated by the tsc compiler.
# When to use
This project provides a convenient TypeScript-enabled wrapper around the native HTML tag. You can achieve the same functionality with the native tag. You do not need to use TypeScript in your project to consume this library.