Storyblok Vue 3 Field Plugin

This project was created using Vue 3 and Typescript. It consists of a set of base functionalities, such as value updating, modal toggling and asset selection. This starter is intended to help developers when creating their own Storyblok Field Plugin.

Composition API vs Options API

You can choose either option. This template is written using the Composition API, and you can view the implementation in the src/useFieldPlugin.ts file.

If you prefer to use the Options API, you can refer to the Vue 2 template.

Usage

For development, run the application locally with

npm run dev

and open the Sandbox.

To build the project, run

npm run build

Deploy the field plugin with the CLI. Issue a personal access token, rename .env.local.example to .env.example, open the file, set the value STORYBLOK_PERSONAL_ACCESS_TOKEN, and run

npm run deploy

Manifest File for Field Plugins

The manifest file is a configuration that enhances the functionality of your field plugin. This JSON file, named field-plugin.config.json and located in your project's root folder, is optional but highly recommended.

The manifest file allows you to configure options for your field plugin. When developing your field plugin with the Sandbox, the options are applied by default. Also, the deploy command automatically applies the options in production. So, you no longer need to configure the options manually.

Configuring a Manifest File

The options list within the file field-plugin.config.json should consist of key-value objects representing the essential options required for your field plugin to function correctly, along with their corresponding values. This is an example of how it should be structured:

{
  "options": [
    {
      "name": "myPluginInitialValue",
      "value": 100
    }
  ]
}

Now, you just need to access these options in your code like in the example below:

const { type, data, actions } = useFieldPlugin()

console.log(data.options.myPluginInitialValue)

Next Steps

Read more about field plugins on GitHub.

Set up continuous integration with the CLI. Define an environmental variable STORYBLOK_PERSONAL_ACCESS_TOKEN, and use the --name and --skipPrompts options as such:

npm run deploy --name $NAME --skipPrompts

@storyblok/design-system is Storyblok's component library for Vue. To add it to this project, follow the instructions in the readme.

Clean up the boilerplate

To start from a blank state, replace the example component <FieldPluginExample /> from src/App.vue with <FieldPlugin />.

Continuous delivery

Set up continuous delivery with the CLI. Define an environmental variable STORYBLOK_PERSONAL_ACCESS_TOKEN, and use the --name and --skipPrompts options as such:

npm run deploy --name $NAME --skipPrompts

Design system

We created our blok.ink design system to allow our customers to build great integrated experiences while maintaining Storyblok's overall design.