npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

toast-ui-csp-vue-editor

v3.3.6

Published

TOAST UI Editor for Vue

Downloads

1,573

Readme

TOAST UI Editor for Vue

This is Vue component wrapping TOAST UI Editor.

npm version

🚩 Table of Contents

Collect Statistics on the Use of Open Source

Vue Wrapper of TOAST UI Editor applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Editor is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. ui.toast.com) is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the following usageStatistics options when declare Vue Wrapper component.

const options = {
  ...
  usageStatistics: false
}

💾 Install

Using npm

npm install --save @toast-ui/vue-editor

📝 Editor Usage

Import

You can use Toast UI Editor for Vue as a ECMAScript module or a CommonJS module. As this module does not contain CSS files, you should import toastui-editor.css from @toast-ui/editor in the script.

  • ES Modules
import '@toast-ui/editor/dist/toastui-editor.css';

import { Editor } from '@toast-ui/vue-editor';
  • CommonJS
require('@toast-ui/editor/dist/toastui-editor.css');

const { Editor } = require('@toast-ui/vue-editor');

Creating Component

First implement <editor/> in the template.

<template>
  <editor />
</template>

And then add Editor to the components in your component or Vue instance like this:

import '@toast-ui/editor/dist/toastui-editor.css';

import { Editor } from '@toast-ui/vue-editor';

export default {
  components: {
    editor: Editor
  }
};

or

import '@toast-ui/editor/dist/toastui-editor.css';

import { Editor } from '@toast-ui/vue-editor';

new Vue({
  el: '#app',
  components: {
    editor: Editor
  }
});

Props

| Name | Type | Default | Description | | --------------- | ------ | -------------------------- | --------------------------------------------------------- | | initialValue | String | '' | Editor's initial value . | | initialEditType | String | 'markdown' | Initial editor type (markdown, wysiwyg). | | options | Object | following defaultOptions | Options of tui.editor. This is for initailize tui.editor. | | height | String | '300px' | This prop can control the height of the editor. | | previewStyle | String | 'vertical' | Markdown editor's preview style (tab, vertical). |

const defaultOptions = {
  minHeight: '200px',
  language: 'en-US',
  useCommandShortcut: true,
  usageStatistics: true,
  hideModeSwitch: false,
  toolbarItems: [
    ['heading', 'bold', 'italic', 'strike'],
    ['hr', 'quote'],
    ['ul', 'ol', 'task', 'indent', 'outdent'],
    ['table', 'image', 'link'],
    ['code', 'codeblock'],
    ['scrollSync'],
  ]
};
<template>
  <editor
    :initialValue="editorText"
    :options="editorOptions"
    height="500px"
    initialEditType="wysiwyg"
    previewStyle="vertical"
  />
</template>
<script>
  import '@toast-ui/editor/dist/toastui-editor.css';

  import { Editor } from '@toast-ui/vue-editor';

  export default {
    components: {
      editor: Editor
    },
    data() {
      return {
        editorText: 'This is initialValue.',
        editorOptions: {
          hideModeSwitch: true
        }
      };
    }
  };
</script>

Instance Methods

If you want to more manipulate the Editor, you can use invoke method to call the method of toastui.editor. For more information of method, see instance methods of TOAST UI Editor.

First, you need to assign ref attribute of <editor/> and then you can use invoke method through this.$refs like this:

<template>
  <editor ref="toastuiEditor" />
</template>
<script>
  import '@toast-ui/editor/dist/toastui-editor.css';

  import { Editor } from '@toast-ui/vue-editor';

  export default {
    components: {
      editor: Editor
    },
    methods: {
      scroll() {
        this.$refs.toastuiEditor.invoke('setScrollTop', 10);
      },
      moveTop() {
        this.$refs.toastuiEditor.invoke('moveCursorToStart');
      },
      getHTML() {
        let html = this.$refs.toastuiEditor.invoke('getHTML');
      }
    }
  };
</script>

Events

  • load : It would be emitted when editor fully load
  • change : It would be emitted when content changed
  • caretChange : It would be emitted when format change by cursor position
  • focus : It would be emitted when editor get focus
  • blur : It would be emitted when editor loose focus
<template>
  <editor
    @load="onEditorLoad"
    @focus="onEditorFocus"
    @blur="onEditorBlur"
    @change="onEditorChange"
    @caretChange="onEditorCaretChange"
  />
</template>
<script>
  import { Editor } from '@toast-ui/vue-editor';

  export default {
    components: {
      editor: Editor
    },
    methods: {
      onEditorLoad() {
        // implement your code
      },
      onEditorFocus() {
        // implement your code
      },
      onEditorBlur() {
        // implement your code
      },
      onEditorChange() {
        // implement your code
      },
      onEditorCaretChange() {
        // implement your code
      }
    }
  };
</script>

📃 Viewer Usage

Import

  • ES Modules
import '@toast-ui/editor/dist/toastui-editor-viewer.css';

import { Viewer } from '@toast-ui/vue-editor';
  • CommonJS
require('@toast-ui/editor/dist/toastui-editor-viewer.css');

const { Viewer } = require('@toast-ui/vue-editor');

Creating Component

First implement <viewer /> in the template.

<template>
  <viewer />
</template>

And then add Viewer to the components in your component or Vue instance like this:

import '@toast-ui/editor/dist/toastui-editor-viewer.css';

import { Viewer } from '@toast-ui/vue-editor';

export default {
  components: {
    viewer: Viewer
  }
};

or

import '@toast-ui/editor/dist/toastui-editor-viewer.css';

import { Viewer } from '@toast-ui/vue-editor';

new Vue({
  el: '#app',
  components: {
    viewer: Viewer
  }
});

Props

| Name | Type | Default | Description | | ------------ | ------ | ------- | ----------------------------------------------- | | initialValue | String | '' | Viewer's initial value | | height | String | '300px' | This prop can control the height of the viewer. | | options | Object | above defaultOptions | Options of tui.editor. This is for initailize tui.editor. |

<template>
  <viewer :initialValue="viewerText" height="500px" />
</template>
<script>
  import '@toast-ui/editor/dist/toastui-editor-viewer.css';

  import { Viewer } from '@toast-ui/vue-editor';

  export default {
    components: {
      viewer: Viewer
    },
    data() {
      return {
        viewerText: '# This is Viewer.\n Hello World.'
      };
    }
  };
</script>