digitalunited/du-responsive-images

Responsive Images for Developers

0.0.15 2017-05-22 11:04 UTC

This package is not auto-updated.

Last update: 2024-04-27 15:09:48 UTC


README

##Why?!? TODO

##How?!? TODO

##Libs

##Useage

\DigitalUnited\ResponsiveImage::render([
    'imgId' => $imgId,
    'output' => 'img'
    'ratio' => '4x3',
    'imgAttributes' => [
        'class' => [],
        'alt' =>  $alt,
    ],
    'wrapperAttributes' => [
        'class' => [],
    ],
    'divWithBgImageAttributes' => [
        'class' => ['cover']
    ]
]);

##Options

imgId

A WordPress attachment image id.

Output (All is not implemented yet)

  • img: Regular img-tag (Not implemented, yet)
  • img: Regular img wrapped in a div with kept aspect-ratio. The img behaves normal if the ratio setting is omitted.
  • div: Div with srcset
  • srcset: For usage in "data-srcset"-tag

Ratio (Optional)

The following aspect ratios are available.

  • string "1x1"
  • string "2x1"
  • string "4x1"
  • string "4x3"
  • string "16x9"
  • string "1x2"
  • string "1x4"
  • string "3x4"
  • string "9x16"

Ratio (Only valid when "output = img-ratio" or "output = img")

imgAttributes and wrapperAttributes (Only valid when "output = img")

HTML attributes added to the wrapper-div and the img-tag when using img output mode

divWithBgImageAttributes (Only valid when "output = div")

Output as div has 2 premade helper classes to avoid inline styling, "cover" and "contain".

##TODO

  • Caching of rendering
  • Ratios with bootstrap breakpoints
  • Use printplugin for Lazysizes