# @scaleflex/widget-instagram

[![Plugins][plugins-image]](#plugins)
[![Website][filerobot-image]][sfx-url]
[![Version][filerobot-version]][version-url]
[![Scaleflex team][made-by-image]][sfx-url]
[![License][license-image]][license-url]
[![CodeSandbox][codeSandbox-image]][codeSandbox-url]


<div align='center'>
<img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" width="140"/>
</div>

The Instagram [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core) lets users import photos from their Instagram account.

## Usage

### NPM

```bash
npm install --save @scaleflex/widget-instagram
```
### YARN

```bash
yarn add @scaleflex/widget-instagram
```

then

```js
import Instagram from '@scaleflex/widget-instagram'
...
...
...
scaleflexWidget.use(Instagram, propertiesObject)
```

### CDN

The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Instagram`

```js
const Instagram = window.ScaleflexWidget.Instagram
...
...
...
scaleflexWidget.use(Instagram, propertiesObject)
```

## Properties

### `title`

<u>Type:</u> `string`

<u>Default:</u> `'Instagram'`

The title/label that would be shown & used for the plugin.

### `companionHeaders`

<u>Type:</u> `null` | `object`

<u>Default:</u> `null`

If you need to pass additional headers for in companion requests then pass them in this property.

<!-- Variables -->

[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-instagram
[license-url]: https://opensource.org/licenses/MIT
[sfx-url]: https://www.scaleflex.com/
[version-url]: https://www.npmjs.com/package/@scaleflex/widget-instagram
[codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js

[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
[made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-instagram?label=Version&style=for-the-badge&logo=npm