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

sanity-plugin-tldraw

v1.1.0

Published

Draw things in your content

Downloads

18

Readme

sanity-plugin-tldraw

Add a tldraw canvas to your Sanity Studio and React app in just 5 minutes.

📹 Watch a 20 second video to see how it works

Installation

Inside your Sanity Studio

npm install sanity-plugin-tldraw

If you do not yet have a Sanity Studio, you can create a new free project with the following command

npm create sanity@latest

Use in Sanity Studio

Add it as a plugin in sanity.config.ts.

You will also need to import tldraw's CSS. Ideally this won't be necessary in a future release.

// 1️⃣ import tldraw's css
import 'tldraw/tldraw.css'

import {defineConfig} from 'sanity'

// 2️⃣ import the tldraw plugin
import {tldraw} from 'sanity-plugin-tldraw'

export default defineConfig({
  // ... other config
  plugins: [
    // ... other plugins
    // 3️⃣ add the tldraw plugin
    tldraw(),
  ],
})

Then add it as a field in your schema types

export const postType = defineType({
  name: 'post',
  title: 'Post',
  fields: [
    // ... other fields
    defineField({
      name: 'drawing',
      // 👇 this `type` is what the plugin creates
      type: 'tldraw',
      options: {
        // 👇 optional: set the height of the canvas
        height: 400,
      },
    }),
  ],
})

The tldraw schema type is an object with two fields:

  • document, stringified JSON of the drawing, this needs to be parsed when rendered into your front end.
  • sessions, an array of stringified JSON saving the state of each user that interacts with the drawing, so that their position is synced across browsers and saved for when they return.

Render in your front end

When querying on your front end, you likely only need the document field.

*[_type == "post"]{
  title,
  "drawing": drawing.document
}

Install the tldraw SDK for your front end.

npm i tldraw

And render the drawing using the TldrawImage component

import {TldrawImage} from 'tldraw'

export function Post({title, drawing}) {
  return (
    <div>
      <h1>{title}</h1>
      <TldrawImage document={JSON.parse(drawing)} />
    </div>
  )
}

License

MIT © Simeon Griggs

Develop & test

This plugin uses @sanity/plugin-kit with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio on how to run this plugin with hotreload in the studio.

Release new version

Run "CI & Release" workflow. Make sure to select the main branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.