@instructure/platform-widget-dashboard 10.3.0 → 10.4.0

package/dist/hooks/useResponsiveContext.d.ts

@@ -1,4 +1,23 @@
 import { default as React } from 'react';
+/**
+ * The widths the widget layouts are designed against, matched against the viewport (not the
+ * container), so they already account for the ~84px side nav both hosts render. Hosts must not
+ * invent their own — a different desktop threshold renders `WidgetGrid`'s two-column row at
+ * widths it was never designed for. Bands are disjoint so exactly one matches.
+ */
+export declare const WIDGET_DASHBOARD_BREAKPOINTS: Readonly<{
+    mobile: Readonly<{
+        maxWidth: "639px";
+    }>;
+    tablet: Readonly<{
+        minWidth: "640px";
+        maxWidth: "1379px";
+    }>;
+    desktop: Readonly<{
+        minWidth: "1380px";
+    }>;
+}>;
+export type ResponsiveBand = keyof typeof WIDGET_DASHBOARD_BREAKPOINTS;
 interface ResponsiveContextValue {
     isMobile: boolean;
     isTablet: boolean;
@@ -6,10 +25,16 @@ interface ResponsiveContextValue {
     matches: string[];
 }
 interface ResponsiveProviderProps {
-    matches: string[];
+    /**
+     * Omit in hosts and stories — the provider self-measures. Passing the prop at all pins the
+     * bands, whatever its contents, so it is for tests and deliberate fixed-viewport previews.
+     */
+    matches?: string[];
     children: React.ReactNode;
 }
 export declare const ResponsiveProvider: React.FC<ResponsiveProviderProps>;
+/** @internal Test-only, so the report can be asserted more than once per module. */
+export declare const resetMissingProviderReport: () => void;
 export declare const useResponsiveContext: () => ResponsiveContextValue;
 export {};
 //# sourceMappingURL=useResponsiveContext.d.ts.map

package/dist/hooks/useResponsiveContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useResponsiveContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useResponsiveContext.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAoC,MAAM,OAAO,CAAA;AAExD,UAAU,sBAAsB;IAC9B,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AASD,UAAU,uBAAuB;IAC/B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC1B;AAED,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAahE,CAAA;AAED,eAAO,MAAM,oBAAoB,QAAO,sBAMvC,CAAA"}
+{"version":3,"file":"useResponsiveContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useResponsiveContext.tsx"],"names":[],"mappings":"AAmBA,OAAO,KAA6C,MAAM,OAAO,CAAA;AAEjE;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;EAIvC,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,4BAA4B,CAAA;AAKtE,UAAU,sBAAsB;IAC9B,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAWD,UAAU,uBAAuB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC1B;AA6BD,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAUhE,CAAA;AAKD,oFAAoF;AACpF,eAAO,MAAM,0BAA0B,YAEtC,CAAA;AAED,eAAO,MAAM,oBAAoB,QAAO,sBAcvC,CAAA"}

