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

@carnet/sketch

v0.3.0

Published

This package provides pure HTML custom elements which simplify the creation of interactive markup code demos.

Downloads

10

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

znerolznerol

Keywords

Readme

Carnet - Sketch Component

This package provides pure HTML custom elements which simplify the creation of interactive markup code demos.

Components included have no third-party dependencies. Users are expected to bundle and transpile them according to their preferences / needs. The components ship bare of any styling.

Installation

npm install -D @carnet/sketch

Usage

Depending on whether or not a bundler / preprocessor is used, the way how custom components are referenced is slightly different.

Plain HTML with ES modules:

<html>
    <head>
        <script type="module" src="node_modules/@carnet/sketch/index.js"></script>
    </head>
   <body>
       [...]
    </body>
</html>

In order to use the elements, place a <carnet-source> and or a <carnet-editor> (inputs) and one or more <carnet-display>, <carnet-window> or <iframe> elements (outputs) into a <carnet-sketch> container.

The <carnet-source> accepts a <template> child which defines markup which is used to initialize the editor and outputs. Alternatively a remote document can be specified using the href attribute on the <carnet-source> element or a <link> child element. In the latter case, the rel attribute needs to be set to CARNET.source.

In order to connect a code editor, it needs to be wrapped into a <carnet-editor>. Currently it only supports a simple <textarea>.

Markup from <carnet-source> and <carnet-editor> is automatically mirrored into a shadow DOM (<carnet-display> outputs), a separate browser window (<carnet-window outputs) or a nested browser context (<iframe> outputs). The outputs are refreshed whenever the input changes.

Example:

<carnet-sketch>
    <carnet-editor>
    	<textarea>
        	<style>h1 { color: red; }</style>
        	<h1>Rendered inside shadow DOM</h1>
        	<p>
            	Changes in the markup will propagate automatically.
        	</p>
    	</textarea>
    </carnet-editor>
    <carnet-display></carnet-display>
</carnet-sketch>

Example markup code can be placed in external files and then referenced using a <link> element placed inside a <carnet-sketch>. The rel attribute of the link needs to be set to CARNET.source. The markup source is then loaded automatically from the referenced document and placed into the <textarea>.

Example:

<carnet-sketch>
    <carnet-source>
        <link rel="CARNET.sketch" href="./some-example.html">
    </carnet-source>
    <carnet-editor>
        <textarea></textarea>
    </carnet-editor>
    <carnet-display></carnet-display>
</carnet-sketch>

License

MIT