> For the complete documentation index, see [llms.txt](https://docs.sharinpix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sharinpix.com/documentation/lightning-web-component/sharinpix-album.md).

# SharinPix Album

The **SharinPix Album** component permits the user to manage images. Using this component, you can upload, delete, display, download, edit, or even tag an image.

There are many more features provided by SharinPix Album. You will find links to some useful articles detailing these features at the end of this article.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-05693dfb8b7ab3219c3381c1e01565a2f5fa5c01%2Fscreenshot-sharinpix.screenstepslive.com-2020.05.12-12_47_12%20\(1\)%20\(1\).png?alt=media)

{% hint style="info" %}
**Information:**

This feature is only available on Lightning. It can be used:

* On Community Builder
* On Page Builder
* On Desktop
* On Mobile
* In Flows (but not in Field Service Mobile Flow)
* In your own Lightning Component development
  {% endhint %}

## Getting Started

To use the SharinPix Album component, you simply need to drag and drop the component from the Lightning App Builder onto your page layout.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-290fad144b7c3f0f9e91aa84314961c90fa4b9e3%2F1%20\(5\)%20\(1\).png?alt=media)

## Lightning Component Parameters

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-5c3719c60a55a57c36a9622b36c06c35fb4947b9%2Fscreenshot-spoonconsulting37-dev-ed.develop.lightning.force.com-2023.08.30-22_37_30%20\(1\)%20\(1\).png?alt=media)

* **AlbumId:** Used to specify the album ID. If you want to use the record ID as the album ID, leave this field blank.
* **Height:** Used to specify the album's height. The default album height is **500** (px).
* **Use Fullscreen Image Viewer:** Used to enable/disable the option to view image in full screen.
* **Enable Action:** Used to enable/disable Tag Actio&#x6E;**. Note**: The Tag Action is enabled by default on the SharinPix Album (LWC). For more information on this feature and how to complete the Tag Action setup, refer to this article: [*Tag Action*](/documentation/features/working-with-tags/tag-action.md)​
* **Enable Image Sync:** Used to enable/disable Image Sync. **Note:** Image Sync is checked by default on the SharinPix Album (LWC). Additional steps are required to get this feature fully working on your Salesforce object. Please refer to this article to complete the Image Sync setup: [*Setup SharinPix Image Sync*](/documentation/image-sync/setup-sharinpix-image-sync.md)​
* **Enable Toast:** Used to enable/disable toast message upon successful image upload.
* **Custom Permission Id or Name:** Used to specify the Id or Name of a custom permission.
* **Available Tags:** Used to specify a list of tag names delimited by a semi-colon. Example: TagA;TagB;TagC;
* **Auto Tags:** Used to specify a list of tags delimited by a semi-colon to apply to every image uploaded. Example: TagA;TagB;TagC;
* **Component ID:** Used to specify the component Id's to be matched by add-on components on a page.

## Demo

The picture below depicts a SharinPix Album component with uploaded images:

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-e73583554ba85e53a259f71a5dc002dcef8af446%2Fscreenshot-sharinpix-fsl-demo-dev-ed.lightning.force.com-2020.05.12-14_45_11%20\(1\)%20\(1\).png?alt=media)

The picture below shows the fullscreen view upon clicking on an image in the SharinPix album:

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-aec29dc406ff44fd9ca163120aacd140f341a7a4%2Fscreenshot-sharinpix-fsl-demo-dev-ed.lightning.force.com-2020.05.12-14_47_25%20\(1\)%20\(1\).png?alt=media)

{% hint style="success" %}
**Tips:**

Below are some useful links about the SharinPix Album component's features that you may refer to:

* [Use the SharinPix Album component on a Record Page.](/documentation/features/main-integration/using-on-a-lightning-record-page.md)
* [Use SharinPix Album component on the Lightning Home Page.](/documentation/features/main-integration/using-on-the-lightning-home-page.md)
* [Use SharinPix Album component in Salesforce Community.](/documentation/features/main-integration/using-sharinpix-in-salesforce-community.md)
* [Use SharinPix Album component in an Lightning Action.](/documentation/features/main-integration/using-on-lightning-with-sharinpix-album-lightning-action.md)
* [The SharinPix Album's menu commands.](http://docs.sharinpix.com/m/documentation/c/250114)
* [The SharinPix Album's user interface.](http://docs.sharinpix.com/m/documentation/c/244122)
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sharinpix.com/documentation/lightning-web-component/sharinpix-album.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
