uppy/docs/sources/companion-plugins/unsplash.mdx

---
slug: /unsplash
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

import UppyCdnExample from '/src/components/UppyCdnExample';

# Unsplash

The `@uppy/unsplash` plugin lets users import files from their
[Unsplash](https://unsplash.com) account.

:::tip

[Try out the live example](/examples) or take it for a spin in
[StackBlitz](https://stackblitz.com/edit/vitejs-vite-zaqyaf?file=main.js).

:::

## When should I use this?

When you want to let users import files from their
[Unsplash](https://unsplash.com) account.

A [Companion](/docs/companion) instance is required for the Unsplash plugin to
work. Companion handles authentication with Unsplash, downloads the files, and
uploads them to the destination. This saves the user bandwidth, especially
helpful if they are on a mobile connection.

You can self-host Companion or get a hosted version with any
[Transloadit plan](https://transloadit.com/pricing/).

<Tabs>
  <TabItem value="npm" label="NPM" default>

```shell
npm install @uppy/unsplash
```

  </TabItem>

  <TabItem value="yarn" label="Yarn">

```shell
yarn add @uppy/unsplash
```

  </TabItem>

  <TabItem value="cdn" label="CDN">
    <UppyCdnExample>
      {`
        import { Uppy, Unsplash } from "{{UPPY_JS_URL}}"
        const uppy = new Uppy()
        uppy.use(Unsplash, {
          // Options
        })
      `}
    </UppyCdnExample>
  </TabItem>
</Tabs>

## Use

Using Unsplash requires setup in both Uppy and Companion.

### Use in Uppy

```js {10-13} showLineNumbers
import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import Unsplash from '@uppy/unsplash';

import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';

new Uppy()
	.use(Dashboard, { inline: true, target: '#dashboard' })
	.use(Unsplash, {
		target: Dashboard,
		companionUrl: 'https://your-companion.com',
	});
```

### Use in Companion

You can create a Unsplash App on the
[Unsplash Developers site](https://unsplash.com/developers). You’ll be
redirected to the app page, this page lists the app key and app secret.

Configure the Unsplash key and secret. With the standalone Companion server,
specify environment variables:

```shell
export COMPANION_UNSPLASH_KEY="Unsplash API key"
export COMPANION_UNSPLASH_SECRET="Unsplash API secret"
```

When using the Companion Node.js API, configure these options:

```js
companion.app({
	providerOptions: {
		unsplash: {
			key: 'Unsplash API key',
			secret: 'Unsplash API secret',
		},
	},
});
```

## API

### Options

#### `id`

A unique identifier for this plugin (`string`, default: `'Unsplash'`).

#### `title`

Title / name shown in the UI, such as Dashboard tabs (`string`, default:
`'Unsplash'`).

#### `target`

DOM element, CSS selector, or plugin to place the drag and drop area into
(`string` or `Element`, default: `null`).

#### `companionUrl`

URL to a [Companion](/docs/companion) instance (`string`, default: `null`).

#### `companionHeaders`

Custom headers that should be sent along to [Companion](/docs/companion) on
every request (`Object`, default: `{}`).

#### `companionAllowedHosts`

The valid and authorised URL(s) from which OAuth responses should be accepted
(`string` or `RegExp` or `Array`, default: `companionUrl`).

This value can be a `string`, a `RegExp` pattern, or an `Array` of both. This is
useful when you have your [Companion](/docs/companion) running on several hosts.
Otherwise, the default value should do fine.

#### `companionCookiesRule`

This option correlates to the
[RequestCredentials value](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials)
(`string`, default: `'same-origin'`).

This tells the plugin whether to send cookies to [Companion](/docs/companion).

#### `locale`

```js
export default {
	strings: {
		pluginNameUnsplash: 'Unsplash',
	},
};
```