npm package: @scaleflex/widget-pixaforge
Description: Import free images & icons from Pixaforge that has free gallery for both.
Latest version: 4.8.13

# @scaleflex/widget-pixaforge

[![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>

Import free images & icons from Pixaforge in [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core) that has free gallery for both.

## Usage

### NPM

```bash
npm install --save @scaleflex/widget-pixaforge
```
### YARN

```bash
yarn add @scaleflex/widget-pixaforge
```

then

```js
import Pixaforge from '@scaleflex/widget-pixaforge'
...
...
...
scaleflexWidget.use(Pixaforge, propertiesObject)
```

### CDN

The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Pixaforge`

```js
const Pixaforge = window.ScaleflexWidget.Pixaforge
...
...
...
scaleflexWidget.use(Pixaforge, propertiesObject)
```

## Plugin's styles

```js
import '@scaleflex/widget-core/dist/style.css'
import '@scaleflex/widget-pixaforge/dist/style.css'
```

or if you prefer the minified version

```js
import '@scaleflex/widget-core/dist/style.min.css'
import '@scaleflex/widget-pixaforge/dist/style.min.css'
```

> The plugin's css file should be imported after the [Core's css file](../@scaleflex/widget-core/#modules-styles) for having the styles shown correctly.

## Properties

### `title`

<u>Type:</u> `string`

<u>Default:</u> `'Pixaforge'`

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(used in importing the images from pixaforge).

### `locale: object`

<u>Type:</u> `object`

<u>Default:</u> locales from scaleflexWidget's backend then default locale file with all labels is under `lib/defaultLocale.js`.

You can override some labels by specifying a translation object here, such as:

```js
{
  strings: {
    standardPortraits: 'Standard verticals' // overrides the default Standard portraits value to standard verticals
  }
}
```

### `noIconsGallery`

<u>Type:</u> `boolean`

<u>Default:</u> `false`

If used the icons gallery option will be removed from the plugin and only images will be available.

<!-- Variables -->

[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-pixaforge
[license-url]: https://opensource.org/licenses/MIT
[sfx-url]: https://www.scaleflex.com/
[version-url]: https://www.npmjs.com/package/@scaleflex/widget-pixaforge
[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-pixaforge?label=Version&style=for-the-badge&logo=npm
[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox