1.0.0 • Published 9 years ago

iframer v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
9 years ago

IFRAMEr makes your components portable and your life easier.

If you look for a simple approach which helps creating reusable web components - IFRAMEr might be exactly what you need. This is a small JavaScript function that wraps your html markup with all styles and scripts you need for its work - into dynamically created iframe element, so page can't suddenly break the original design of your component.

Overview

Enjoy with the demo on JsFiddle first: https://jsfiddle.net/vmysla/7rhgoeuq/3/embedded/result/

IFRAMEr solved my problem

Demo: https://jsfiddle.net/vmysla/7rhgoeuq/3/embedded/result/

IFRAMEr has no dependencies. Total size for minified version of the script is 495 bytes gzipped (798 bytes uncompressed). You can extend and customize it by adding own tasks.

Feel free to fork: git clone https://github.com/vmysla/IFRAMEr

Get started

Widget is any web component which is wrapped into IFRAME for its wide distribution in the web. You can create widgets from any frontend element you have on the page:

    ...
	<h1>This is a page</h1>
	...
	<!-- Let's say, this is the part of your page which you want to reuse on different sites: --> 
	<style> 
		b { color : red; } 
	</style>
	<div>
    	Hi! <br/> I'm simple <b id="term">html element</b>!
    </div>
    <script type="widget/javascript">
	    document.getElementById('term').innerHTML = 'web component';
	</script>
	...

It has own HTML markup, CSS styles and JavaScript code as well. To make a widget - you have to put all those things into script tags with special type attributes:

####1. Wrap your HTML code with the script[type=widget/html] tag

	<script type="widget/html">
		<style> 
			b { color : red; } 
		</style>
		<div>
	    	Hi! <br/> I'm simple <b id="term">web component</b>!
	    </div>
	</script>

####2. Put your JavaScript code for widget into script[widget/javascript], right after 1.

	<script type="widget/javascript">
	    document.getElementById('term').innerHTML = 'iframe widget';
	</script>

####3. Add IFRAMEr script just before closing body tag

     ...
     <script src="//rawgit.com/vmysla/IFRAMEr/master/dist/iframer.min.js"></script>
  </body>

Because all your markup and code are placed into own script tags - browser wouldn't render nor execute them. In another hand, IFRAMEr is looking for such tags on your pages and replaces them with IFRAMEs it generates on fly.

Supported browsers

Currently it supports IE6+, FF3.5+, and rest of the modern browsers for Linux, Windows and Mac.

Google Analytics

As a bonus IFRAMEr automatically provides Universal Google Analytics Web Tracker (ga function) from the page into widget's IFRAME.

License

MIT.