@instructure/platform-widget-dashboard 6.1.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WidgetRenderer.d.ts","sourceRoot":"","sources":["../../src/components/WidgetRenderer.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"WidgetRenderer.d.ts","sourceRoot":"","sources":["../../src/components/WidgetRenderer.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAG/C,UAAU,mBAAoB,SAAQ,eAAe;CAEpD;AAED,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAqBxD,CAAA"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { Query, QueryFunctionContext, QueryKey } from '@tanstack/react-query';
|
|
2
2
|
import { default as React } from 'react';
|
|
3
|
-
import { AccountInfo, CurrentUser, DashboardFeatures, DashboardPreferences, ObservedUser, SharedCourseData } from '../types';
|
|
3
|
+
import { AccountInfo, CurrentUser, DashboardFeatures, DashboardPreferences, ObservedUser, SharedCourseData, WidgetRegistry } from '../types';
|
|
4
4
|
export type QueryPersisterFn = <T, TQueryKey extends QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>, ctx: QueryFunctionContext<TQueryKey>, query: Query) => Promise<T>;
|
|
5
5
|
export type { SharedCourseData };
|
|
6
|
-
export declare const WidgetDashboardProvider: ({ children, preferences, observedUsersList, canAddObservee, currentUser, observedUserId, currentUserRoles, sharedCourseData, dashboardFeatures, accountName, accountDashboardUrl, accounts, isDark, queryPersister, }: {
|
|
6
|
+
export declare const WidgetDashboardProvider: ({ children, preferences, observedUsersList, canAddObservee, currentUser, observedUserId, currentUserRoles, sharedCourseData, dashboardFeatures, accountName, accountDashboardUrl, accounts, customWidgets, isDark, queryPersister, }: {
|
|
7
7
|
children: React.ReactNode;
|
|
8
8
|
preferences?: DashboardPreferences;
|
|
9
9
|
observedUsersList?: ObservedUser[];
|
|
@@ -16,6 +16,14 @@ export declare const WidgetDashboardProvider: ({ children, preferences, observed
|
|
|
16
16
|
accountName?: string | null;
|
|
17
17
|
accountDashboardUrl?: string | null;
|
|
18
18
|
accounts?: AccountInfo[];
|
|
19
|
+
/**
|
|
20
|
+
* Registry of host-supplied widget components keyed by type.
|
|
21
|
+
* Custom entries take precedence over built-ins of the same type.
|
|
22
|
+
* Define this at module scope or wrap in useMemo — an inline object
|
|
23
|
+
* literal creates a new reference on every render and invalidates all
|
|
24
|
+
* context consumers.
|
|
25
|
+
*/
|
|
26
|
+
customWidgets?: WidgetRegistry;
|
|
19
27
|
isDark?: boolean;
|
|
20
28
|
queryPersister?: QueryPersisterFn;
|
|
21
29
|
}) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -29,6 +37,7 @@ export declare function useWidgetDashboard(): {
|
|
|
29
37
|
sharedCourseData: SharedCourseData[];
|
|
30
38
|
dashboardFeatures: DashboardFeatures;
|
|
31
39
|
accounts: AccountInfo[];
|
|
40
|
+
customWidgets: WidgetRegistry;
|
|
32
41
|
isDark: boolean;
|
|
33
42
|
queryPersister?: QueryPersisterFn;
|
|
34
43
|
widgetConfig: Record<string, Record<string, unknown>>;
|
|
@@ -53,6 +62,7 @@ export declare const widgetDashboardDefaultProps: {
|
|
|
53
62
|
currentUserRoles: never[];
|
|
54
63
|
sharedCourseData: never[];
|
|
55
64
|
dashboardFeatures: {};
|
|
65
|
+
customWidgets: WidgetRegistry;
|
|
56
66
|
isDark: boolean;
|
|
57
67
|
};
|
|
58
68
|
//# sourceMappingURL=useWidgetDashboardContext.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useWidgetDashboardContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useWidgetDashboardContext.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAClF,OAAO,KAAoE,MAAM,OAAO,CAAA;AACxF,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,
|
|
1
|
+
{"version":3,"file":"useWidgetDashboardContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useWidgetDashboardContext.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAClF,OAAO,KAAoE,MAAM,OAAO,CAAA;AACxF,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACf,MAAM,UAAU,CAAA;AAEjB,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,EAAE,SAAS,SAAS,QAAQ,EAC3D,OAAO,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACrE,GAAG,EAAE,oBAAoB,CAAC,SAAS,CAAC,EACpC,KAAK,EAAE,KAAK,KACT,OAAO,CAAC,CAAC,CAAC,CAAA;AAGf,YAAY,EAAE,gBAAgB,EAAE,CAAA;AAyChC,eAAO,MAAM,uBAAuB,GAAI,sOAgBrC;IACD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,iBAAiB,CAAC,EAAE,YAAY,EAAE,CAAA;IAClC,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAA;IACrC,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,cAAc,CAAA;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,cAAc,CAAC,EAAE,gBAAgB,CAAA;CAClC,4CA8FA,CAAA;AAED,wBAAgB,kBAAkB;iBA7KnB,oBAAoB;uBACd,YAAY,EAAE;oBACjB,OAAO;iBACV,WAAW,GAAG,IAAI;oBACf,MAAM,GAAG,IAAI;sBACX,MAAM,EAAE;sBACR,gBAAgB,EAAE;uBACjB,iBAAiB;cAC1B,WAAW,EAAE;mBACR,cAAc;YACrB,OAAO;qBACE,gBAAgB;kBACnB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;wBACjC,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;uBAC5D,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI;0BACtC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI;EAgKnE;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;mBAiBjB,cAAc;;CAEpC,CAAA"}
|
package/dist/index.d.ts
CHANGED
|
@@ -23,6 +23,6 @@ export { useWidgetDashboardEdit, WidgetDashboardEditProvider, } from './hooks/us
|
|
|
23
23
|
export type { MoveAction } from './hooks/useWidgetLayout';
|
|
24
24
|
export { getMoveActionDescription, useWidgetLayout, WidgetLayoutProvider, } from './hooks/useWidgetLayout';
|
|
25
25
|
export type { CurrentUser, DashboardFeatures, DashboardPreferences, ObservedUser, } from './types/env';
|
|
26
|
-
export type { BaseWidgetProps, Widget, WidgetConfig, WidgetPosition, WidgetSize, } from './types/widget';
|
|
26
|
+
export type { BaseWidgetProps, Widget, WidgetConfig, WidgetPosition, WidgetRegistry, WidgetRenderer as WidgetRendererConfig, WidgetSize, } from './types/widget';
|
|
27
27
|
export { toggleDashboardView } from './utils/dashboardToggle';
|
|
28
28
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +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;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,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,wBAAwB,EAAE,MAAM,+CAA+C,CAAA;AACxF,OAAO,EAAE,eAAe,EAAE,MAAM,sDAAsD,CAAA;AACtF,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAEvE,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,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,GAC5B,MAAM,gDAAgD,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAA;AACpF,YAAY,EACV,mBAAmB,EACnB,eAAe,EACf,mBAAmB,GACpB,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,mBAAmB,EACnB,KAAK,wBAAwB,EAC7B,cAAc,GACf,MAAM,+BAA+B,CAAA;AACtC,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,KAAK,gBAAgB,EACrB,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,UAAU,GACX,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA"}
|
|
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;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,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,wBAAwB,EAAE,MAAM,+CAA+C,CAAA;AACxF,OAAO,EAAE,eAAe,EAAE,MAAM,sDAAsD,CAAA;AACtF,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAEvE,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,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,GAC5B,MAAM,gDAAgD,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAA;AACpF,YAAY,EACV,mBAAmB,EACnB,eAAe,EACf,mBAAmB,GACpB,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,mBAAmB,EACnB,KAAK,wBAAwB,EAC7B,cAAc,GACf,MAAM,+BAA+B,CAAA;AACtC,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,KAAK,gBAAgB,EACrB,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,mBAAmB,EAAE,MAAM,yBAAyB,CAAA"}
|