sp
svelte-prismjs
npm i svelte-prismjs
sp

svelte-prismjs

Svelte Prism Plugin

by Noah

1.0.2 (see all)TypeScript:Not Found
npm i svelte-prismjs
Readme

SvelteJS Prism

This package is a wrapper for PrismJS. It works with line numbers and whitespace clean up out of the box. You can enable other plugins and languages as well. It was inspired by svelte-prism, another Svelte Prism package.

Live Svelte Demo

The repo has the Svelte code to run the demo.

Sapper Example

Routify Example

Features

  • Supports PrismJS plugins and data attributes being passed to the pre element.
  • Allows for client side loading in Sapper and Routify.
  • Supports code being changed dynamically in the Prism html element.
  • Examples and setup instructions.

Svelte Setup Instructions

  1. Run npm install --save-dev svelte-prismjs

  2. Load the css via CDN (if loading via CDN skip ahead to Option B) or...

  3. npm install rollup-plugin-css-only

Rollup Config

  1. Import the css into your main.js file.
import "prismjs/plugins/line-numbers/prism-line-numbers.css";
import "prismjs/plugins/command-line/prism-command-line.css";
import "prismjs/plugins/line-highlight/prism-line-highlight.css";

import "prismjs/themes/prism.css";
import "prismjs/themes/prism-coy.css";

Be sure to double check link integrity at PRISM CDN

<!-- base theme -->
<link
  rel="stylesheet"
  href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.23.0/themes/prism.min.css"
  integrity="sha512-tN7Ec6zAFaVSG3TpNAKtk4DOHNpSwKHxxrsiw4GHKESGPs5njn/0sMCUMl2svV4wo4BK/rCP7juYz+zx+l6oeQ=="
  crossorigin="anonymous"
/>
<!-- coy theme -->
<link
  rel="stylesheet"
  href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.23.0/themes/prism-coy.min.css"
  integrity="sha512-CKzEMG9cS0+lcH4wtn/UnxnmxkaTFrviChikDEk1MAWICCSN59sDWIF0Q5oDgdG9lxVrvbENSV1FtjLiBnMx7Q=="
  crossorigin="anonymous"
/>
<!-- Number lines  -->
<link
  rel="stylesheet"
  href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.23.0/plugins/line-numbers/prism-line-numbers.min.css"
  integrity="sha512-cbQXwDFK7lj2Fqfkuxbo5iD1dSbLlJGXGpfTDqbggqjHJeyzx88I3rfwjS38WJag/ihH7lzuGlGHpDBymLirZQ=="
  crossorigin="anonymous"
/>

Sapper Instructions

Sapper Example

  1. Run npm install svelte-prismjs

  2. You can either include the cdn links in your template.html file or you can install the rollup-css-only-plugin. It is basically what step 2 is for Svelte minus different directories. For Sapper be sure you put the file in the static folder.

  3. Import Svelte-Prism (Because Prism uses the window object we have to do some weird stuff to get it work. For now here is the work around.).

let Prism;
onMount(async () => {
    // Load the prismjs first after the page is loaded
    const prismModule = await import("svelte-prismjs");
    await import("prismjs/components/prism-c.js");
    await import("prism-svelte");

    await import("prismjs/plugins/line-highlight/prism-line-highlight.js");
    await import("prismjs/plugins/file-highlight/prism-file-highlight.js");
    // Once everything is loaded load the prismjs module
    Prism = prismModule.default;

  });

  <svelte:component this={Prism}>
  {`let b = 3;
function helloWorld() {
    console.log("Hello World");
}
`}
</svelte:component>

Routify Instructions

Routify Example

  1. Run npm install svelte-prismjs

  2. Go to scripts/base.config.js and add the rollup-css-only-plugin or go to the static/\_\_index.html file. If you do use npm to include css you will have to add it to App.svelte file under global styles.

let Prism;
onMount(async () => {
    // Load the prismjs first after the page is loaded
    const prismModule = await import("svelte-prismjs");
    await import("prismjs/components/prism-c.js");
    await import("prism-svelte");

    await import("prismjs/plugins/line-highlight/prism-line-highlight.js");
    await import("prismjs/plugins/file-highlight/prism-file-highlight.js");
    // Once everything is loaded load the prismjs module
    Prism = prismModule.default;

  });

  <svelte:component this={Prism}>
  {`let b = 3;
function helloWorld() {
    console.log("Hello World");
}
`}
</svelte:component>

Examples

Full Examples

Simple Example using the slot. Language will default to javascript.

<Prism>
  { `let b = 3; function helloWorld() { console.log("Hello World"); } `}
</Prism>

Example Language and line numbers and using the code prompt.

<Prism
  showLineNumbers="{true}"
  language="c"
  code="{`int b= 3;
int c=32;
  `}
/>

Props

  • code -> (string) for passing code into the element. You can also pass the code between the elements because it uses a slot.
  • language -> (string) Used the pass the language you are using. You will need to import the language if it is not included by default. Import this after you import the element, client side only. This is default to javascript.
import "prismjs/components/prism-c.js";
  • showLineNumbers -> (bool) Will turn on and off line numbers for your code. Defaulted to false.
  • normalizeWhiteSpace -> (bool) Will clean up the white space in your code. This is default to true.
  • normalizeWhiteSpaceConfig -> (object) Will be used to over ride the default config. For more information go here.
  • classes -> custom css classes for the pre-element.
  • You can also pass any props or styles in the component and it will be applied to the pre-element.

Downloads/wk

44

GitHub Stars

14

LAST COMMIT

2yrs ago

MAINTAINERS

1

CONTRIBUTORS

2

OPEN ISSUES

0

OPEN PRs

0
VersionTagPublished
1.0.2
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate