Field plugins are embedded into the Storyblok Visual Editor via iframes, allowing them to function as standalone applications within the editor environment. These plugins are hosted on Storyblok's infrastructure. The plugin code is compiled into a single JavaScript bundle by the developer and then uploaded to the Storyblok platform.
This particular field plugin is designed to interact with an external content platform to fetch a list of available content, including their IDs, titles, and thumbnail URLs. It's worth noting that these thumbnails are fetched directly from the platform by the user's browser.
- clone this repository
- Go to repo directory
cd storyblok-external-content - Select matching node version with
nvm useornvm install - Install dependencies with
npm ci
To implement authentication and format content appropriately, you're required to create a service. Use the provided Service as a foundational template for this purpose.
To publish service package use npm run publish:patch
For a brief overview of the necessary steps, refer to the list below. For comprehensive guidelines, please consult the Plugin Deployment documentation.
- Go to plugin directory
cd packages/plugin - Build plugin with
npm run build - Deploy plugin to Storyblok with
npm run deploy - Publish latest version from Storyblok UI
For a brief overview of the necessary steps, refer to the list below. For comprehensive guidelines, please consult the Plugin Setup documentation.
- Open block library in Storyblok
- Create new Block
- Add plugin field
- Set custom type as "external-content"
- Set serviceUrl option
For a brief overview of the necessary steps, refer to the list below. For comprehensive guidelines, please consult the Plugin Usage documentation.
- Insert block
- Select content from popup