script based high pixel density support tools
HTML JavaScript CSS
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/demo
src
tmp
.gitignore
README.md

README.md

Retinize simple pixel density tools

Script based high pixel density support tools.

Example of use can be viewed here - http://codex.web-engineer.co.uk/example/highdpi/

Also see the wiki for an overview - https://github.com/web-engineer/retinize/wiki

To use this script we recommend using the current compressed version bundled in the example files within the release. https://github.com/web-engineer/retinize/blob/master/lib/demo/retinize.js

After you include your standard CSS link(s) in the part of your document you will need to include a link to "Retinize" as follows. Note the "Retinize.support" line is where you can specify the pixel densities you wish to support and their related style sheets.

<script src="retinize.js" type="text/javascript"></script>
<script type="text/javascript">
	<!--
	Retinize.support(2,'rt-highrez.css');
	//-->
</script>

You can use this script to automatically switch regular images to high density ones when possible using the following method -

<script type="text/javascript">
<!--
Retinize.get('somefile.png', 128, 137);
//--></script>
<noscript><img src="somefile.png"/></noscript>

note - the naming convention for images is [YOURFILE]-x[DENSITY].[EXTENSION] e.g. in the example above the double density version of somefile.png should be named somefile-x2.png on the server

Note - there is an optional fourth argument to Retinize.get, this can carry an object containing any extra attributes you want to assign to your image. For example to float an image right and to add alternate text you would write -

<script type="text/javascript">
<!--
Retinize.get('somefile.png', 128, 137,{style:'float:right',alt:'some file'});
//--></script>
<noscript><img src="somefile.png" style="float:right" alt="some file"/></noscript>

Project structure

lib/demo/ A full working demo of the script in action. This contains a compressed version of the retinize script, you should use this with your project.

src The source code, commented.

Get involved

Pull requests and bug reports welcome. You can also email us on support[at]web-engineer.co.uk with any feedback and suggestions.