Skip to content

Latest commit

 

History

History
589 lines (327 loc) · 24 KB

CHANGELOG.md

File metadata and controls

589 lines (327 loc) · 24 KB

9.8.1 (2023-12-12)

Bug Fixes

  • updates background component to merge props (06a3430)

9.8.0 (2023-08-04)

Features

  • add use client directive to index (daa840f)

9.7.0 (2023-02-02)

Features

  • allow width and height to be passed through htmlAttributes (c8ef392)

9.6.0 (2023-01-11)

Features

  • react-imgix-bg: optionally disable path encoding (4a1e206)

9.5.4 (2022-10-04)

Bug Fixes

  • source width/height HTML validation (5feb09b)
  • stop background infinite rerenders (a455b6d)

9.5.3 (2022-10-04)

9.5.2 (2022-07-26)

Bug Fixes

  • ci: build project between deploy steps and publishing (2cd0cdf)

9.5.1 (2022-05-11)

Bug Fixes

  • add support for react 18 (0e01aa4)

9.5.1-beta.1 (2022-05-10)

Bug Fixes

  • add support for react 18 (1da0bc3)

9.5.0 (2022-02-28)

Features

  • allow path encoding to be disabled for Imgix component (045bb42)

Bug Fixes

  • bug where _inPicture would be set on 's that were children of (4d57c1f)

9.4.0 (2022-02-08)

Features

9.3.1 (2022-01-28)

9.3.0 (2021-08-05)

Features

  • add support for customizing srcset generation (a00cf3a)

Bug Fixes

  • replace individual props with single srcSetOptions prop (9fc01fe)
  • revert changes to package-lock.json (d85b371)

9.2.0 (2021-06-17)

Features

  • add collapseImgixParams function to shorten imgix params (97e7155)
  • create imgixProvider component (cb7608b)
  • create mergeComponentProps & processProps (19684ed)
  • recursive merge imgixParams & htmlAttributes (34231c3)
  • wrap ReactImgix with props HOFs (07c1d0a)

Bug Fixes

  • move consumer validation to avoid unnecessary warnings (b034d8a)
  • remove compose (7860d12)
  • shadows prop spelling (41971fb)

9.1.5 (2021-06-02)

9.1.4 (2021-05-28)

Bug Fixes

  • constants out of sync with versions (a977614)

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

9.1.3 (2021-05-28)

Bug Fixes

  • 789: ensure children passed to background component update (643b809)

9.1.2 (2021-05-20)

9.1.1 (2021-04-24)

