Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@storyblok/vue

Package Overview
Dependencies
Maintainers
5
Versions
68
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storyblok/vue

Storyblok directive for get editable elements.

  • 2.1.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
17K
increased by3.93%
Maintainers
5
Weekly downloads
 
Created
Source
Storyblok Logo

@storyblok/vue

Vue plugin to make any Storyblok component editable with a simple v-editable directive.


Storyblok JS Client npm

Follow @Storyblok Follow @Storyblok

Note: This plugin is for Vue 2. Check out the @next version for Vue 3

🚀 Usage

If you are first-time user of the Storyblok, read the Getting Started guide to get a project ready in less than 5 minutes.

Installation

Install @storyblok/vue:

npm install --save-dev @storyblok/vue
// yarn add -D @storyblok/vue

Register it globally on your application (usually in main.js):

import Vue from "vue";
import StoryblokVue from "@storyblok/vue";

Vue.use(StoryblokVue);
From a CDN

Install the file from the CDN:

<script src="https://unpkg.com/@storyblok/vue"></script>

That's it, the plugin is auto-registered for you 😉.

Getting Started

For every component you've defined in your Storyblok space, add the v-editable directive with the blok content:

<template>
  <div v-editable="blok"><!-- ... --></div>
</template>

Where blok is the actual blok data coming from Storblok's Content Delivery API.

Check out the playground for a full example.

Compatibility

This plugin is for Vue 2. Thus, it supports the same browsers as Vue 2.

ℹ️ More Resources

Support

Contributing

Please see our contributing guidelines and our code of conduct. This project use semantic-release for generate new versions by using commit messages and we use the Angular Convention to naming the commits. Check this question about it in semantic-release FAQ.

License

This repository is published under the MIT license.

Keywords

FAQs

Package last updated on 25 Jan 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc