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-inline-svg-upload-field

v2.0.1

Published

Sanity.io studio plugin to upload and display SVG files inline.

Downloads

2

Readme

sanity-plugin-inline-svg

Inline SVG Upload and Preview for Sanity

npm version license

Installing

In your Sanity studio folder, run:

sanity install sanity-plugin-inline-svg

Features

  • Upload SVG as string that gets injected as HTML into a preview container
  • Use on arrays to build a group of inline SVGs

Basic usage

TL;DR: Just use type: 'svgUploadPreview' on a field in your schema

NOTE Don't forget to import into your schema.js file:

import svgUploadPreview from 'sanity-plugin-inline-svg';

Long version: In your schema definitions (think schemas/clientList.js):

export default {
  name: 'clientList',
  title: 'My Past Clients',
  type: 'document',
  fields: [
    // ... other fields ...
    {
      name: 'svgUpload',
      title: 'Upload SVG File',
      type: 'svgUploadPreview',
    }
  ]
}

Within Array:

  1. Create an object schema something like schemas/svgUploadArray.js
import SvgPreviewComponent from './svgPreviewComponent';

export default {
  type: 'object',
  name: 'svgUpload',
  title: 'Client Image Upload',
  fields: [
    {
      type: '',
      name: 'source',
      title: 'Client SVG Logo',
    },
  ],
  preview: {
    select: {
      svgHtml: 'source',
    },
    component: SvgPreviewComponent,
  },
};
  1. Create a preview component for the array items schemas/svgPreviewComponent.js
import React from 'react';

function SvgPreviewComponent({ value }) {
  if (!value) {
    return <pre>Please upload an svg image</pre>;
  }
  return (
    <>
      <div dangerouslySetInnerHTML={{ __html: value.svgHtml }} />
    </>
  );
}

export default SvgPreviewComponent;
  1. In your schema definitions (think schemas/clientList.js):
export default {
  name: 'clientList',
  title: 'My Past Clients',
  type: 'document',
  fields: [
    // ... other fields ...
    {
      name: 'clientLogos',
      type: 'array',
      title: 'Client Logos',
      description: 'Client Logo Upload',
      options: {
        layout: 'grid',
      },
      of: [
        {
          title: 'Client Logos',
          type: 'svgUpload',
        },
      ],
    }
  ]
}

Development

Clone down this repository and run the following commands at the root of this repository.

npm i
npm link

Now you can start developing the plugin. To include it in your Sanity test site, navigate to the root folder of your cms project and run npm link sanity-plugin-inline-svg. You will now reference the local version of the when using import svgUploadPreview from 'sanity-plugin-inline-svg' in your schemas.

To debug the plugin files in you then need to run sanity start --preserve-symlinks in your cms project, and npm run dev in your sanity-plugin-inline-svg-upload-preview repository folder.

TODO

  • [ ] Allow styles to override
  • [x] Move Upload SVG CTA to react component from css
  • [x] ~Clean up some syntax~ sanitized svg on upload