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-structure-schema

v0.0.1

Published

Create Sanity Desk Structure with a similar syntax to Schema

Downloads

2

Readme

sanity-plugin-structure-schema

Create Sanity Desk Structure with a similar syntax to Schema.

Look, I'll level with you

This plugin is a proof of concept and should not be treated like a reliable, production-ready or supported or officially endorsed project. Sure, I work at Sanity, but that's not to say this plugin is a good idea. I personally find it useful.

YMMV. Tread lightly. Feedback welcome.

Installation

sanity install structure-schema

First you'll need to have Desk Tool Structure setup in your project, so that you have a file (like deskStructure.js) to create your structure in.

Now build out schema items as an array of objects.

// deskStructure.js
import {structureSchema} from 'sanity-plugin-structure-schema'

const structureSchemaItems = [{schemaType: `article`}]

export default () => {
  return S.list().title('Content').items(structureSchema(structureSchemaItems))
}

Each object has one of two required values:

  • { schemaType: "typeName" } for creating document list items
  • { divider: true } for creating dividers

The full set of options for a document list object are:

schemaType: string
singleton?: boolean
id?: string
title?: string
icon?: any
filter?: string
params?: any
apiVersion?: string
children?: StructureSchema[]

You can even S.things() in your array as well and they'll just get passed through.

Example

The below example will create a document list with:

  • All page type Documents
  • A single page type Document with the _id home
  • A Divider
  • All project type Documents using the built-in structure builder
  • A top level menu item for post type Documents with children -- post type documents with a future publishedAt date -- post type documents with a past publishedAt date
const structureSchemaItems = [
  {schemaType: `page`},
  {schemaType: `page`, id: `home`, singleton: true},
  {divider: true},
  S.documentTypeListItem(`project`).title(`Legacy Projects`),
  {schemaType: `post`, title: `Posts`, children: [
    {schemaType: `post`, title: `Future Posts`, filter: `dateTime(now()) < dateTime(publishedAt)`}
    {schemaType: `post`, title: `Past Posts`, filter: `dateTime(now()) > dateTime(publishedAt)`}
  ]},
]

What this won't do (currently)

  • Initial value templates
  • Menu items
  • Orderings
  • Views (use getDefaultDocumentNode() instead)

License

MIT © Simeon Griggs See LICENSE