# Solid

> Add image zoom to Solid and SolidStart with a small component that attaches medium-zoom on mount and detaches it on unmount.

Source: <https://medium-zoom.francoischalifour.com/docs/integrations/solid/>

medium-zoom works with Solid out of the box. Wrap it in a small component, then use it like an `<img>`.

## Install the package

```sh
npm install medium-zoom
```

The standard import includes zoom styles and TypeScript definitions.

## Create the component

Attach the zoom once the image is in the document, and detach it when the component is disposed:

```solid
import mediumZoom, { type ZoomOptions } from 'medium-zoom'
import { onCleanup, onMount, splitProps, type JSX } from 'solid-js'

type ZoomableImageProps = JSX.ImgHTMLAttributes<HTMLImageElement> & {
  options?: ZoomOptions
}

export function ZoomableImage(props: ZoomableImageProps) {
  const [local, image] = splitProps(props, ['options'])
  let element!: HTMLImageElement

  onMount(() => {
    const zoom = mediumZoom(element, local.options)
    onCleanup(() => zoom.detach())
  })

  return <img ref={element} {...image} />
}
```

Save it as `ZoomableImage.tsx`. The component passes attributes such as `src`, `alt`, `width`, and `height` to the image.

## Display an image

Import the component and give it the image attributes:

```solid
import { ZoomableImage } from './ZoomableImage'

export function App() {
  return (
    <ZoomableImage
      src="/assets/images/ocean-sunset.jpg"
      alt="Ocean sunset"
      width="1920"
      height="1280"
    />
  )
}
```

Click the image to enlarge it:

![Ocean sunset](https://medium-zoom.francoischalifour.com/assets/images/ocean-sunset.jpg)

Click the enlarged image or its background, press `Esc`, or scroll to close the zoom.

Width and height reserve space while the image loads. To keep the image responsive, follow the [image size step](https://medium-zoom.francoischalifour.com/docs/javascript/#set-the-image-size) of the JavaScript quickstart.

## Set options

Pass [options](https://medium-zoom.francoischalifour.com/docs/reference/javascript/options/) to change the margin, background, or scroll behavior:

```solid
<ZoomableImage
  src="/assets/images/ocean-sunset.jpg"
  alt="Ocean sunset"
  options={{ margin: 24, background: '#000000' }}
/>
```

The component reads its options when it mounts.

## Server rendering

`onMount()` runs only in the browser, so the component also works with SolidStart server rendering. The server outputs the plain image, and the zoom attaches after hydration.

## Next steps

- [HD images](https://medium-zoom.francoischalifour.com/docs/guides/hd-images/): Load a larger image when zooming.
- [Multiple images](https://medium-zoom.francoischalifour.com/docs/guides/multiple-images/): Attach zoom behavior to several images.
- [Styling](https://medium-zoom.francoischalifour.com/docs/guides/styling/): Set the layout, captions, and zoom background.
- [Options](https://medium-zoom.francoischalifour.com/docs/reference/javascript/options/): Set margins, backgrounds, scrolling, and custom layouts.
