@instructure/platform-widget-dashboard 10.9.0 → 10.10.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,8 +1,8 @@
1
1
  import { RceConfig } from '@instructure/platform-rce-adapter';
2
2
  import { default as React } from 'react';
3
- import { AccountInfo, CurrentUser, DashboardFeatures, DashboardPreferences, ObservedUser, SharedCourseData, WidgetRegistry } from '../types';
3
+ import { AccountInfo, CurrentUser, DashboardExperience, DashboardFeatures, DashboardPreferences, ObservedUser, SharedCourseData, WidgetRegistry } from '../types';
4
4
  export type { SharedCourseData };
5
- export declare const WidgetDashboardProvider: ({ children, preferences, observedUsersList, canAddObservee, currentUser, observedUserId, currentUserRoles, sharedCourseData, dashboardFeatures, hubBaseUrl, accountName, accountDashboardUrl, accounts, customWidgets, renderCoursesTab, isDark: isDarkProp, widgetDashboardOverridable, addOakMountPoint, rcsConfig, onSaveWidgetConfig, }: {
5
+ export declare const WidgetDashboardProvider: ({ children, preferences, observedUsersList, canAddObservee, currentUser, observedUserId, currentUserRoles, sharedCourseData, dashboardFeatures, hubBaseUrl, accountName, accountDashboardUrl, accounts, customWidgets, renderCoursesTab, isDark: isDarkProp, widgetDashboardOverridable, dashboardExperience: dashboardExperienceProp, availableDashboardExperiences, addOakMountPoint, rcsConfig, onSaveWidgetConfig, onDashboardExperienceChange, }: {
6
6
  children: React.ReactNode;
7
7
  preferences?: DashboardPreferences;
8
8
  observedUsersList?: ObservedUser[];
@@ -31,9 +31,12 @@ export declare const WidgetDashboardProvider: ({ children, preferences, observed
31
31
  renderCoursesTab?: () => React.ReactNode;
32
32
  isDark?: boolean;
33
33
  widgetDashboardOverridable?: boolean;
34
+ dashboardExperience?: DashboardExperience;
35
+ availableDashboardExperiences?: DashboardExperience[];
34
36
  addOakMountPoint?: boolean;
35
37
  rcsConfig?: RceConfig;
36
38
  onSaveWidgetConfig?: (widgetId: string, config: Record<string, unknown>) => Promise<void>;
39
+ onDashboardExperienceChange?: (experience: DashboardExperience) => void;
37
40
  }) => import("react/jsx-runtime").JSX.Element;
38
41
  export declare function useWidgetDashboard(): {
39
42
  preferences: DashboardPreferences;
@@ -44,6 +47,9 @@ export declare function useWidgetDashboard(): {
44
47
  currentUserRoles: string[];
45
48
  sharedCourseData: SharedCourseData[];
46
49
  dashboardFeatures: DashboardFeatures;
50
+ dashboardExperience: DashboardExperience;
51
+ setDashboardExperience: (experience: DashboardExperience) => void;
52
+ canSwitchDashboardExperience: boolean;
47
53
  hubBaseUrl?: string;
48
54
  accounts: AccountInfo[];
49
55
  customWidgets: WidgetRegistry;
@@ -91,6 +97,7 @@ export declare const widgetDashboardDefaultProps: {
91
97
  customWidgets: WidgetRegistry;
92
98
  isDark: boolean;
93
99
  widgetDashboardOverridable: boolean;
100
+ availableDashboardExperiences: DashboardExperience[];
94
101
  addOakMountPoint: boolean;
95
102
  };
96
103
  //# 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,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAClE,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;AAGjB,YAAY,EAAE,gBAAgB,EAAE,CAAA;AAiEhC,eAAO,MAAM,uBAAuB,GAAI,6UAqBrC;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,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,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;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,KAAK,CAAC,SAAS,CAAA;IACxC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1F,4CA8GA,CAAA;AAED,wBAAgB,kBAAkB;iBAnOnB,oBAAoB;uBACd,YAAY,EAAE;oBACjB,OAAO;iBACV,WAAW,GAAG,IAAI;oBACf,MAAM,GAAG,IAAI;sBACX,MAAM,EAAE;sBACR,gBAAgB,EAAE;uBACjB,iBAAiB;iBACvB,MAAM;cACT,WAAW,EAAE;mBACR,cAAc;IAC7B;;;;;OAKG;uBACgB,MAAM,KAAK,CAAC,SAAS;YAChC,OAAO;eACJ,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;gCACR,OAAO;sBACjB,OAAO;IACzB;;;;;OAKG;gBACS,SAAS;kBACP,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;yBAC7C,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC;EAoM1F;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;mBAiBjB,cAAc;;;;CAIpC,CAAA"}
1
+ {"version":3,"file":"useWidgetDashboardContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useWidgetDashboardContext.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,KAAoE,MAAM,OAAO,CAAA;AACxF,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACf,MAAM,UAAU,CAAA;AAGjB,YAAY,EAAE,gBAAgB,EAAE,CAAA;AA+EhC,eAAO,MAAM,uBAAuB,GAAI,ubAwBrC;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,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,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;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,KAAK,CAAC,SAAS,CAAA;IACxC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;IACzC,6BAA6B,CAAC,EAAE,mBAAmB,EAAE,CAAA;IACrD,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACzF,2BAA2B,CAAC,EAAE,CAAC,UAAU,EAAE,mBAAmB,KAAK,IAAI,CAAA;CACxE,4CAqIA,CAAA;AAED,wBAAgB,kBAAkB;iBA9QnB,oBAAoB;uBACd,YAAY,EAAE;oBACjB,OAAO;iBACV,WAAW,GAAG,IAAI;oBACf,MAAM,GAAG,IAAI;sBACX,MAAM,EAAE;sBACR,gBAAgB,EAAE;uBACjB,iBAAiB;yBACf,mBAAmB;4BAChB,CAAC,UAAU,EAAE,mBAAmB,KAAK,IAAI;kCACnC,OAAO;iBACxB,MAAM;cACT,WAAW,EAAE;mBACR,cAAc;IAC7B;;;;;OAKG;uBACgB,MAAM,KAAK,CAAC,SAAS;YAChC,OAAO;eACJ,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;gCACR,OAAO;sBACjB,OAAO;IACzB;;;;;OAKG;gBACS,SAAS;kBACP,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;yBAC7C,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC;EA4O1F;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;mBAiBjB,cAAc;;;mCAGE,mBAAmB,EAAE;;CAE3D,CAAA"}