GM - File Explorer

(gmpkg:fileExplorerLWC)

Documentation

GM - File Explorer component is used to display the list of files related to a specific record ,It has the flexibility to change the display format according to the preference, such as Table, Tree, Gallery, or Carousel. Additionally, it has the ability to perform various actions on the files, including downloading and deleting them. This allows to manage and organize the attached files conveniently within the system.

Use case: Display the related files to an account.

Specification

Property	Type	Description
Record Id	String	recordId to use. Keep this empty if you want to use the current record.
Custom Label	String	Set the custom label. Keep it empty to use the default value.
Default View	String	Set the default view (table|tree|gallery|carousel).
Enable Delete	Boolean	Check this option if you wish to allow the end-user to delete files.
Enable Hard Delete	Boolean	Check this option if you want to hard delete files
Enable Copy/Paste	Boolean	Check this option if you wish to allow the end-user to copy/paste files from a record to another one.
Enable Search By Topics	Boolean	Check this option if you wish to enable the search by Topic.
Enable Update Topics	Boolean	Check this option if you wish to enable Topics update. This option is available only in the carousel view.
Collapse Carousel Split View	Boolean	Check this option if you want to collapse the carousel split view.
Show Border	Boolean	Check this option if you want to show border.
Filter	String	JSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid
Accepted Formats	String	Comma-separated list of file extensions that can be uploaded in the format .ext, such as .pdf,.jpg,.png.
Content Library	String	Content Library Name. The library is optional. This property supports using an expression to define its custom label.
Folder Name	String	Upload Folder Name. The folder name is optional. This property supports using an expression to define its custom label.
Actions	String	JSON string to initialize the list of available mass actions.
Hide Topics	Boolean	Check this option if you want to hide topics
Content Library	String	Content Library Name. The library is optional. When enabled, this option filters files to display only those within a specified library. Uploaded files will also be moved to that library. This feature is useful for organizing files by business unit, for example contracting, finance, hr...
Folder Name	String	Upload Folder Name. If a folder name is specified, uploaded files will be moved to that folder. Otherwise, this step is optional.

API Reference

fileExplorerLWC.js-meta.xml

<?xml version="1.0" encoding="UTF-8" ?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>64.0</apiVersion>
    <isExposed>true</isExposed>
    <masterLabel>GM - File Explorer</masterLabel>
    <description>GM - File Explorer</description>
    <targets>
        <target>lightning__RecordPage</target>
        <target>lightning__AppPage</target>
        <target>lightning__HomePage</target>
        <target>lightningCommunity__Page</target>
        <target>lightningCommunity__Default</target>
    </targets>
    <targetConfigs>
        <targetConfig targets="lightning__RecordPage,lightning__AppPage,lightning__HomePage">
            <property
                name="recordId"
                type="String"
                label="recordId"
                description="recordId to use. Keep this empty if you want to use the current record"
            />

            <property
                name="customLabel"
                type="String"
                label="Custom Label"
                description="Set the custom label. Keep it empty to use the default value"
            />

            <property
                name="defaultView"
                type="String"
                label="Default View"
                description="Set the default view (table|tree|gallery|carousel)"
            />

            <property
                name="canDelete"
                type="Boolean"
                label="Enable Delete"
                description="Check this option if you want to delete links"
            />

            <property
                name="canHardDelete"
                type="Boolean"
                label="Enable Hard Delete"
                description="Check this option if you want to hard delete files"
            />

            <property
                name="canCopyPaste"
                type="Boolean"
                label="Enable Copy/Paste"
                description="Check this option if you want to copy/paste"
            />

            <property
                name="hideTopics"
                type="Boolean"
                label="Hide Topics"
                description="Check this option if you want to hide topics"
            />

            <property
                name="canSearchByTopics"
                type="Boolean"
                label="Enable Search By Topics"
                description="Check this option if you want to search by topics"
            />

            <property
                name="canUpdateTopics"
                type="Boolean"
                label="Enable Update Topics"
                description="Check this option if you want to update topics"
            />

            <property
                name="collapseSplitView"
                type="Boolean"
                label="Collapse Carousel Split View"
                description="Check this option if you want to collapse the carousel split view"
            />

            <property
                name="showBorder"
                type="Boolean"
                label="Show Border"
                description="Check this option if you want to show Border."
            />

            <property
                name="jsonFilter"
                type="String"
                label="Filter"
                description="Json string to define filter criteria"
            />

            <property
                name="accept"
                type="String"
                label="Accepted Formats"
                description="Comma-separated list of file extensions that can be uploaded in the format .ext, such as .pdf,.jpg,.png"
            />

            <property
                name="library"
                type="String"
                label="Content Library"
                description="Content Library Name. The library is optional."
            />

            <property
                name="folder"
                type="String"
                label="Folder Name"
                description="Upload Folder Name. The folder name is optional."
            />

            <property
                name="jsonActions"
                type="String"
                label="Actions"
                description="Json string to initialize the list of available actions like Add file from S3"
            />
            <supportedFormFactors>
                <supportedFormFactor type="Large" />
                <supportedFormFactor type="Small" />
            </supportedFormFactors>
        </targetConfig>
        <targetConfig targets="lightningCommunity__Default">
            <property
                name="recordId"
                type="String"
                label="recordId"
                description="recordId to use. Keep this empty if you want to use the current record"
            />

            <property
                name="customLabel"
                type="String"
                label="Custom Label"
                description="Set the custom label. Keep it empty to use the default value"
            />

            <property
                name="defaultView"
                type="String"
                label="Default View"
                description="Set the default view (table|tree|gallery|carousel)"
            />

            <property
                name="canDelete"
                type="Boolean"
                label="Enable Delete"
                description="Check this option if you want to delete"
            />

            <property
                name="canCopyPaste"
                type="Boolean"
                label="Enable Copy/Paste"
                description="Check this option if you want to copy/paste"
            />

            <property
                name="hideTopics"
                type="Boolean"
                label="Hide Topics"
                description="Check this option if you want to hide topics"
            />

            <property
                name="canSearchByTopics"
                type="Boolean"
                label="Enable Search By Topics"
                description="Check this option if you want to search by topics"
            />

            <property
                name="canUpdateTopics"
                type="Boolean"
                label="Enable Update Topics"
                description="Check this option if you want to update topics"
            />

            <property
                name="collapseSplitView"
                type="Boolean"
                label="Collapse Carousel Split View"
                description="Check this option if you want to collapse the carousel split view"
            />

            <property
                name="showBorder"
                type="Boolean"
                label="Show Border"
                description="Check this option if you want to show Border."
            />

            <property
                name="jsonFilter"
                type="String"
                label="Filter"
                description="Json string to define filter criteria"
            />

            <property
                name="accept"
                type="String"
                label="Accepted Formats"
                description="Comma-separated list of file extensions that can be uploaded in the format .ext, such as .pdf,.jpg,.png"
            />

            <property
                name="library"
                type="String"
                label="Content Library"
                description="Content Library Name. The library is optional."
            />

            <property
                name="folder"
                type="String"
                label="Folder Name"
                description="Upload Folder Name. The folder name is optional."
            />

            <property
                name="jsonActions"
                type="String"
                label="Actions"
                description="Json string to initialize the list of available actions like Add file from S3"
            />
        </targetConfig>
    </targetConfigs>
</LightningComponentBundle>