Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 4.07 KB

README.md

File metadata and controls

99 lines (71 loc) · 4.07 KB

Kontent.ai logo for dark/light scheme. commercetools logo

Features • Demo • Deploy • Configuration • Saved value • Contributors • License • Resources

This custom element extension for Kontent.ai allows users to link selected assets from their filerobot asset library into their structured content.

Features

  • Editors can
    • Show file assets in their Filerobot project
    • Link selected assets with their content items with preview directly inside of the Kontent.ai editor

Demo

Request to Us Demo

Getting started

Running manually

The integration is created with Create Vite App. First you will need to install npm dependencies with npm install. Then use npm run build to build the integration or npm run start to start a local development server. See https://vitejs.dev/guide/ for more scripts.

Filerobot configuration

You don't need to do anything special inside of your Filerobot account in order to access the data through the custom element. Instead, you'll be prompted to login into your Filerobot account to access your asset library (like seen in the demo animation above).

This element has been created by simply adding the official Compact View by Filerobot. You can learn more about this integration component in its official documentation on filerobot's website.

⚠ WARNING: You have to have a Filerobot account/credentials in order to use this extension

Configuring the Custom Element

You will need to add the custom element to a content type filling in the hosted code URL and the following JSON parameters:

{
    "token": "your_token",
    "secTemplate": "your_security_template",
    "dir": "your_base_directory"
}

What is Saved

The custom element saves a list of asset objects that has been included into the content item through the element. Example output:

[
    {
    "value": "[{\"file\":{\"uuid\":\"5452c2a9-7552-568c-9434-26d30ed50000\",\"url\":{\"cdn\":\"https://famamqedb.filerobot.com/Samples/Athletics.jpg?vh=3e462d\"}}},{\"file\":{\"uuid\":\"f19c7144-ca90-5c03-a7bb-d1573f250000\",\"url\":{\"cdn\":\"https://famamqedb.filerobot.com/Samples/racing-car.jpeg?vh=4df011\"}}}]",
    "searchableValue": null,
    "elementId": "5a8b014e-5f5d-4f3d-a8db-3c4c60faff72",
    "name": "Untitled custom element",
    "type": "CONTENTELEMENT_CUSTOM",
    "lastModifiedBy": "64e1c4fa1d338e5346a52b49",
    "lastModifiedAt": "2023-09-27T04:39:58.2474293Z"
    }
],

Contributors

We have collected notes on how to contribute to this project in CONTRIBUTING.md.

License

MIT

Additional Resources