package/dist/hooks/useWidgetLayout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useWidgetLayout.d.ts","sourceRoot":"","sources":["../../src/hooks/useWidgetLayout.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAsE,MAAM,OAAO,CAAA;AAE1F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAA;AAElF,OAAO,KAAK,EAAU,YAAY,EAAE,MAAM,UAAU,CAAA;AAIpD,MAAM,MAAM,UAAU,GAClB,WAAW,GACX,YAAY,GACZ,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,eAAe,GACf,iBAAiB,GACjB,aAAa,GACb,gBAAgB,CAAA;AAEpB,eAAO,MAAM,wBAAwB,GACnC,QAAQ,UAAU,EAClB,cAAc,2BAA2B,KACxC,MAqBF,CAAA;AAED,UAAU,uBAAuB;IAC/B,MAAM,EAAE,YAAY,CAAA;IACpB,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAC1D,oBAAoB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAA;IACtF,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAC7D,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;IAChF,WAAW,EAAE,MAAM,IAAI,CAAA;IACvB,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAChC;AAwOD,eAAO,MAAM,oBAAoB,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CAoLxE,CAAA;AAED,wBAAgB,eAAe,4BAM9B"}
+{"version":3,"file":"useWidgetLayout.d.ts","sourceRoot":"","sources":["../../src/hooks/useWidgetLayout.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAsE,MAAM,OAAO,CAAA;AAE1F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAA;AAElF,OAAO,KAAK,EAAU,YAAY,EAAE,MAAM,UAAU,CAAA;AAIpD,MAAM,MAAM,UAAU,GAClB,WAAW,GACX,YAAY,GACZ,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,eAAe,GACf,iBAAiB,GACjB,aAAa,GACb,gBAAgB,CAAA;AAEpB,eAAO,MAAM,wBAAwB,GACnC,QAAQ,UAAU,EAClB,cAAc,2BAA2B,KACxC,MAqBF,CAAA;AAED,UAAU,uBAAuB;IAC/B,MAAM,EAAE,YAAY,CAAA;IACpB,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAC1D,oBAAoB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAA;IACtF,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAC7D,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;IAChF,WAAW,EAAE,MAAM,IAAI,CAAA;IACvB,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAChC;AAqQD,eAAO,MAAM,oBAAoB,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CAsLxE,CAAA;AAED,wBAAgB,eAAe,4BAM9B"}

package/dist/index.d.ts

@@ -23,7 +23,7 @@ export { TodoListWidget } from './components/widgets/TodoListWidget/TodoListWidg
 export { UpcomingWorkWidget } from './components/widgets/UpcomingWorkWidget';
 export { HubWelcomeWidget } from './components/widgets/HubWelcomeWidget';
 export { type TranslateFunction, TranslationsProvider, type TranslationsProviderProps, useTranslations, type WidgetDashboardContext, type WidgetDashboardTranslations, } from './contexts/TranslationsContext';
-export { ResponsiveProvider, useResponsiveContext } from './hooks/useResponsiveContext';
+export { type ResponsiveBand, ResponsiveProvider, useResponsiveContext, WIDGET_DASHBOARD_BREAKPOINTS, } from './hooks/useResponsiveContext';
 export type { SharedCourseData } from './hooks/useWidgetDashboardContext';
 export { useWidgetDashboard, WidgetDashboardProvider, widgetDashboardDefaultProps, } from './hooks/useWidgetDashboardContext';
 export { useWidgetDashboardEdit, WidgetDashboardEditProvider, } from './hooks/useWidgetDashboardEdit';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmBA,OAAO,EACL,OAAO,IAAI,eAAe,EAC1B,OAAO,IAAI,wBAAwB,GACpC,MAAM,uCAAuC,CAAA;AAE9C,OAAO,EAAE,OAAO,IAAI,gCAAgC,EAAE,MAAM,+CAA+C,CAAA;AAC3G,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAA;AACzE,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAA;AAEnE,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAA;AAC9E,YAAY,EAAE,uBAAuB,EAAE,MAAM,8DAA8D,CAAA;AAC3G,OAAO,EAAE,mBAAmB,EAAE,MAAM,8DAA8D,CAAA;AAClG,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,4DAA4D,CAAA;AAC1G,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAA;AACxF,OAAO,EAAE,eAAe,EAAE,MAAM,sDAAsD,CAAA;AAEtF,OAAO,EACL,kCAAkC,EAClC,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8CAA8C,CAAA;AACrF,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,KAAK,iBAAiB,GACvB,MAAM,gDAAgD,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAA;AACpF,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,4DAA4D,CAAA;AAC1G,YAAY,EACV,mBAAmB,EACnB,eAAe,EACf,mBAAmB,GACpB,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAA;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAA;AACxE,OAAO,EACL,KAAK,iBAAiB,EACtB,oBAAoB,EACpB,KAAK,yBAAyB,EAC9B,eAAe,EACf,KAAK,sBAAsB,EAC3B,KAAK,2BAA2B,GACjC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAEvF,YAAY,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AAEzE,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,GAC5B,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,sBAAsB,EACtB,2BAA2B,GAC5B,MAAM,gCAAgC,CAAA;AACvC,YAAY,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EACL,wBAAwB,EACxB,eAAe,EACf,oBAAoB,GACrB,MAAM,yBAAyB,CAAA;AAChC,YAAY,EACV,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,GACb,MAAM,aAAa,CAAA;AACpB,YAAY,EACV,eAAe,EACf,MAAM,EACN,YAAY,EACZ,cAAc,EACd,cAAc,EACd,cAAc,IAAI,oBAAoB,EACtC,UAAU,GACX,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,EACL,UAAU,EACV,eAAe,EACf,WAAW,EACX,KAAK,YAAY,GAClB,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmBA,OAAO,EACL,OAAO,IAAI,eAAe,EAC1B,OAAO,IAAI,wBAAwB,GACpC,MAAM,uCAAuC,CAAA;AAE9C,OAAO,EAAE,OAAO,IAAI,gCAAgC,EAAE,MAAM,+CAA+C,CAAA;AAC3G,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAA;AACzE,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAA;AAEnE,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAA;AAC9E,YAAY,EAAE,uBAAuB,EAAE,MAAM,8DAA8D,CAAA;AAC3G,OAAO,EAAE,mBAAmB,EAAE,MAAM,8DAA8D,CAAA;AAClG,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,4DAA4D,CAAA;AAC1G,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAA;AACxF,OAAO,EAAE,eAAe,EAAE,MAAM,sDAAsD,CAAA;AAEtF,OAAO,EACL,kCAAkC,EAClC,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8CAA8C,CAAA;AACrF,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,KAAK,iBAAiB,GACvB,MAAM,gDAAgD,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAA;AACpF,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,4DAA4D,CAAA;AAC1G,YAAY,EACV,mBAAmB,EACnB,eAAe,EACf,mBAAmB,GACpB,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAA;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAA;AACxE,OAAO,EACL,KAAK,iBAAiB,EACtB,oBAAoB,EACpB,KAAK,yBAAyB,EAC9B,eAAe,EACf,KAAK,sBAAsB,EAC3B,KAAK,2BAA2B,GACjC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,KAAK,cAAc,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,8BAA8B,CAAA;AAErC,YAAY,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AAEzE,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,GAC5B,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,sBAAsB,EACtB,2BAA2B,GAC5B,MAAM,gCAAgC,CAAA;AACvC,YAAY,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EACL,wBAAwB,EACxB,eAAe,EACf,oBAAoB,GACrB,MAAM,yBAAyB,CAAA;AAChC,YAAY,EACV,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,GACb,MAAM,aAAa,CAAA;AACpB,YAAY,EACV,eAAe,EACf,MAAM,EACN,YAAY,EACZ,cAAc,EACd,cAAc,EACd,cAAc,IAAI,oBAAoB,EACtC,UAAU,GACX,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,EACL,UAAU,EACV,eAAe,EACf,WAAW,EACX,KAAK,YAAY,GAClB,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAA"}