Socket
Socket
Sign inDemoInstall

@blowstack/ckeditor-nuxt

Package Overview
Dependencies
2
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@blowstack/ckeditor-nuxt

CKEditor 5 editor for nuxt apps. The component includes all free available plugins (except CKFinder, instead simple upload adapter used)


Version published
Maintainers
1
Weekly downloads
344
decreased by-15.48%

Weekly downloads

Readme

Source

ckeditor-nuxt

CKEditor 5 editor for nuxt apps. The component includes all free available plugins (except CKFinder, instead simple upload adapter used)

Requirements

yarn add nuxt
npm i nuxt

Component integration

yarn add @blowstack/ckeditor-nuxt
npm install --save @blowstack/ckeditor-nuxt

List of included plugins

  • Alignment,
  • AutoImage,
  • Autoformat,
  • Autolink,
  • BlockQuote,
  • Bold,
  • CloudServices,
  • Code,
  • CodeBlock,
  • Essentials,
  • FontBackgroundColor,
  • FontColor,
  • FontFamily,
  • FontSize,
  • Heading,
  • Highlight,
  • HorizontalLine,
  • Image,
  • ImageCaption,
  • ImageInsert,
  • ImageResize,
  • ImageStyle,
  • ImageToolbar,
  • ImageUpload,
  • Indent,
  • IndentBlock,
  • Italic,
  • Link,
  • LinkImage,
  • List,
  • ListStyle,
  • MathType,
  • MediaEmbed,
  • MediaEmbedToolbar,
  • PageBreak,
  • Paragraph,
  • PasteFromOffice,
  • RemoveFormat,
  • SimpleUploadAdapter,
  • SpecialCharacters,
  • SpecialCharactersArrows,
  • SpecialCharactersCurrency,
  • SpecialCharactersEssentials,
  • SpecialCharactersLatin,
  • SpecialCharactersMathematical,
  • SpecialCharactersText,
  • Strikethrough,
  • Subscript,
  • Superscript,
  • Table,
  • TableCellProperties,
  • TableProperties,
  • TableToolbar,
  • TextTransformation,
  • Title,
  • TodoList,
  • Underline,
  • WordCount

Usage

<template>
  <client-only placeholder="loading...">
    <ckeditor-nuxt v-model="contentHolder" :config="editorConfig"  />
  </client-only>
</template>

<script>
export default {
  components: {
    'ckeditor-nuxt': () => { if (process.client) { return import('@blowstack/ckeditor-nuxt') } },
  },
  data() {
    return {
      editorConfig: {
        simpleUpload: {
          uploadUrl: 'path_to_image_controller',
          headers: {
            'Authorization': 'optional_token'
          }
        }
      },
      contentHolder: ""
    }
  }
}
</script>

Customization

To make customization use editorConfig object. It works the same way as the default ckeditor 5. More info at https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editorconfig-EditorConfig.html

For example if you want to disable Title plugin:


editorConfig: {
    removePlugins: ['Title'],
}

You can also change the behaviour of any plugin. For the Title plugin you can change for example the placeholder:


editorConfig: {
    title: {
        placeholder: 'h1'
    }
}

Keywords

FAQs

Last updated on 02 Apr 2021

Did you know?

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc