Merge pull request #37 from Josh-McFarlin/fix-issues-and-prs

Fix issues and prs
Josh-McFarlin · Jun 21, 2022 · 49ad6bf · 49ad6bf
2 parents b93e4e8 + 7710afd
commit 49ad6bf
Show file tree

Hide file tree

Showing 10 changed files with 1,900 additions and 1,200 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+
+- Change sorting method of responsiveImage hook to order by maxWidth
+- Changed `ImagePosition` to string union with additional options
+- Converted `ImageFit` and `FlipDirection` types to string unions to match `ImagePosition`
+
 ## [0.3.18] - 2022-04-23
 
 ### CI

diff --git a/docs/docs/component.md b/docs/docs/component.md
@@ -49,7 +49,7 @@ export interface TransformOptions {
   /** How the image should be resized to fit both provided dimensions. (optional, default 'contain') */
   fit?: ImageFit;
   /** Position to use when fit is cover or contain. (optional, default 'center') */
-  position?: ImagePosition;
+  position?: ImagePosition | string | number;
   /** Background color of resulting image. (optional, default [0x00, 0x00, 0x00, 0x00]) */
   background?: Color;
   /** Quality, integer 1-100. (optional, default 80) */

diff --git a/docs/docs/hook.md b/docs/docs/hook.md
@@ -48,7 +48,7 @@ export interface TransformOptions {
   /** How the image should be resized to fit both provided dimensions. (optional, default 'contain') */
   fit?: ImageFit;
   /** Position to use when fit is cover or contain. (optional, default 'center') */
-  position?: ImagePosition;
+  position?: ImagePosition | string | number;
   /** Background color of resulting image. (optional, default [0x00, 0x00, 0x00, 0x00]) */
   background?: Color;
   /** Quality, integer 1-100. (optional, default 80) */

diff --git a/docs/docs/tutorial-basics/use-component.md b/docs/docs/tutorial-basics/use-component.md
@@ -47,7 +47,7 @@ export interface TransformOptions {
   /** How the image should be resized to fit both provided dimensions. (optional, default 'contain') */
   fit?: ImageFit;
   /** Position to use when fit is cover or contain. (optional, default 'center') */
-  position?: ImagePosition;
+  position?: ImagePosition | string | number;
   /** Background color of resulting image. (optional, default [0x00, 0x00, 0x00, 0x00]) */
   background?: Color;
   /** Quality, integer 1-100. (optional, default 80) */