Bug Fixes

  • re-render Background only if a larger image is needed (#782) (53bb104), closes #763

9.1.0 (2021-04-23)

Features

9.0.4 (2021-04-14)

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

9.0.3 (2020-11-19)

9.0.2 (2020-04-02)

Bug Fixes

  • background: fortify hasDOMDimensions check for null height (#592) (c7fb86e)

9.0.1 (2019-11-22)

Bug Fixes

  • prevent overwriting htmlAttributes.ref (#496) (e15e1b2)

9.0.0 (2019-11-01)

This release brings the react-imgix API more in-line with that of imgix's rendering service.

The largest change users will notice is that this project's component will no longer generate a default fit=crop parameter. The original intention behind this was that generated images would maintain aspect ratio when at least one of the dimensions were specified. However, the default imgix API behavior sets fit=clip, which is now reflected in this project. Although this may not cause breaking changes for all users, it can result in unusual rendered image behavior in some cases. As such, we would rather err on the side of caution and provide users the ability to opt in to these changes via a major release.

If you are currently relying on the default generation of fit=crop when rendering images, you will now have to manually specify it when invoking the component:

<Imgix
	src="https://assets.imgix.net/examples/pione.jpg"
  sizes="100vw"
  imgixParams={{ fit: "crop" }}
/>

The other major change relates to how the component determines an image's aspect ratio. Instead of appending a calculated height h= value based on specified dimensions, the URL string will now be built using the imgix aspect ratio parameter ar=. Luckily, the interface for specifying an aspect ratio is no different from before. However, users will have to pass in the fit=crop parameter in order for it to take effect:

<Imgix
  src="http://assets.imgix.net/examples/pione.jpg"
  width={400}
	imgixParams={{ ar: "2:1", fit: "crop" }}
/>

Refactor

  • refactor: use ar parameter instead of calculating aspect ratio (#462) (fbe8082)
  • refactor: replace findDOMNode with callback refs (#476) (db3a1d7)

Bug Fixes

Chore

  • chore(clean): remove all deprecatedProps and types (#483) (d036132)

8.6.4 (2019-08-08)

Features

  • perf: optimize URL handling (#414) (8d14dcb)
  • perf: optimize constructUrl function (#418) (8d392a0)
  • perf: use string concatenation instead of template strings (#420) (f41cc73)
  • perf: use Object.assign instead of spread operator (#423) (29b25d5)

8.6.3 (2019-07-11)

Bug Fixes

  • render element as a fluid image by default (#404) (10a5434)
  • width query param overrides in srcSet (#406) (5791d11)

8.6.2 (2019-07-05)

Features

8.6.1 (2019-04-17)

Bug Fixes

  • deps: pin react-measure version to avoid regression (#343) (3344502)

8.6.0 (2019-04-04)

Bug Fixes

Features

  • append variable q parameters per dpr when rendering a fixed-size image (#322) (6594cea), resolves #129

8.5.1 (2018-12-21)

8.5.0 (2018-12-21)

Features

  • add container to render image as background behind children [WIP] (#236) (5c3ecf6), closes #160

8.4.0 (2018-11-26)

Features

8.3.1 (2018-11-06)

8.3.0 (2018-10-11)

Features

  • add aspect ratio support by calculating client-side (#201) (7ce0411), closes #161

8.2.0 (2018-10-01)

Features

8.1.0 (2018-09-13)

Features

  • add HTML attribute configuration, enabling use of third-party libraries e.g. lazysizes (#166) (8ced390)

8.0.1 (2018-08-26)

Bug Fixes

  • update typo in warnings about old type prop (b9fa1e5)

8.0.0 (2018-08-15)

This is a very large update to this library with a lot of breaking changes. We apologise for any issues this may cause, and we have tried to reduce the number of breaking changes. We have also worked to batch up all these changes into one release to reduce its impacts. We do not plan on making breaking changes for a while after this, and will be focussed on adding features.

The largest change in this major version bump is the move to width-based srcSet and sizes for responsiveness. This has a host of benefits, including better server rendering, better responsiveness, less potential for bugs, and perfomance improvements. This does mean that the old fitting-to-container-size behaviour has been removed. If this is necessary, an example of how this can be achieved can be found here

Please see the Upgrade Guide for more details on what to change.

Bug Fixes

  • warn the user when no passed as a child to fixes #90 (#151) (aab9358)

Features

  • implement responsiveness with srcSet and sizes (#159) (fa68df6), closes #158
  • reduce props API surface area (#162) (9fb0cb9)
  • refactor picture and source behaviour into different components (#163) (64d9b8a)

BREAKING CHANGES

  • picture and source types have been changed to components.
  • faces is no longer set by default.
  • srcSet behaviour has changed to use sizes + srcSets
  • type=bg has been removed
  • the following props have been removed: aggressiveLoad, component, fluid, precision, defaultHeight, defaultWidth
  • generateSrcSet has been changed to disableSrcSet
  • A fallback image will no longer be created when using react-imgix in picture mode

7.2.0 (2018-06-30)

Bug Fixes

  • alt text no longer cause images to render at wrong dimensions (#146) (d3183a6), closes #41
  • typo in CONTRIBUTING (74b996e)

Features

  • add ixlib url parameter to help Imgix support and analytics (#145) (44f3d32)

7.1.1 (2017-12-15)

7.1.0 (2017-12-15)

Features

7.0.0 (2017-11-17)

Chores

  • deps: update all deps, move to react 16 for testing (#120) (99f1f14)

BREAKING CHANGES

  • deps: only React v16 is now actively supported

v6.0.2 / 2017-10-26

  • Add single quotes to background url. (#119) - thanks @nickhavenly

v6.0.0 / 2017-05-05

Breaking Changes

  • React 0.14 no longer supported. This react-imgix version drops official support for React 0.14. This package will probably still work with 0.14, but we will not accept bugs or issues relating to React 0.14.
  • bg prop removed. This prop was deprecated in the past, and has now been removed. Please upgrade all usages to: type='bg'.

Important Note

Since this package now uses prop-types, when using a React version below 15.5, there will be duplicate propTypes. To fix this, please upgrade to 15.5, which no longer exports React.PropTypes.

Thanks

A massive thanks for @modosc for helping with this release, and upgrading to React 15.5.

  • fix React 15.5 warnings (#104) - @modosc
  • pull in prop-types from a separate module, fix sinon deprecation warning (#102)
  • Update travis config
  • Run prettier on code
  • Change prettier to 120 line length
  • Use prettier rather than standard
  • Add prettier
  • Update deps

v5.4.0 / 2017-04-06

  • add onMounted callback with access to underlying node (#94)

v5.3.0 / 2017-03-24

  • Background Size adjustments (#89)
  • fix typo - deprecated warning (#81)

v5.2.0 / 2016-12-02

  • Picture element (#60) - thanks @modosc

v5.1.0 / 2016-11-15

  • Added: crop prop to override crop url parameter #57 - @rbliss
  • Add additional tests testing crop prop overriding faces and entropy props
  • Enable passing in specific crop options, useful for specifying fallbacks to the ‘faces’ crop option
  • Add server-side rendering note to aggressiveLoad
  • Merge pull request #53 from imgix/fred-new-node-versions
  • lts => 6
  • Avoid blank background urls and src attributes (#51)
  • Update node versions supported
  • chore(package): update standard to version 8.2.0 (#47)
  • chore(package): update mocha to version 3.0.1 (#37)

v5.0.0 / 2016-07-22

  • Breaking: Unused props on the Imgix component are no longer passed down, use imgProps instead. #34 - @theolampert

v4.0.0 / 2016-06-07

  • Breaking: Images with a height of 1 (i.e. 1 x image height) were being rendered as 1px high images. Oops. Now it no longer does that. (#27)

v3.0.0 / 2016-05-11

  • Bump version to 3.0.0
  • Merge pull request #24 from imgix/23-aggressiveLoad-typo
  • Rename aggresiveLoad to aggressiveLoad.
  • Merge pull request #20 from imgix/url-and-base64-encoding
  • Ensure all query keys + B64 variants are encoded.
  • Make version links work in changelog
  • Add Changelog

v2.2.0 / 2016-02-23

  • Feature: forceLayout api, accessed by refs.imgix.forceLayout() (#15)
  • 2.2.0
  • Merge pull request #15 from theolampert/master
  • exposes forceLayout method to parent component

v2.1.2 / 2016-02-18

  • Update to Babel 6 (#10)
  • Change child props behaviour to only pass down props not used, not every prop (#9)
  • Bump version to 2.1.2
  • Merge pull request #9 from imgix/better-child-props
  • Change child props behaviour to only pass down props not used, not every prop
  • Merge pull request #10 from imgix/babel-6
  • Add transform-object-assign Babel plugin.
  • Change test commands
  • Update code to pass new class spec
  • Add babel 6 presets
  • Update tests to babel 6
  • Upgrade deps to babel 6
  • Change urls in package.json to imgix repo
  • Add code climate badge to readme

v2.1.1 / 2015-11-18

  • Feature: generateSrcSet prop to generate a srcSet attribute for images, only when in img mode. Enabled by default. See here for more (#4)
  • 2.1.1
  • Add generateSrcSet prop to Readme
  • Bump to 2.1.0
  • Merge pull request #4 from ekosz/patch-1
  • Automatically set srcSet attributes
  • Merge pull request #3 from ekosz/patch-1
  • Document customParams in README
  • Update README.md

v2.0.0 / 2015-11-05

  • Breaking: React 0.13 no longer supported. React 0.13 users should use v1.x
  • Breaking: Sets background-size: cover on the element when the bg prop is passed
  • react and react-dom added as peer dependencies
  • No longer imports the entire imgix.js library. Instead we just build the url ourselves.
  • Feature: Added entropy prop to support Point of Interest Cropping
  • 2.0.0
  • Add entropy to propTypes
  • And point of interest cropping as 'entropy' prop
  • Merge pull request #1 from imgix/feature/remove-imgixjs
  • Remove imgix.js from component
  • Remove imgix.js depenency
  • Use local uri builder than than imgix.js
  • 🎨
  • Copy support.js from coursera/react-imgix, rather than importing the whole imgix.js library
  • Upgrade api to React 0.14, introduces breaking change as we no longer support React 0.13
  • Add react to peer dependencies
  • Move from chai to mjackson/expect for tests
  • Use a react version matrix for Travis
  • Change other urls due to repo transfer
  • Change Travis url due to transfer of repo
  • Add code style badge
  • Ignore npm-debug.log
  • Running the tests didn't actually make it into the test commit -.-
  • Don't support old versions of node
  • Add badges to README
  • Add .travis.yml
  • Add some initial tests with mocha
  • Set backgroundSize: cover on component when it's in background mode
  • Add license

v1.0.4 / 2015-10-04

  • 1.0.4
  • Don't mutate props (oops)
  • Update README.md

v1.0.3 / 2015-09-24

  • 1.0.3
  • Fix typo in Readme, add import usage

v1.0.2 / 2015-09-23

  • 1.0.2
  • Add installation instructions to README

v1.0.1 / 2015-09-23

  • 1.0.1
  • Add readme
  • Remove unused resize prop

v1.0.0 / 2015-09-23

  • 1.0.0
  • No tests are fine
  • Add npm_debug.log to .gitignore and .npmignore
  • Change to babel stage 0
  • Add ReactImgix component
  • Initial Commit