marsidev / sb-field-plugin-with-custom-content

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

yarn dev

and open the Sandbox.

To build the project, run

yarn 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

yarn deploy

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:

yarn 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.