@sanity/dashboard 5.0.1 → 6.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Sanity.io
+Copyright (c) 2026 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,4 @@
-Sanity Dashboard
-
-> For the v2 version, please refer to the [v2-branch](https://github.com/sanity-io/dashboard/tree/studio-v2).
+# @sanity/dashboard
 
 ## What is it?
 
@@ -60,7 +58,7 @@ dashboardTool({
 Widgets can be configured by passing widget-specific config:
 
 ```ts
-projectUsersWidget({layout: 'medium'})
+projectUsersWidget({layout: {width: 'medium'}})
 ```
 
 You can change the name, title and icon of the dashboard tool should you want to - which also allows you to configure multiple dashboards with different configurations:
@@ -153,56 +151,12 @@ Setting up the widget with the default setup will give you a basic widget that l
 
 You can study the source code of these widgets to get a sense of how you can approach fetching of documents, adding configuration, and so on:
 
-- [dashboard-widget-document-list](https://github.com/sanity-io/dashboard-widget-document-list)
-- [dashboard-widget-widget-document-count](https://github.com/sanity-io/example-dashboard-widget-document-count)
-- [dashboard-widget-netlify](https://github.com/sanity-io/sanity-plugin-dashboard-widget-netlify)
+- [dashboard-widget-document-list](https://github.com/sanity-io/plugins/tree/main/plugins/sanity-plugin-dashboard-widget-document-list)
+- [dashboard-widget-vercel](https://github.com/sanity-io/plugins/tree/main/plugins/sanity-plugin-dashboard-widget-vercel)
+- [dashboard-widget-netlify](https://github.com/sanity-io/plugins/tree/main/plugins/sanity-plugin-dashboard-widget-netlify)
 
 ---
 
-### Upgrading from v2
-
-If you were previously using @sanity/dashboard in a v2 Sanity Studio, will have to make the following changes:
-
-- Install the v3 version of @sanity/dashboard in the Studio
-- Install v3 versions of any widgets
-- Configure the dashboard as described above:
-  - Add dashboardTool to plugins array
-  - Add widgets to widgets configuration
-  - Move any config you had in v2 `dashboardConfiguration.js` on a widget-by-widget basis.
-  - V2 used an options-object to pass widget-specific configuration. In v3, options have been replaced by
-    passing the same configuration directly to the widget-function.
-- Custom widget components should import DashboardWidgetContainer instead of DashboardWidget
-
-## Develop & test
-
-This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
-with default configuration for build & watch scripts.
-
-See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
-on how to run this plugin with hotreload in the studio.
-
-### Release new version
-
-Run ["CI & Release" workflow](https://github.com/sanity-io/dashboard/actions/workflows/main.yml).
-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.
-
 ## License
 
 MIT-licensed. See LICENSE.
-
-## Develop & test
-
-This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
-with default configuration for build & watch scripts.
-
-See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
-on how to run this plugin with hotreload in the studio.
-
-### Release new version
-
-Run ["CI & Release" workflow](https://github.com/sanity-io/dashboard/actions/workflows/main.yml).
-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.

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import React, { ComponentClass, ComponentType, FunctionComponent } from "react";
+interface DashboardWidget {
+  name: string;
+  type?: '__experimental_group';
+  component: FunctionComponent<any> | ComponentClass<any>;
+  layout?: LayoutConfig;
+  widgets?: DashboardWidget[];
+}
+type LayoutSize = 'auto' | 'small' | 'medium' | 'large' | 'full';
+interface LayoutConfig {
+  width?: LayoutSize;
+  height?: LayoutSize;
+}
+interface DashboardConfig {
+  widgets: DashboardWidget[];
+  layout?: LayoutConfig;
+}
+interface DashboardWidgetProps {
+  header?: string;
+  children: React.ReactNode;
+  footer?: React.ReactNode;
+}
+declare const DashboardWidgetContainer: React.ForwardRefExoticComponent<DashboardWidgetProps & React.RefAttributes<HTMLDivElement>>;
+declare function projectInfoWidget(config?: {
+  layout?: LayoutConfig;
+}): DashboardWidget;
+declare function projectUsersWidget(config?: {
+  layout?: LayoutConfig;
+}): DashboardWidget;
+declare function sanityTutorialsWidget(config?: {
+  layout?: LayoutConfig;
+}): DashboardWidget;
+interface DashboardPluginConfig {
+  /**
+   * Dashboard tool title
+   */
+  title?: string;
+  /**
+   * Dashboard tool name (used in url path)
+   */
+  name?: string;
+  /**
+   * Dashboard tool icon
+   */
+  icon?: ComponentType;
+  widgets?: DashboardWidget[];
+  /**
+   * Will be used for widgets that do not define a layout directly.
+   */
+  defaultLayout?: LayoutConfig;
+}
+declare const dashboardTool: import("sanity").Plugin<DashboardPluginConfig>;
+export { DashboardConfig, type DashboardPluginConfig, DashboardWidget, DashboardWidgetContainer, LayoutConfig, LayoutSize, dashboardTool, projectInfoWidget, projectUsersWidget, sanityTutorialsWidget };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/components/DashboardWidgetContainer.tsx","../src/widgets/projectInfo/index.ts","../src/widgets/projectUsers/index.ts","../src/widgets/sanityTutorials/index.ts","../src/plugin.tsx"],"mappings":";UAEiB,eAAA;EACf,IAAA;EACA,IAAA;EACA,SAAA,EAAW,iBAAA,QAAyB,cAAA;EACpC,MAAA,GAAS,YAAA;EACT,OAAA,GAAU,eAAA;AAAA;AAAA,KAGA,UAAA;AAAA,UAEK,YAAA;EACf,KAAA,GAAQ,UAAA;EACR,MAAA,GAAS,UAAU;AAAA;AAAA,UAGJ,eAAA;EACf,OAAA,EAAS,eAAA;EACT,MAAA,GAAS,YAAY;AAAA;AAAA,UCyBb,oBAAA;EACR,MAAA;EACA,QAAA,EAAU,KAAA,CAAM,SAAA;EAChB,MAAA,GAAS,KAAA,CAAM,SAAS;AAAA;AAAA,cAGb,wBAAA,EAAwB,KAAA,CAAA,yBAAA,CAAA,oBAAA,GAAA,KAAA,CAAA,aAAA,CAAA,cAAA;AAAA,iBC/CrB,iBAAA,CAAkB,MAAA;EAAU,MAAA,GAAS,YAAA;AAAA,IAAgB,eAAe;AAAA,iBCApE,kBAAA,CAAmB,MAAA;EAAU,MAAA,GAAS,YAAA;AAAA,IAAgB,eAAe;AAAA,iBCArE,qBAAA,CAAsB,MAAA;EAAU,MAAA,GAAS,YAAA;AAAA,IAAgB,eAAe;AAAA,UCwBvE,qBAAA;ELzBe;;;EK6B9B,KAAA;ELzBS;;;EK6BT,IAAA;ELhCA;;;EKoCA,IAAA,GAAO,aAAA;EACP,OAAA,GAAU,eAAA;ELlCV;;;EKuCA,aAAA,GAAgB,YAAA;AAAA;AAAA,cAGL,aAAA,mBAAa,MAAA,CAAA,qBAAA"}