Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 4.31 KB

readme.md

File metadata and controls

88 lines (63 loc) · 4.31 KB
Raw

AngularJS Picturefill directive

An AngularJS directive to work with Scott Jehl's Picturefill plugin for responsive images.

This directive works with dynamic content populated by the $scope.

See the demo here.

Usage

You can download and install into your project using Bower:

bower install angular-picturefill --save
grunt bower-install
  1. Download and install with Bower or manually include this directive and Picturefill in your HTML.
  2. Add ng.picturefill as an app dependency.
  3. Use the picture-fill directive in your view.
  4. Implement Picturefill as usual. Below is an example implementation but you can specify as many options as you like. The only difference is that data-src must be pf-src to avoid conflict.
  5. Use the provided trimExt filter on all URLs to remove the file extension so that you can append your custom image sizes. Don't forget to put it back.

Note: All images must share the same file extension for this directive to work properly and all file sizes must be available for each file.

With static images

<span picture-fill data-alt="Juicy hanger steak on a croissant.">
  <span pf-src="images/sizes/steak-croissant.png"></span>
  <span pf-src="images/sizes/steak-croissant-100.png" data-media="(min-width: 1px)"></span>
  <span pf-src="images/sizes/steak-croissant-300.png" data-media="(min-width: 400px)"></span>
  <span pf-src="images/sizes/steak-croissant-600.png" data-media="(min-width: 645px)"></span>
  <span pf-src="images/sizes/steak-croissant-1024.png" data-media="(min-width: 960px)"></span>
  <span pf-src="images/sizes/steak-croissant.png" data-media="(min-width: 1200px)"></span>
</span>

With $scope data

The filter trimExt is provided for working with $scope data.

<span picture-fill data-alt="{{post.thumbnail.description}}" ng-if="post.thumbnail">
  <span pf-src="{{post.thumbnail.url}}"></span>
  <span pf-src="{{post.thumbnail.url | trimExt}}-150x150.jpg" data-media="(min-width: 1px)"></span>
  <span pf-src="{{post.thumbnail.url | trimExt}}-300x300.jpg" data-media="(min-width: 1px) and (-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi),(min-resolution: 1.5dppx)"></span>
  <span pf-src="{{post.thumbnail.url | trimExt}}-300x225.jpg" data-media="(min-width: 320px)"></span>
  <span pf-src="{{post.thumbnail.url | trimExt}}-600x450.jpg" data-media="(min-width: 320px) and (-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi),(min-resolution: 1.5dppx)"></span>
  <span pf-src="{{post.thumbnail.url | trimExt}}-1024x768.jpg" data-media="(min-width: 645px)"></span>
  <span pf-src="{{post.thumbnail.url | trimExt}}.jpg" data-media="(min-width: 645px) and (-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi),(min-resolution: 1.5dppx)"></span>
  <span pf-src="{{post.thumbnail.url | trimExt}}.jpg" data-media="(min-width: 2068px)"></span>
</span>

Roadmap

In the future I would like to implement the following:

  • Not requiring all images to have the same file extension

License

The MIT License (MIT)

Copyright © 2014 Tinacious Design

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.

Bitdeli Badge