Nervous Parrot Muttering

    sanity-plugin-dashboard-widget-cats
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    sanity-plugin-dashboard-widget-cats

    This is a Sanity Studio v3 plugin. For the v2 version, please refer to the v2-branch.

    What is it?

    An example dashboard widget for [@sanity/dashboard][dashboard-plugin] that shows a random cat.

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

    Cat widget

    Install

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

    or

    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 defineConfig({
      // ...
      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

    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 v3 branch and check "Release new version".

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

    Install

    npm i sanity-plugin-dashboard-widget-cats

    DownloadsWeekly Downloads

    351

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    18.6 kB

    Total Files

    12

    Last publish

    Collaborators

    • josh_sanity_io
    • joneidejohnsen
    • nina.andal
    • rankers
    • snorreeb
    • mattcraig
    • vincentquigley
    • stipsan
    • michael-sanity
    • rubioz
    • tonina
    • ritasdias
    • simeonsanity
    • kmelve
    • bjoerge
    • rexxars
    • skogsmaskin
    • simenss
    • robinpyon
    • mariuslundgard
    • sanity-io
    • evenw
    • radhe_sanity
    • rbotten
    • vicbergquist
    • judofyr
    • obliadp
    • dcilke
    • fredcarlsen
    • jorn_georg
    • hermanw
    • svirs
    • mikolajsanity
    • sgulseth
    • atombender