Socket
Socket
Sign inDemoInstall

vue-code-highlighter

Package Overview
Dependencies
22
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    vue-code-highlighter

Vue component for highlighting code or syntax with modern style, copy functionality, multicode and powered by Highlight.js


Version published
Weekly downloads
119
increased by8.18%
Maintainers
1
Install size
5.06 MB
Created
Weekly downloads
 

Readme

Source

Vue Code Highlighter

NPM Downloads License

Vue component for highlighting code or syntax with modern style, copy functionality, multicode and powered by Highlight.js

Installation

npm install vue-code-highlighter highlight.js

// or use yarn
yarn add vue-code-highlighter highlight.js

Usage

Importing

This package support either composition and options api with typescript or javascript.

import { VueCodeHighlighter, VueCodeHighlighterMulti } from 'vue-code-highlighter';
import 'vue-code-highlighter/dist/style.css'

This package does not need to call CSS from the highlight.js package because I have already wrapped it. What you need to do is install the highlight.js package.

Example & Demo

Example code and demo available in ichsanputr.github.io/vue-code-highlighter

Props

There are 2 types of components, namely VueCodeHighlighter and VueCodeHighlighterMulti, both of them have different props.

VueCodeHighlighter

AttributeTypeIs RequiredDescription
langStringtrueCode languange from Highlighter cheatset, see Supported languange
codeStringtruePlain code which will be displayed, please wrap your code using backtick (``)
titleStringnoCustom title in header
disableCopyBooleannoDisable copy button and copy functionality to code

VueCodeHighlighterMulti

AttributeTypeIs RequiredDescription
langArraytrueSee example below
disableCopyBooleannoDisable copy button and copy functionality to code

Example for lang props in Multi Code.

const codeMulti = [
  {
    lang: "js",
    title: "vue",
    code: codeVue.value
  },
  {
    lang: "html",
    code: codeHtml.value,
    title: 'html'
  },
  {
    lang: "css",
    code: codeCss.value,
  },
]

Keywords

FAQs

Last updated on 22 May 2024

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