refactor!: remove immediate option

Author: johannschopplich

docs/api/lazy-load.md

@@ -62,18 +62,6 @@ interface UnLazyLoadOptions {
    */
   placeholderSize?: number
 
-  /**
-   * Controls whether the image should be loaded immediately, or only when it
-   * enters the viewport.
-   *
-   * @remarks
-   * This option is intended primarily for internal usage in frontend framework
-   * components that need to control when single images should be loaded.
-   *
-   * @default false
-   */
-  immediate?: boolean
-
   /**
    * A callback function to run when an image is loaded.
    */

docs/integrations/nuxt.md

@@ -83,7 +83,6 @@ The `UnLazyImage` component accepts the following props:
 | `blurhash` | String | A BlurHash string representing the blurry placeholder image. |
 | `placeholderSize` | Number | The size of the longer edge (width or height) of the BlurHash image to be decoded, depending on the aspect ratio. This option only applies when the `blurhash` prop is used. |
 | `placeholderRatio` | Number | Aspect ratio (width / height) of the decoded BlurHash image. Only applies to SSR-decoded placeholder images from a BlurHash string. |
-| `immediate` | Boolean | A flag to indicate whether the image should be loaded immediately. |
 | `ssr` | Boolean | Whether the ThumbHash or BlurHash should be decoded on the server. Overrides the global module configuration if set. |
 
 ## Examples

docs/integrations/react.md

@@ -50,7 +50,6 @@ The `UnLazyImage` component accepts the following props:
 | `blurhash` | String | A BlurHash string representing the blurry placeholder image. |
 | `thumbhash` | String | A ThumbHash string representing the blurry placeholder image. |
 | `placeholderSize` | Number | The size of the longer edge (width or height) of the BlurHash image to be decoded, depending on the aspect ratio. This option only applies when the `blurhash` prop is used. |
-| `immediate` | Boolean | A flag to indicate whether the image should be loaded immediately. |
 
 ## Examples
 

docs/integrations/solid.md

@@ -50,7 +50,6 @@ The `UnLazyImage` component accepts the following props:
 | `blurhash` | String | A BlurHash string representing the blurry placeholder image. |
 | `thumbhash` | String | A ThumbHash string representing the blurry placeholder image. |
 | `placeholderSize` | Number | The size of the longer edge (width or height) of the BlurHash image to be decoded, depending on the aspect ratio. This option only applies when the `blurhash` prop is used. |
-| `immediate` | Boolean | A flag to indicate whether the image should be loaded immediately. |
 
 ## Examples
 

docs/integrations/svelte.md

@@ -48,7 +48,6 @@ The `UnLazyImage` component accepts the following props:
 | `blurhash` | String | A BlurHash string representing the blurry placeholder image. |
 | `thumbhash` | String | A ThumbHash string representing the blurry placeholder image. |
 | `placeholderSize` | Number | The size of the longer edge (width or height) of the BlurHash image to be decoded, depending on the aspect ratio. This option only applies when the `blurhash` prop is used. |
-| `immediate` | Boolean | A flag to indicate whether the image should be loaded immediately. |
 
 ## Examples
 

docs/integrations/vue.md

@@ -65,7 +65,6 @@ The `UnLazyImage` component accepts the following props:
 | `blurhash` | String | A BlurHash string representing the blurry placeholder image. |
 | `thumbhash` | String | A ThumbHash string representing the blurry placeholder image. |
 | `placeholderSize` | Number | The size of the longer edge (width or height) of the BlurHash image to be decoded, depending on the aspect ratio. This option only applies when the `blurhash` prop is used. |
-| `immediate` | Boolean | A flag to indicate whether the image should be loaded immediately. |
 
 ## Examples
 

packages/core/src/types.ts

@@ -35,18 +35,6 @@ export interface UnLazyLoadOptions {
    */
   placeholderSize?: number
 
-  /**
-   * Controls whether the image should be loaded immediately, or only when it
-   * enters the viewport.
-   *
-   * @remarks
-   * This option is intended primarily for internal usage in frontend framework
-   * components that need to control when single images should be loaded.
-   *
-   * @default false
-   */
-  immediate?: boolean
-
   /**
    * A callback function to run when an image is loaded.
    */

packages/react/src/index.tsx

@@ -15,19 +15,13 @@ interface Props
   blurhash?: string
   /** A ThumbHash string representing the blurry placeholder image. */
   thumbhash?: string
-  /**
-   * A flag to indicate whether the image should be loaded immediately.
-   * @default false
-   */
-  immediate?: boolean
 }
 
 export function UnLazyImage({
   autoSizes,
   blurhash,
   thumbhash,
   placeholderSize,
-  immediate,
   ...rest
 }: Props) {
   const target = useRef<HTMLImageElement | null>(null)
@@ -38,13 +32,12 @@ export function UnLazyImage({
         hash: thumbhash || blurhash,
         hashType: thumbhash ? 'thumbhash' : 'blurhash',
         placeholderSize,
-        immediate,
       })
       return () => {
         cleanup()
       }
     }
-  }, [blurhash, thumbhash, placeholderSize, immediate])
+  }, [blurhash, thumbhash, placeholderSize])
 
   return (
     <img

packages/solid/src/index.tsx

@@ -15,11 +15,6 @@ interface Props
   blurhash?: string
   /** A ThumbHash string representing the blurry placeholder image. */
   thumbhash?: string
-  /**
-   * A flag to indicate whether the image should be loaded immediately.
-   * @default false
-   */
-  immediate?: boolean
 }
 
 export function UnLazyImage(props: Props) {
@@ -34,7 +29,6 @@ export function UnLazyImage(props: Props) {
         hash: props.thumbhash || props.blurhash,
         hashType: props.thumbhash ? 'thumbhash' : 'blurhash',
         placeholderSize: props.placeholderSize,
-        immediate: props.immediate,
       })
 
       onCleanup(() => {

packages/svelte/src/lib/UnLazyImage.svelte

@@ -13,11 +13,6 @@
   /** A ThumbHash string representing the blurry placeholder image. */
   export let thumbhash: string | undefined = undefined
   export let placeholderSize: UnLazyLoadOptions['placeholderSize'] = 32
-  /**
-   * A flag to indicate whether the image should be loaded immediately.
-   * @default false
-   */
-  export let immediate = false
 
   let target: HTMLImageElement | undefined
   let cleanup: (() => void) | undefined
@@ -34,7 +29,6 @@
       hash: thumbhash || blurhash,
       hashType: thumbhash ? 'thumbhash' : 'blurhash',
       placeholderSize,
-      immediate,
     })
   }