@decky/ui 4.16.3 → 4.16.4

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.
@@ -21,17 +21,17 @@ export declare enum ESteamNotificationAction {
21
21
  Remove = 2
22
22
  }
23
23
  interface SteamNotificationData {
24
- bCritical: boolean;
25
- body: string;
26
- duration: number;
27
- logo: ReactNode;
28
- onClick: () => void;
29
- playSound: boolean;
30
- showNewIndicator: boolean;
31
- showToast: boolean;
32
- sound: ESteamUISound;
33
- timestamp: Date;
34
- title: string;
24
+ bCritical?: boolean;
25
+ body?: ReactNode;
26
+ duration?: number;
27
+ logo?: ReactNode;
28
+ onClick?: () => void;
29
+ playSound?: boolean;
30
+ showNewIndicator?: boolean;
31
+ showToast?: boolean;
32
+ sound?: ESteamUISound;
33
+ timestamp?: Date;
34
+ title?: ReactNode;
35
35
  }
36
36
  type RequiredProcessNotifArgs = Record<EClientNotificationType, Record<string, any>> & {
37
37
  [EClientNotificationType.Invalid]: {};
@@ -99,16 +99,16 @@ type RequiredProcessNotifArgs = Record<EClientNotificationType, Record<string, a
99
99
  [EClientNotificationType.GameRecordingInstantClip]: {};
100
100
  };
101
101
  export interface SteamNotification<T extends EClientNotificationType = EClientNotificationType> {
102
- bNewIndicator: boolean;
102
+ bNewIndicator?: boolean;
103
103
  data: SteamNotificationData;
104
- eSource: ESteamNotificationSource;
105
- eType: T;
106
- nToastDurationMS: number;
107
- notificationID: number;
108
- rtCreated: number;
104
+ eSource?: ESteamNotificationSource;
105
+ eType?: T;
106
+ nToastDurationMS?: number;
107
+ notificationID?: number;
108
+ rtCreated?: number;
109
109
  }
110
110
  export interface TrayNotification {
111
- eType: EClientNotificationType;
111
+ eType?: EClientNotificationType;
112
112
  notifications: SteamNotification[];
113
113
  }
