ResponsiveImage

Appearance

Netlify ​

The image processing capabilities of the Netlify Image CDN are supported by a helper function provided to you by this library.

Setup ​

Make sure you have the @responsive-image/cdn package installed:

bash
npm install @responsive-image/cdn
bash
yarn add @responsive-image/cdn
bash
pnpm add @responsive-image/cdn

By default, requests to the Netlify CDN will use URLs relative to your deployed app, which will work when the app itself is also deployed to Netlify. For other cases, you can specify the domain of your Netlify site in your configuration, which you can set up in your application (e.g. app.js):

js
import { setConfig } from '@responsive-image/core';

setConfig('cdn', {
  netlify: {
    domain: 'my-org.netlify.app',
  },
});

Usage ​

IMPORTANT

Please make sure you have read the section on remote images first.

Use the Netlify provider function passing the path to your image, and pass the return value to the image component:

gjs
import { ResponsiveImage } from '@responsive-image/ember';
import { netlify } from '@responsive-image/cdn';

<template>
  <ResponsiveImage @src={{netlify '/path/to/image.jpg'}} />
</template>
hbs
<ResponsiveImage @src={{responsive-image-netlify '/path/to/image.jpg'}} />
ts
import { LitElement, html } from 'lit';
import { customElement } from 'lit/decorators.js';
import { netlify } from '@responsive-image/cdn';
import '@responsive-image/wc';

@customElement('my-app')
export class MyApp extends LitElement {
  render() {
    return html`<responsive-image
      .src=${netlify('/path/to/image.jpg')}
    ></responsive-image>`;
  }
}
tsx
import { ResponsiveImage } from '@responsive-image/solid';
import { netlify } from '@responsive-image/cdn';

export default function MyApp() {
  return <ResponsiveImage src={netlify('path/to/uploaded/image.jpg')} />;
}

This assumes that your application itself is also served from Netlify, so that /path/to/image.jpg is an image in your repo that is also deployed to Netlify. If your application containing that image is not on Netlify, you can still make Netlify process and serve it, you just need to point to it with an absolue URL to make use of Netlify's remote source support.

Aspect Ratio ​

For the image component to be able to render width and height attributes to prevent layout shifts after loading has completed, it needs to know the aspect ratio of the source image. Unlike local images it cannot know this upfront for remote images, that's why it is recommended to supply the aspectRatio parameter if possible:

gjs
import { ResponsiveImage } from '@responsive-image/ember';
import { netlify } from '@responsive-image/cdn';

<template>
  <ResponsiveImage
    @src={{netlify
      '/path/to/image.jpg'
      aspectRatio=1.5
    }}
  />
</template>
hbs
<ResponsiveImage
  @src={{responsive-image-netlify '/path/to/image.jpg' aspectRatio=1.5}}
/>
ts
import { LitElement, html } from 'lit';
import { customElement } from 'lit/decorators.js';
import { netlify } from '@responsive-image/cdn';
import '@responsive-image/wc';

@customElement('my-app')
export class MyApp extends LitElement {
  render() {
    return html`<responsive-image
      .src=${netlify('/path/to/image.jpg', {
        aspectRatio: 1.5,
      })}
    ></responsive-image>`;
  }
}
tsx
import { ResponsiveImage } from '@responsive-image/solid';
import { netlify } from '@responsive-image/cdn';

export default function MyApp() {
  return (
    <ResponsiveImage
      src={netlify('path/to/uploaded/image.jpg', {
        aspectRatio: 1.5,
      })}
    />
  );
}

Quality ​

Use the quality parameter to pass a custom quality setting instead of the default auto:

gjs
import { ResponsiveImage } from '@responsive-image/ember';
import { netlify } from '@responsive-image/cdn';

<template>
  <ResponsiveImage
    @src={{netlify
      '/path/to/image.jpg'
      quality=50
    }}
  />
</template>
hbs
<ResponsiveImage
  @src={{responsive-image-netlify '/path/to/image.jpg' quality=50}}
/>
ts
import { LitElement, html } from 'lit';
import { customElement } from 'lit/decorators.js';
import { netlify } from '@responsive-image/cdn';
import '@responsive-image/wc';

@customElement('my-app')
export class MyApp extends LitElement {
  render() {
    return html`<responsive-image
      .src=${netlify('/path/to/image.jpg', {
        quality: 50,
      })}
    ></responsive-image>`;
  }
}
tsx
import { ResponsiveImage } from '@responsive-image/solid';
import { netlify } from '@responsive-image/cdn';

export default function MyApp() {
  return (
    <ResponsiveImage
      src={netlify('path/to/uploaded/image.jpg', {
        quality: 50,
      })}
    />
  );
}

Image formats ​

By default, modern image formats (webp, avif) are referenced in the generated <source> tags. You can tweak that using the formats argument:

gjs
import { ResponsiveImage } from '@responsive-image/ember';
import { netlify } from '@responsive-image/cdn';

<template>
  <ResponsiveImage
    @src={{netlify
      '/path/to/image.jpg'
      formats=(array 'webp' 'avif')
    }}
  />
</template>
hbs
<ResponsiveImage
  @src={{responsive-image-netlify
    '/path/to/image.jpg'
    formats=(array 'webp' 'avif')
  }}
/>
ts
import { LitElement, html } from 'lit';
import { customElement } from 'lit/decorators.js';
import { netlify } from '@responsive-image/cdn';
import '@responsive-image/wc';

@customElement('my-app')
export class MyApp extends LitElement {
  render() {
    return html`<responsive-image
      .src=${netlify('/path/to/image.jpg', {
        formats: ['webp', 'avif'],
      })}
    ></responsive-image>`;
  }
}
tsx
import { ResponsiveImage } from '@responsive-image/solid';
import { netlify } from '@responsive-image/cdn';

export default function MyApp() {
  return (
    <ResponsiveImage
      src={netlify('path/to/uploaded/image.jpg', {
        formats: ['webp', 'avif'],
      })}
    />
  );
}

Remote source ​

The provider supports Netlify's remote path mode to automatically fetch images from a remote source and deliver them through Netlify's CDN. Simply pass a fully qualified http(s) URL:

gjs
import { ResponsiveImage } from '@responsive-image/ember';
import { netlify } from '@responsive-image/cdn';

<template>
  <ResponsiveImage
    @src={{netlify
      'https://upload.wikimedia.org/wikipedia/commons/1/13/Benedict_Cumberbatch_2011.png'
    }}
  />
</template>
hbs
<ResponsiveImage
  @src={{responsive-image-netlify
    'https://upload.wikimedia.org/wikipedia/commons/1/13/Benedict_Cumberbatch_2011.png'
  }}
/>
ts
import { LitElement, html } from 'lit';
import { customElement } from 'lit/decorators.js';
import { netlify } from '@responsive-image/cdn';
import '@responsive-image/wc';

@customElement('my-app')
export class MyApp extends LitElement {
  render() {
    return html`<responsive-image
      .src=${netlify(
        'https://upload.wikimedia.org/wikipedia/commons/1/13/Benedict_Cumberbatch_2011.png',
      )}
    ></responsive-image>`;
  }
}
tsx
import { ResponsiveImage } from '@responsive-image/solid';
import { netlify } from '@responsive-image/cdn';

export default function MyApp() {
  return (
    <ResponsiveImage
      src={netlify(
        'https://upload.wikimedia.org/wikipedia/commons/1/13/Benedict_Cumberbatch_2011.png',
      )}
    />
  );
}

Made with ❤︎ for OSS - Support 🇺🇦

Copyright © 2024 Simon Ihmig