Field-type Examples

⚠️ DEPRECATION NOTICE: Moved to monorepo ⚠️

This package has been moved to the new pluginsblok monorepo to the apps/field-plugins. For any new Issues or Pull Requests, go to the new repository and add the label field-types-examples.

A collection of field-types for Storyblok created by the community. Read more about creating field-types here

Table of Content

• Examples
• Example Repositories
• Contributing

Examples

Each example contains a README.md with an explanation about the field-type.

Example	Author
Folder Selection Select folders from the space using a dropdown	Chakit Arora
Annotated Image Simple Image Maps for tutorials	Christian Zoppi
Material Icon Selector Allows users to select any material icon	Riley MacIsaac
Star Rating A field-type to display a star rating	Lisi Linhart

Example Repositories

The following examples live in their own Github repository.

Example	Author
Hotspot Editor A Storyblok field-type to create hotspot images	cartok
Storyblok Meta Image A Storyblok field-type plugin which provides an image field with meta data	maoberlehner

Contributing

Have an example? Submit a PR or open an issue.We are happy to accept more examples from the community.

Adding an example in this repository

1. Create a new folder for your field-type

2. Add a README.md file in your example folder with a markdown table of the following format:

Name	Description	Author
Name of your field-type	Short description	Your Github

3. Make sure your contribution matches the linting setup for this repo:

Run the linting via

npm run lint

4. Regenerate the README.md with the following command

npm run docs

5. Open a new pull request with your example. ⚡️

Adding an example in a different repository

If you want to be listed in the Example Repositories, follow these steps:

1. Create a new entry with a name, description, and githubUrl in the community-examples.json file.

2. Regenerate the README.md with the following command

npm run docs

3. Open a new pull request with your example. ⚡️