114
114
  export interface NotificationTarget {
@@ -118,7 +118,7 @@ export interface NotificationTarget {
118
118
  fnTray?: (target: NotificationTarget, notificationsInTray: TrayNotification[]) => void;
119
119
  nRemoveFromTraySec?: number;
120
120
  toastDurationMS?: number;
121
- type: EClientNotificationType;
121
+ type?: EClientNotificationType;
122
122
  }
123
123
  export interface CNotificationStore {
124
124
  m_LastSystemUpdateNotification: Pick<SteamNotification, 'eType' | 'rtCreated'> | null;
@@ -185,6 +185,7 @@ export interface CNotificationStore {
185
185
  ProcessNotification<T extends EClientNotificationType>(target: NotificationTarget, notification: SteamNotification<T> & RequiredProcessNotifArgs[T], action: ESteamNotificationAction): void;
186
186
  RemoveFromToastsWhere(callback: (toast: SteamNotification) => void): void;
187
187
  RemoveFromTrayWhere(callback: (toast: SteamNotification) => void): void;
188
+ RemoveGroupFromTray(group: any): void;
188
189
  RemoveScreenshotNotification(screenshotHandle: number): void;
189
190
  RunDebugTestsWhenServicesReady(e: boolean): void;
190
191
  ScheduleRemoveFromTray(delaySeconds: number): void;
@@ -22,6 +22,7 @@ type GamepadLibraryClasses = Record<'AppGridFilterHeader' | 'AppGridFilterHeader
22
22
  type FocusRingClasses = Record<'DebugFocusRing' | 'FocusRing' | 'FocusRingOnHiddenItem' | 'FocusRingRoot' | 'blinker' | 'fadeOutline' | 'flash' | 'growOutline', string>;
23
23
  type SearchBarClasses = Record<'BackgroundAnimation' | 'ForceExpanded' | 'IconMovesOnHover' | 'ItemFocusAnim-darkGrey' | 'ItemFocusAnim-darkerGrey' | 'ItemFocusAnim-darkerGrey-nocolor' | 'ItemFocusAnim-green' | 'ItemFocusAnim-grey' | 'ItemFocusAnim-translucent-white-10' | 'ItemFocusAnim-translucent-white-20' | 'ItemFocusAnimBorder-darkGrey' | 'SearchAndTitleContainer' | 'SearchBox' | 'SearchFieldBackground' | 'SearchIconLeft' | 'SearchIconRight' | 'ShowingSearch' | 'ShowingTitle' | 'VR' | 'Visible' | 'WhiteBackground' | 'duration-app-launch', string>;
24
24
  type MainBrowserClasses = Record<'Browser' | 'BrowserContainer' | 'BrowserNavRoot' | 'Disabled' | 'ExternalBrowserContainer' | 'InputSupportLevel' | 'MainBrowser' | 'MainBrowserContainer' | 'MicroTxnContainer' | 'NavigationButton' | 'RequireTouchscreenLabel' | 'StatusIcon' | 'Toggled' | 'URL' | 'URLBar' | 'URLInput' | 'Visible' | 'duration-app-launch' | 'showSupportLevel', string>;
25
+ type VRDashboardClasses = Record<'duration-app-launch' | 'vrgamepadui-floating-side-panel-width' | 'vrgamepadui-floating-side-panel-height' | 'vrgamepadui-floating-bar-popup-panel-width' | 'vrgamepadui-floating-bar-popup-panel-height' | 'vrgamepadui-floating-keyboard-width' | 'vrgamepadui-floating-keyboard-height' | 'vrgamepadui-dashboard-bar-side-button-click-animation-duration' | 'PopupBody' | 'DashboardBar' | 'DynamicWidth' | 'BarSurface' | 'Bookend' | 'BarSurfaceSection' | 'SmallButtonSection' | 'Tabs' | 'Right' | 'Tray' | 'SmallBarButtons' | 'EmptySpace' | 'Item' | 'Clickable' | 'Highlight' | 'Inner' | 'BatteryIconHeaderItem' | 'Active' | 'AddWindowButton' | 'AvatarButton' | 'MenuVisible' | 'FocusRingHint' | 'Avatar' | 'ClickAnimation' | 'ClickPop' | 'BarTabs' | 'FadeLeft' | 'FadeRight' | 'BarTab' | 'Selected' | 'OldColors' | 'Badge' | 'Icon' | 'OverlayIcon' | 'AppIcon' | 'SteamSVG' | 'DashboardBarPopupContents' | 'FullHeight' | 'QuickAccessPopupContents' | 'VolumePopup' | 'ExitVRIcon' | 'ExitVRText' | 'QuickAccessPopupTitle' | 'QuickAccessPopupPanel' | 'BottomFade' | 'ClickableSliderIcon' | 'DashboardBarPopupList' | 'DashboardBarPopupListHeader' | 'DashboardBarPopupListScrollRegion' | 'FadeTop' | 'FadeBottom' | 'DashboardBarPopupSectionStack' | 'DashboardBarPopupListScrollPanel' | 'DashboardBarPopupListItem' | 'BarPopupStack' | 'FullWidth' | 'QuickAccessButton' | 'HasAvatar' | 'Time' | 'Icons' | 'StatusItem' | 'Friends' | 'flash' | 'growOutline' | 'fadeOutline' | 'blinker', string>;
25
26
  export declare const quickAccessMenuClasses: QuickAccessMenuClasses;
26
27
  export declare const scrollPanelClasses: ScrollPanelClasses;
27
28
  export declare const gamepadDialogClasses: GamepadDialogClasses;
@@ -46,6 +47,7 @@ export declare const gamepadLibraryClasses: GamepadLibraryClasses;
46
47
  export declare const focusRingClasses: FocusRingClasses;
47
48
  export declare const searchBarClasses: SearchBarClasses;
48
49
  export declare const mainBrowserClasses: MainBrowserClasses;
50
+ export declare const vrDashboardClasses: VRDashboardClasses;
49
51
  export declare const staticClasses: QuickAccessMenuClasses;
50
52
  export declare const scrollClasses: ScrollPanelClasses;
51
53
  export declare const achievementClasses: AchievementListClasses;
@@ -23,6 +23,7 @@ export const gamepadLibraryClasses = findClassModule(m => m.GamepadLibrary);
23
23
  export const focusRingClasses = findClassModule(m => m.FocusRingRoot);
24
24
  export const searchBarClasses = findClassModule(m => m.SearchAndTitleContainer);
25
25
  export const mainBrowserClasses = findClassModule(m => m.MainBrowserContainer);
26
+ export const vrDashboardClasses = findClassModule(m => m.DashboardBarPopupContents && m.DashboardBar);
26
27
  export const staticClasses = quickAccessMenuClasses;
27
28
  export const scrollClasses = scrollPanelClasses;
28
29
  export const achievementClasses = achievementListClasses;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@decky/ui",
3
- "version": "4.16.3",
3
+ "version": "4.16.4",
4
4
  "description": "A library for interacting with the Steam frontend in Decky plugins and elsewhere.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -28,22 +28,22 @@ export enum ESteamNotificationAction {
28
28
  }
29
29
 
30
30
  interface SteamNotificationData {
31
- bCritical: boolean;
32
- body: string;
31
+ bCritical?: boolean;
32
+ body?: ReactNode;
33
33
  /**
34
34
  * In ms.
35
35
  */
36
- duration: number;
37
- logo: ReactNode;
38
- onClick: () => void;
36
+ duration?: number;
37
+ logo?: ReactNode;
38
+ onClick?: () => void;
39
39
  // TODO: apparently can be a function too
40
- playSound: boolean;
41
- showNewIndicator: boolean;
42
- showToast: boolean;
40
+ playSound?: boolean;
41
+ showNewIndicator?: boolean;
42
+ showToast?: boolean;
43
43
  // TODO: apparently can be a function too
44
- sound: ESteamUISound;
45
- timestamp: Date;
46
- title: string;
44
+ sound?: ESteamUISound;
45
+ timestamp?: Date;
46
+ title?: ReactNode;
47
47
  }
48
48
 
49
49
  type RequiredProcessNotifArgs = Record<EClientNotificationType, Record<string, any>> & {
@@ -113,20 +113,20 @@ type RequiredProcessNotifArgs = Record<EClientNotificationType, Record<string, a
113
113
  };
114
114
 
115
115
  export interface SteamNotification<T extends EClientNotificationType = EClientNotificationType> {
116
- bNewIndicator: boolean;
116
+ bNewIndicator?: boolean;
117
117
  data: SteamNotificationData;
118
- eSource: ESteamNotificationSource;
119
- eType: T;
120
- nToastDurationMS: number;
121
- notificationID: number;
118
+ eSource?: ESteamNotificationSource;
119
+ eType?: T;
120
+ nToastDurationMS?: number;
121
+ notificationID?: number;
122
122
  /**
123
123
  * UNIX timestamp.
124
124
  */
125
- rtCreated: number;
125
+ rtCreated?: number;
126
126
  }
127
127
 
128
128
  export interface TrayNotification {
129
- eType: EClientNotificationType;
129
+ eType?: EClientNotificationType;
130
130
  notifications: SteamNotification[];
131
131
  }
132
132
 
@@ -137,7 +137,7 @@ export interface NotificationTarget {
137
137
  fnTray?: (target: NotificationTarget, notificationsInTray: TrayNotification[]) => void;
138
138
  nRemoveFromTraySec?: number;
139
139
  toastDurationMS?: number;
140
- type: EClientNotificationType;
140
+ type?: EClientNotificationType;
141
141
  }
142
142
 
143
143
  /**
@@ -236,6 +236,7 @@ export interface CNotificationStore {
236
236
  ): void;
237
237
  RemoveFromToastsWhere(callback: (toast: SteamNotification) => void): void;
238
238
  RemoveFromTrayWhere(callback: (toast: SteamNotification) => void): void;
239
+ RemoveGroupFromTray(group: any): void
239
240
  RemoveScreenshotNotification(screenshotHandle: number): void;
240
241
  RunDebugTestsWhenServicesReady(e: boolean): void;
241
242
  ScheduleRemoveFromTray(delaySeconds: number): void;
@@ -1064,6 +1064,84 @@ type MainBrowserClasses = Record<
1064
1064
  string
1065
1065
  >;
1066
1066
 
1067
+ type VRDashboardClasses = Record<
1068
+ | 'duration-app-launch'
1069
+ | 'vrgamepadui-floating-side-panel-width'
1070
+ | 'vrgamepadui-floating-side-panel-height'
1071
+ | 'vrgamepadui-floating-bar-popup-panel-width'
1072
+ | 'vrgamepadui-floating-bar-popup-panel-height'
1073
+ | 'vrgamepadui-floating-keyboard-width'
1074
+ | 'vrgamepadui-floating-keyboard-height'
1075
+ | 'vrgamepadui-dashboard-bar-side-button-click-animation-duration'
1076
+ | 'PopupBody'
1077
+ | 'DashboardBar'
1078
+ | 'DynamicWidth'
1079
+ | 'BarSurface'
1080
+ | 'Bookend'
1081
+ | 'BarSurfaceSection'
1082
+ | 'SmallButtonSection'
1083
+ | 'Tabs'
1084
+ | 'Right'
1085
+ | 'Tray'
1086
+ | 'SmallBarButtons'
1087
+ | 'EmptySpace'
1088
+ | 'Item'
1089
+ | 'Clickable'
1090
+ | 'Highlight'
1091
+ | 'Inner'
1092
+ | 'BatteryIconHeaderItem'
1093
+ | 'Active'
1094
+ | 'AddWindowButton'
1095
+ | 'AvatarButton'
1096
+ | 'MenuVisible'
1097
+ | 'FocusRingHint'
1098
+ | 'Avatar'
1099
+ | 'ClickAnimation'
1100
+ | 'ClickPop'
1101
+ | 'BarTabs'
1102
+ | 'FadeLeft'
1103
+ | 'FadeRight'
1104
+ | 'BarTab'
1105
+ | 'Selected'
1106
+ | 'OldColors'
1107
+ | 'Badge'
1108
+ | 'Icon'
1109
+ | 'OverlayIcon'
1110
+ | 'AppIcon'
1111
+ | 'SteamSVG'
1112
+ | 'DashboardBarPopupContents'
1113
+ | 'FullHeight'
1114
+ | 'QuickAccessPopupContents'
1115
+ | 'VolumePopup'
1116
+ | 'ExitVRIcon'
1117
+ | 'ExitVRText'
1118
+ | 'QuickAccessPopupTitle'
1119
+ | 'QuickAccessPopupPanel'
1120
+ | 'BottomFade'
1121
+ | 'ClickableSliderIcon'
1122
+ | 'DashboardBarPopupList'
1123
+ | 'DashboardBarPopupListHeader'
1124
+ | 'DashboardBarPopupListScrollRegion'
1125
+ | 'FadeTop'
1126
+ | 'FadeBottom'
1127
+ | 'DashboardBarPopupSectionStack'
1128
+ | 'DashboardBarPopupListScrollPanel'
1129
+ | 'DashboardBarPopupListItem'
1130
+ | 'BarPopupStack'
1131
+ | 'FullWidth'
1132
+ | 'QuickAccessButton'
1133
+ | 'HasAvatar'
1134
+ | 'Time'
1135
+ | 'Icons'
1136
+ | 'StatusItem'
1137
+ | 'Friends'
1138
+ | 'flash'
1139
+ | 'growOutline'
1140
+ | 'fadeOutline'
1141
+ | 'blinker',
1142
+ string
1143
+ >
1144
+
1067
1145
  export const quickAccessMenuClasses = findClassModule((m) => m.Title && m.QuickAccessMenu) as QuickAccessMenuClasses;
1068
1146
  export const scrollPanelClasses = findClassModule((m) => m.ScrollPanel) as ScrollPanelClasses;
1069
1147
  export const gamepadDialogClasses = findClassModule((m) => m.GamepadDialogContent && !m.BindingButtons) as GamepadDialogClasses;
@@ -1088,6 +1166,7 @@ export const gamepadLibraryClasses = findClassModule(m => m.GamepadLibrary) as G
1088
1166
  export const focusRingClasses = findClassModule(m => m.FocusRingRoot) as FocusRingClasses;
1089
1167
  export const searchBarClasses = findClassModule(m => m.SearchAndTitleContainer) as SearchBarClasses;
1090
1168
  export const mainBrowserClasses = findClassModule(m => m.MainBrowserContainer) as MainBrowserClasses;
1169
+ export const vrDashboardClasses = findClassModule(m => m.DashboardBarPopupContents && m.DashboardBar) as VRDashboardClasses;
1091
1170
 
1092
1171
  /**
1093
1172
  * @deprecated please use quickAccessMenuClasses instead