> 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-form.md).
# SharinPix Form
## Overview
The **SharinPix Form** component allows users to access and fill out pre-built SharinPix Form Templates (created using the [Form Template Editor](/documentation/sharinpix-form/sharinpix-form-template-editor.md)) directly inside Salesforce.
{% 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 %}
{% hint style="warning" %}
**Prerequisites**
* **Permissions:**\
Users must have the SharinPix Forms Admin or SharinPix Forms User permission set assigned. For more information on these two permission sets, check [*SharinPix Permission Sets*](/documentation/access-and-security/sharinpix-permission-sets.md)*.*
* **Package Version:**\
Ensure that the latest SharinPix Package Version is installed.
* **Form Template**\
A form template must be created beforehand using the [*SharinPix Form Template Editor.*](/documentation/sharinpix-form/sharinpix-form-template-editor.md)
{% endhint %}
## Getting Started
To use the **SharinPix Form** component, you simply need to drag and drop the component from the Lightning App Builder onto your page layout.
## Lightning Web Component Parameters
| Parameter | Description | Default/Notes |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| Main Form Template Name | Specifies the Main Form Template to launch. Enter the Main Form Template name directly, or enclose in braces the API name of a record field that contains it (for example, {Inspection\_Template\_\_c}). The template must exist in the [SharinPix Form Template Editor](https://docs.sharinpix.com/documentation/sharinpix-form/sharinpix-form-template-editor). | Must match an existing Main Form Template name. The component always opens the active version. |
| Name Field API Name | Specifies the job name when displaying the Form in the **SharinPix Form** component. You can use any other fields in the record from which the component is being placed. | Default value: *Record name* |
| Custom Paramters | Used to specify additional user-defined parameters to be appended to the SharinPix Form. Example "userId=005Ec00000MAzP2MAI". | Default value: *None* |
| Height | Used to specify the component's height. | Default value: *500* |
## Demo and Behavior
#### Example - Salesforce Record Page
The image below shows the **SharinPix Form** component in a Salesforce record page.
The user can fill out the form and submit it as well. After submitting the form, a screen will appear with a message, "*Your form has been submitted."* and two buttons, as shown in the image below:
| Button | Description |
| ----------------------- | ---------------------------------------------------------------------------------------- |
| Review Submission | When clicked, the submitted form response record page will open in a new tab. |
| Submit Another Response | When clicked, the component will refresh and allow the user to fill a new form response. |
---
# 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-form.md?ask=&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.
