julianpoemp / codejar-linenumbers

Small repository that enables linenumbers on CodeJar code editor with >= v4.
https://codepen.io/julianpoemp/full/jOjgQzG
MIT License
7 stars 0 forks source link
code-editor codejar plugin

codejar-linenumbers

Third party package that enables line numbers on CodeJar code editor for version >= 4. It's already used by ngx-codejar - an Angular wrapper for Codejar.

Demo

https://codepen.io/julianpoemp/full/jOjgQzG

Background

CodeJar 4 dropped the line numbers feature. This package returns it.

Installation

Via NPM

  1. Make sure you have CodeJar >= 4.0.0 installed.
  2. Install codejar-linenumbers
    npm install --save codejar-linenumbers
  3. If you don't want to use ESM you can import this library using the IFFEE build:
<!-- place the CSS file after the HighlightJS/PrismJS stylesheets -->
<link rel="stylesheet" href="https://github.com/julianpoemp/codejar-linenumbers/blob/main/<node_modules_dir>/codejar-linenumbers/js/codejar-linenumbers.css"/>
<script type="application/javascript" src="https://github.com/julianpoemp/codejar-linenumbers/raw/main/<node_modules_dir>/codejar-linenumbers/js/codejar-linenumbers.min.js"></script>
  1. If you want to use this library with ESM or Typescript, don't forget to load the codejar-linenumbers.css file into your app.

    Via CDN

IFFEE (no module)

<!-- place the CSS file after the HighlightJS/PrismJS stylesheets -->
<link rel="stylesheet" href="https://unpkg.com/codejar-linenumbers/js/codejar-linenumbers.css"/>
<script type="application/javascript" src="https://unpkg.com/codejar-linenumbers/js/codejar-linenumbers.min.js"></script>

ESM

<!-- place the CSS file after the HighlightJS/PrismJS stylesheets -->
<link rel="stylesheet" href="https://unpkg.com/codejar-linenumbers/es/codejar-linenumbers.css"/>
<script type="application/javascript" src="https://unpkg.com/codejar-linenumbers/es/index.js"></script>

Use

Typescript

import {CodeJar} from 'codejar';
import {withLineNumbers} from "codejar-linenumbers";

const jar = CodeJar(editor, withLineNumbers(highlight), {tab: '\t'});

Javascript

ESM

For static HTML see example here: https://codepen.io/julianpoemp/pen/jOjgQzG .

Vanilla JS

Make sure that the codejar-linenumbers/js/codejar-linenumbers.min.js file was loaded.

var jar = CodeJar(editor, CodeJar.withLineNumbers(highlight), {tab: '\t'});

Issues

Please make sure that the issue is related to linenumbers only. For issues related to CodeJar please create issues here.