@sanity/dashboard
6.0.206.0.21
~
Modified (4 files)
Index: package/package.json
===================================================================
--- package/package.json
+++ package/package.json
@@ -1,7 +1,7 @@
{
"name": "@sanity/dashboard",
- "version": "6.0.20",
+ "version": "6.0.21",
"description": "Tool for rendering dashboard widgets",
"keywords": [
"cms",
"content",
@@ -34,22 +34,22 @@
},
"dependencies": {
"@sanity/icons": "^5.2.3",
"@sanity/image-url": "^2.1.1",
- "@sanity/ui": "^4.4.0",
+ "@sanity/ui": "^4.4.4",
"rxjs": "^7.8.2"
},
"devDependencies": {
"@sanity/tsconfig": "^2.2.1",
- "@sanity/tsdown-config": "^0.27.1",
+ "@sanity/tsdown-config": "^0.28.8",
"@types/react": "^19.3.0",
"@types/react-dom": "^19.3.0",
"oxc-transform-react": "^0.153.0",
"react": "^19.3.0",
"react-dom": "^19.3.0",
- "sanity": "^6.16.0",
+ "sanity": "^6.18.0",
"styled-components": "^6.5.3",
- "tsdown": "^0.22.14"
+ "tsdown": "^0.23.1"
},
"peerDependencies": {
"react": "^19.2",
"react-dom": "^19.2", Index: package/dist/index.d.ts.map
===================================================================
--- package/dist/index.d.ts.map
+++ package/dist/index.d.ts.map
@@ -1,1 +1,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;EACf;EACA;EACA,WAAW,yBAAyB;EACpC,SAAS;EACT,UAAU;;KAGA;UAEK;EACf,QAAQ;EACR,SAAS;;UAGM;EACf,SAAS;EACT,SAAS;;UCwBD;EACR;EACA,UAAU,MAAM;EAChB,SAAS,MAAM;EACf,MAAM,MAAM,IAAI;;iBAGF,yBAAyB,OAAO,uCAAoB,IAAA;iBC/CpD,kBAAkB;EAAU,SAAS;IAAgB;iBCArD,mBAAmB;EAAU,SAAS;IAAgB;iBCAtD,sBAAsB;EAAU,SAAS;IAAgB;UCwBxD;;;;EAIf;;;;EAIA;;;;EAIA,OAAO;EACP,UAAU;;;;EAKV,gBAAgB;;cAGL,gCAAa,OAAA"}
\ No newline at end of file
+{"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":";;iBAEiB;EACf;EACA;EACA,WAAW,yBAAyB;EACpC,SAAS;EACT,UAAU;;YAGA;iBAEK;EACf,QAAQ;EACR,SAAS;;iBAGM;EACf,SAAS;EACT,SAAS;;UCwBD;EACR;EACA,UAAU,MAAM;EAChB,SAAS,MAAM;EACf,MAAM,MAAM,IAAI;;wBAGF,yBAAyB,OAAO,uCAAoB,IAAA;wBC/CpD,kBAAkB;EAAU,SAAS;IAAgB;wBCArD,mBAAmB;EAAU,SAAS;IAAgB;wBCAtD,sBAAsB;EAAU,SAAS;IAAgB;UCwBxD;;;;EAIf;;;;EAIA;;;;EAIA,OAAO;EACP,UAAU;;;;EAKV,gBAAgB;;qBAGL,gCAAa,OAAA"}
\ No newline at end of file Index: package/README.md
===================================================================
--- package/README.md
+++ package/README.md
@@ -24,10 +24,10 @@
In `sanity.config.js` (or .ts), add the dashboard tool to the defineConfig plugins array:
```ts
-import {defineConfig} from 'sanity'
import {dashboardTool} from '@sanity/dashboard'
+import {defineConfig} from 'sanity'
export default defineConfig({
/* ... */
plugins: [dashboardTool({widgets: []})],
})
@@ -40,15 +40,15 @@
Now, add any widgets you might want. The dashboard plugin provides three widgets out-of-the-box:
```ts
-import {defineConfig} from 'sanity'
import {
dashboardTool,
sanityTutorialsWidget,
projectUsersWidget,
projectInfoWidget,
} from '@sanity/dashboard'
+import {defineConfig} from 'sanity'
// configure the dashboard tool with widgets
dashboardTool({
widgets: [sanityTutorialsWidget(), projectInfoWidget(), projectUsersWidget()],
@@ -63,11 +63,11 @@
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:
```ts
-import {defineConfig} from 'sanity'
import {dashboardTool} from '@sanity/dashboard'
import {ActivityIcon} from '@sanity/icons/Activity'
+import {defineConfig} from 'sanity'
dashboardTool({
name: 'stats',
title: 'Statistics', Index: package/dist/index.d.ts
===================================================================
--- package/dist/index.d.ts
+++ package/dist/index.d.ts
@@ -1,19 +1,19 @@
import "@sanity/ui/styles.css";
import { ComponentClass, ComponentType, FunctionComponent } from "react";
-interface DashboardWidget {
+export 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 {
+export type LayoutSize = 'auto' | 'small' | 'medium' | 'large' | 'full';
+export interface LayoutConfig {
width?: LayoutSize;
height?: LayoutSize;
}
-interface DashboardConfig {
+export interface DashboardConfig {
widgets: DashboardWidget[];
layout?: LayoutConfig;
}
interface DashboardWidgetProps {
@@ -21,16 +21,16 @@
children: React.ReactNode;
footer?: React.ReactNode;
ref?: React.Ref<HTMLDivElement>;
}
-declare function DashboardWidgetContainer(props: DashboardWidgetProps): import("react").JSX.Element;
-declare function projectInfoWidget(config?: {
+export declare function DashboardWidgetContainer(props: DashboardWidgetProps): import("react").JSX.Element;
+export declare function projectInfoWidget(config?: {
layout?: LayoutConfig;
}): DashboardWidget;
-declare function projectUsersWidget(config?: {
+export declare function projectUsersWidget(config?: {
layout?: LayoutConfig;
}): DashboardWidget;
-declare function sanityTutorialsWidget(config?: {
+export declare function sanityTutorialsWidget(config?: {
layout?: LayoutConfig;
}): DashboardWidget;
interface DashboardPluginConfig {
/**
@@ -50,7 +50,7 @@
* 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 };
+export declare const dashboardTool: import("sanity").Plugin<DashboardPluginConfig>;
+export type { DashboardPluginConfig };
//# sourceMappingURL=index.d.ts.map
\ No newline at end of file