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

@humandetail/code-viewer

v0.2.0

Published

Display your code with Canvas Rendering.

Downloads

31

Readme

Code Viewer

This is a library that utilizes Canvas to showcase code snippets, allowing you to visually display your code on web pages in an engaging way.

English | 简体中文

Features

  • Utilizes Canvas technology to draw code snippets, supporting custom styles and colors.

  • Supports syntax highlighting for improved code readability.

  • Can be embedded into your web page using a simple API.

Playground

Here's a playground.

Installation

# add code-viewer
npm i @humandetail/code-viewer

# add highlight.js
npm i highlight.js

Usage

import { CodeViewer } from '@humandetail/code-viewer'

const cv = new CodeViewer({
  content: 'Your code string.',
  language: 'language'
})

cv.mount(document.querySelector('#container'))
  .render()

Options

new CodeViewer(options?: ViewerOptions, theme?: CodeViewerTheme)

ViewerOptions

|Property|Description|Type|Default| |-|-|-|-| |content|The code string|string|''| |language|Language of the code|string|'PlainText'| |width|-|number|0| |height|-|number|0| |themeMode|Theme of the code viewer|'light' | 'dark'|'light'| |displayLineNumber|Whether the line number is display|boolean|false| |breakRow|Whether break the row if overflow|boolean|false| |overflowX|If overflowX is auto and breakRow is false. The canvas width will follow the maximum width of the row. If overflowX is scroll and breakRow is false. A horizontal scroll bar will be displayed.|'auto' | 'scroll' | 'hidden'|'auto'| |overflowY|-|'auto' | 'scroll' | 'hidden'|'auto'| |headerBarSetting|-|{ visible?: boolean, displayLanguage?: boolean, collapsible?: boolean, copyable?: boolean }|visible: false, displayLanguage: false, collapsible: false, copyable: false| |isCollapsed|-|boolean|false|

CodeViewerTheme

If you want to customize the theme, check out the type declaration file.

API

  • setTheme(theme: CodeViewerTheme, themeMode?: 'light' | 'dark'): CodeViewer

  • reset(options?: ViewerOptions, them?: CodeViewerTheme): void

  • update(content?: string, language?: string, resetScroll?: boolean): void

  • render(): CodeViewer

  • resize(width: number, height: number): void

  • mount(el: string | Element): CodeViewer

  • unmount(): void

Contributing

If you encounter any issues or wish to improve this library, feel free to submit issues and pull requests. Your contributions will be greatly appreciated!

LICENSE

This project is licensed under the MIT License.