README.md

Picture-Tag Rails

A Rails view helper extension to generate HTML5 <picture> tag markup from the W3C HTML Responsive Images Extension Proposal.

w3.org/community/respimg

Current Version

0.0.6

Requirements

• Ruby on Rails > 3.0 and < 4.0

Installation

Gemfile

Add this line to your application's Gemfile.

gem 'picture_tag-rails'

Manual

Or install it yourself.

gem install picture_tag-rails

Usage

Add to some Ruby file in your Rails app.

Use it in your views as you would the image_tag() helper.

<%= picture_tag(image_path, options) %>

Examples

The vanilla usage with default sizes and media queries:

<%= picture_tag("cat.jpg", alt: "Kitty cat!") %>

produces:

<picture>
  <source media="(min-width: 1600px)" srcset="cat-large.jpg 1x, cat-large@2x.jpg 2x" />
  <source media="(min-width: 1000px)" srcset="cat-medium.jpg 1x, cat-medium@2x.jpg 2x" />
  <source media="(min-width: 768px)"  srcset="cat-small.jpg 1x, cat-small@2x.jpg 2x" />
  <source media="(min-width: 480px)"  srcset="cat-tiny.jpg 1x, cat-tiny@2x.jpg 2x" />
  <source srcset="cat-tiny.jpg 1x, cat-tiny@2x.jpg 2x" />
  <img alt="Kitty cat!" src="cat-tiny.jpg" />
</picture>

Options

To exclude certain <source> elements with media queries above a max width:

<%= picture_tag(image_path, max_width: "600px") %>

To override the default media queries and names:

<%= picture_tag(image_path, sizes: { itty_bitty: "(min-width: 10px)" }) %>

To prefix (opposed to suffix) the filename with size ('/images/small-kitty.jpg'):

<%= picture_tag(image_path, prefix_size: true}) %>

To preload a custom default placeholder image:

<%= picture_tag(image_path, default_image: '/images/placeholder.png'}) %>

All image_tag options are valid for picture_tag. See image_tag Docs

Paperclip

Paperclip options for default media queries and sizes.

has_attached_file :image, {
  styles: {
    tiny:   "320x",
    small:  "480x",
    medium: "768x",
    large:  "1000x",
    huge:   "1600x",
    %s(tiny@2x)   => "640x",
    %s(small@2x)  => "960x",
    %s(medium@2x) => "1536x",
    %s(large@2x)  => "2000x",
    %s(huge@2x)  => "3200x"
  }

Configuration

• Retina support can be disabled by adding a configure block to your config

PictureTag.configure do |config|
  config.display_high_def = false
end

TODO

• Add optional paperclip integration functionality
• Intergrate with Travis.ci
• Implement Rails 4 support

Authors

• Bookis Smuin / @bookis
• Chad Crissman / @crissmancd
• John Lucia / @johnlucia
• Levi Brown / @levibrown
• Colton Fent / @colto

Contributions

1. Fork it
2. Get it running (see Installation above)
3. Create your feature branch (git checkout -b my-new-feature)
4. Write your code and specs
5. Commit your changes (git commit -am 'Add some feature')
6. Push to the branch (git push origin my-new-feature)
7. Create new Pull Request

If you find bugs, have feature requests or questions, please file an issue.

Specs

rake spec

Releases

TODO how do you do a release?

License

Copyright (c) 2012 G5

MIT License

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.