@snorreeb/sanity-plugin-dashboard-widget-cats NPM

sanity-plugin-dashboard-widget-cats

NOTE
This is the Sanity Studio v3 version of sanity-plugin-dashboard-widget-cats.
For the v2 version, please refer to the v2-branch.

What is it?

An example dashboard widget for @sanity/dashboard that shows a random cat.

This plugin mostly exist to show how a simple widget can be made.

Install

npm install --save sanity-plugin-dashboard-widget-cats

yarn add sanity-plugin-dashboard-widget-cats

Ensure that you have followed install and usage instructions for @sanity/dashboard.

Usage

Add it as a widget to @sanity/dashboard plugin in sanity.config.ts (or .js):

import { dashboardTool } from "@sanity/dashboard";
import { catsWidget } from "sanity-plugin-dashboard-widget-cats";

export default createConfig({
  // ...
  plugins: [
     dashboardTool({
             widgets: [
                 catsWidget(),
             ],
         }
     ),
  ] 
})

Configure

The widget size can be controlled using layout.width:

dashboardTool({
        widgets: [
            catsWidget({ layout: { width: "small" } }),
        ],
    }
)

License

MIT-licensed. See LICENSE.

Develop & test

Make sure to run npm run build once, then run

npm run link-watch

In another shell, cd to your test studio and run:

npx yalc add sanity-plugin-dashboard-widget-cats --link && yarn install

Now, changes in this repo will be automatically built and pushed to the studio, triggering hotreload. Yalc avoids issues with react-hooks that are typical when using yarn/npm link.