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

@openwebwork/pg-codemirror-editor

v0.0.1-beta.28

Published

PG CodeMirror Editor

Downloads

915

Readme

PG CodeMirror 6 Editor

This package implements a CodeMirror 6 editor that is primarily intended for editing PG problem files for the WeBWorK Online Homework Delivery System. However, it also supports editing Perl, HTML, XML, Mojolicious HTML templates, and Mojolicious raw text templates since those are needed by webwork2.

The dist/pg-codemirror-editor.js can be used via a script tag and sets the global PGCodeMirrorEditor object. The PGCodeMirrorEditor.View class is the only key in the object. It can be used as follows

const pgEditor = new PGCodeMirrorEditor.View(codeMirrorElt, { source: sourceCode });

PGCodeMirrorEditor.View class

The following methods and attributes for the PGCodeMirrorEditor.View class are available. Note that although the theme and keymap can be set via initialization options or provided methods, usually you do not want to do this. The theme and keymap can be changed by the user via the user interface provided in the editor, and the user's choices are saved in local storage in the browser.

Constructor

The syntax for usage of the PGCodeMirrorEditor.View is

PGCodeMirrorEditor.View(
    element: HTMLElement,
    options?: {
        language?: string;
        source?: string;
        theme?: string;
        keyMap?: string;
});

The options are described below.

source: string

Get the source code to be edited with the source getter, and set the current source with the source setter. Note that setting the source will only update the code shown with the new contents, and the editor state will be maintained (including undo and redo history). If the intent is to reset the state with a new document use the newSource method instead.

newSource(doc: string): void

Set the source code to be edited in the editor. This resets the editor state, and loads the new code.

setLanguage(languageName: string): Promise<void>

Set the language for the editor after initialization. The languageName must be one of the languages listed for the constructor language option. Note that this method is async.

setTheme(themeName: string): Promise<void>

Set the theme for the editor after initialization. The themeName must be one of the themes listed for the constructor theme option. Note that this method is async.

setKeyMap(keyMapName: string): Promise<void>

Set the keymap for the editor after initialization. The keyMapName must be one of the keymaps listed for the constructor keymap option. Note that this method is async.

refresh(key: string): void

Schedule a layout measurement for the editor. Provide a string key that identifies the call. When multiple requests with the same key are scheduled, only the last one will actually be run.

Development Testing

Executing npm run serve will make an html test page available at http://localhost:8080.