@docusaurus/plugin-ideal-image 2.4.1 → 3.0.0-beta.0

package/README.md

@@ -2,45 +2,6 @@
 
 Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).
 
-## Installation
-
-```sh
-yarn add @docusaurus/plugin-ideal-image
-```
-
-Modify your `docusaurus.config.js`
-
-```diff
-module.exports = {
-  ...
-+ plugins: ['@docusaurus/plugin-ideal-image'],
-  ...
-}
-```
-
 ## Usage
 
-Support png, gif and jpg only
-
-```jsx
-import Image from '@theme/IdealImage';
-import thumbnail from './path/to/img.png';
-
-// your react code
-<Image img={thumbnail} />
-
-// or
-<Image img={require('./path/to/img.png')} />
-```
-
-### Options
-
-| Option | Type | Default | Description |
-| --- | --- | --- | --- |
-| `name` | `string` | `ideal-img/[name].[hash:hex:7].[width].[ext]` | Filename template for output files. |
-| `sizes` | `array` | _original size_ | Specify all widths you want to use; if a specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up). You may also declare a default `sizes` array in the loader options in your `webpack.config.js`. |
-| `size` | `integer` | _original size_ | Specify one width you want to use; if the specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up) |
-| `min` | `integer` |  | As an alternative to manually specifying `sizes`, you can specify `min`, `max` and `steps`, and the sizes will be generated for you. |
-| `max` | `integer` |  | See `min` above |
-| `steps` | `integer` | `4` | Configure the number of images generated between `min` and `max` (inclusive) |
-| `quality` | `integer` | `85` | JPEG compression quality |
+See [plugin-ideal-image documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-ideal-image).

package/lib/theme/IdealImage/index.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import ReactIdealImage from '@endiliey/react-ideal-image';
+import ReactIdealImage from '@slorber/react-ideal-image';
 import {translate} from '@docusaurus/Translate';
 // Adopted from https://github.com/endiliey/react-ideal-image/blob/master/src/components/helpers.js#L59-L65
 function bytesToSize(bytes) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-ideal-image",
-  "version": "2.4.1",
+  "version": "3.0.0-beta.0",
   "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).",
   "main": "lib/index.js",
   "types": "src/plugin-ideal-image.d.ts",
@@ -20,26 +20,26 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.4.1",
-    "@docusaurus/lqip-loader": "2.4.1",
+    "@docusaurus/core": "3.0.0-beta.0",
+    "@docusaurus/lqip-loader": "3.0.0-beta.0",
     "@docusaurus/responsive-loader": "^1.7.0",
-    "@docusaurus/theme-translations": "2.4.1",
-    "@docusaurus/types": "2.4.1",
-    "@docusaurus/utils-validation": "2.4.1",
-    "@endiliey/react-ideal-image": "^0.0.11",
+    "@docusaurus/theme-translations": "3.0.0-beta.0",
+    "@docusaurus/types": "3.0.0-beta.0",
+    "@docusaurus/utils-validation": "3.0.0-beta.0",
+    "@slorber/react-ideal-image": "^0.0.12",
     "react-waypoint": "^10.3.0",
-    "sharp": "^0.30.7",
-    "tslib": "^2.4.0",
-    "webpack": "^5.73.0"
+    "sharp": "^0.32.3",
+    "tslib": "^2.6.0",
+    "webpack": "^5.88.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.1",
-    "fs-extra": "^10.1.0"
+    "@docusaurus/module-type-aliases": "3.0.0-beta.0",
+    "fs-extra": "^11.1.0"
   },
   "peerDependencies": {
     "jimp": "*",
-    "react": "^16.8.4 || ^17.0.0",
-    "react-dom": "^16.8.4 || ^17.0.0"
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
   },
   "peerDependenciesMeta": {
     "jimp": {
@@ -49,5 +49,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "60e657d8ae5a4a9ed1c2d777f9defd882cc12681"
+  "gitHead": "27a1e90d9fff88af90ecad35bea16d4d7230482a"
 }

package/src/deps.d.ts

@@ -12,7 +12,7 @@
  * Note: the original type definition is WRONG. getIcon & getMessage receive
  * full state object.
  */
-declare module '@endiliey/react-ideal-image' {
+declare module '@slorber/react-ideal-image' {
   import type {ComponentProps, ComponentType, CSSProperties} from 'react';
 
   export type LoadingState = 'initial' | 'loading' | 'loaded' | 'error';

package/src/theme/IdealImage/index.tsx

@@ -9,7 +9,7 @@ import React from 'react';
 import ReactIdealImage, {
   type IconKey,
   type State,
-} from '@endiliey/react-ideal-image';
+} from '@slorber/react-ideal-image';
 import {translate} from '@docusaurus/Translate';
 
 import type {Props} from '@theme/IdealImage';