Home / Type/ RemoteImageProps Type — astro Architecture

RemoteImageProps Type — astro Architecture

Architecture documentation for the RemoteImageProps type/interface in types.ts from the astro codebase.

Entity Profile

Dependency Diagram

graph TD
  ebbab252_b941_8e8d_3c06_f440568e4633["RemoteImageProps"]
  a061abff_b26a_1eda_52cf_ff7a2af40052["types.ts"]
  ebbab252_b941_8e8d_3c06_f440568e4633 -->|defined in| a061abff_b26a_1eda_52cf_ff7a2af40052
  style ebbab252_b941_8e8d_3c06_f440568e4633 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/assets/types.ts lines 254–288

export type RemoteImageProps<T> =
	| (ImageSharedProps<T> & {
			/**
			 * URL of a remote image. Can start with a protocol (ex: `https://`) or alternatively `/`, or `Astro.url`, for images in the `public` folder
			 *
			 * Remote images are not optimized, and require both `width` and `height` to be set.
			 *
			 * **Example**:
			 * ```
			 * <Image src="https://example.com/image.png" width={450} height={300} alt="..." />
			 * ```
			 */
			src: string;
			/**
			 * When inferSize is true width and height are not required
			 */
			inferSize: true;
	  })
	| (WithRequired<ImageSharedProps<T>, 'width' | 'height'> & {
			/**
			 * URL of a remote image. Can start with a protocol (ex: `https://`) or alternatively `/`, or `Astro.url`, for images in the `public` folder
			 *
			 * Remote images are not optimized, and require both `width` and `height` to be set.
			 *
			 * **Example**:
			 * ```
			 * <Image src="https://example.com/image.png" width={450} height={300} alt="..." />
			 * ```
			 */
			src: string;
			/**
			 * When inferSize is false or undefined width and height are required
			 */
			inferSize?: false | undefined;
	  });

Frequently Asked Questions

What is the RemoteImageProps type?
RemoteImageProps is a type/interface in the astro codebase, defined in packages/astro/src/assets/types.ts.
Where is RemoteImageProps defined?
RemoteImageProps is defined in packages/astro/src/assets/types.ts at line 254.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free