mirror of
https://github.com/SteamDeckHomebrew/decky-frontend-lib.git
synced 2026-05-20 18:10:08 +02:00
Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
41401b1d01 | ||
|
|
8117693427 | ||
|
|
d6ecba605d | ||
|
|
bf58e08e4b | ||
|
|
e965816144 | ||
|
|
59ce9e450c | ||
|
|
980df687e7 | ||
|
|
bea9ac7774 | ||
|
|
063dedbbc1 | ||
|
|
723e2ff76e | ||
|
|
241b22cad7 | ||
|
|
93c59d8026 | ||
|
|
0f9fb5a3b8 | ||
|
|
8c6043b5a7 | ||
|
|
3aa07dc9ce | ||
|
|
3f335b3583 | ||
|
|
4c97097757 | ||
|
|
1ee43e86d6 | ||
|
|
db6ab9c448 | ||
|
|
4646f22b0c | ||
|
|
7eb484d55c | ||
|
|
5164f980b3 | ||
|
|
0457feec95 |
2
.github/workflows/release.yaml
vendored
2
.github/workflows/release.yaml
vendored
@@ -4,7 +4,7 @@ on:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- v4-dev
|
||||
- main
|
||||
|
||||
jobs:
|
||||
release:
|
||||
|
||||
63
CHANGELOG.md
63
CHANGELOG.md
@@ -1,3 +1,66 @@
|
||||
## [4.8.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.8.1...v4.8.2) (2024-11-20)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **Footer:** add missing focus/nav properties ([#113](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/113)) ([8117693](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/8117693427e4dba2f3b5bd24f36704d8d5e65ae2))
|
||||
|
||||
## [4.8.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.8.0...v4.8.1) (2024-10-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **DialogCheckbox:** prevent some potential issues in dialogcheckbox ([bf58e08](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/bf58e08e4b5b183737c9ad43a858b642ce593f93))
|
||||
* prevent issues where toString may not be a function (what) ([e965816](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/e96581614471524cbf91bf962742df867ba3c3e9))
|
||||
|
||||
# [4.8.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.7.4...v4.8.0) (2024-10-05)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **components/Modal:** dont break in desktop ui ([bea9ac7](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/bea9ac777452b883c2f3f3ebf8510c22c4577cd0))
|
||||
* **components/Router:** dont break in desktop ui ([980df68](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/980df687e7b7bf389f478e831f992fb9475eeb15))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **utils/react:** add some window-related utils ([063dedb](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/063dedbbc1573a825571c675bf6bfa8a1bc1c6cd))
|
||||
|
||||
## [4.7.4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.7.3...v4.7.4) (2024-10-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **DialogCheckbox:** don't access getters to prevent their side effects from breaking the component ([241b22c](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/241b22cad711621a1695dfd11da857f13c3fffdf))
|
||||
|
||||
## [4.7.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.7.2...v4.7.3) (2024-10-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **components:** fix missing components on oct 2 2024 beta ([0f9fb5a](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/0f9fb5a3b8ef4f9978025a28323ab080fb0e7a4c))
|
||||
|
||||
## [4.7.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.7.1...v4.7.2) (2024-09-16)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **utils:** fix potential race condition in findSP ([3aa07dc](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/3aa07dc9ce798ff8d1148424ee9e8a8bf2ba78c6))
|
||||
|
||||
## [4.7.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.7.0...v4.7.1) (2024-08-08)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **utils/react:** fix potential race condition in injectFCTrampoline ([4c97097](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/4c97097757919580a380b70785e6c161de6b03cc))
|
||||
|
||||
# [4.7.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.6.0...v4.7.0) (2024-07-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **router:** support desktop bpm overlay ([7eb484d](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/7eb484d55c6be6e7844878eb47eda55591a6cf51))
|
||||
|
||||
# [4.6.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.5.0...v4.6.0) (2024-07-26)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@decky/ui",
|
||||
"version": "4.6.0",
|
||||
"version": "4.8.2",
|
||||
"description": "A library for interacting with the Steam frontend in Decky plugins and elsewhere.",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
|
||||
@@ -78,11 +78,11 @@ export const DialogControlsSection = MappedDialogDivs.get('DialogControlsSection
|
||||
export const DialogControlsSectionHeader = MappedDialogDivs.get('DialogControlsSectionHeader') as FC<DialogCommonProps>;
|
||||
|
||||
export const DialogButtonPrimary = Object.values(CommonUIModule).find(
|
||||
(mod: any) => mod?.render?.toString()?.includes('"DialogButton","_DialogLayout","Primary"'),
|
||||
(mod: any) => mod?.render?.toString?.()?.includes('"DialogButton","_DialogLayout","Primary"'),
|
||||
) as FC<DialogButtonProps>;
|
||||
|
||||
export const DialogButtonSecondary = Object.values(CommonUIModule).find(
|
||||
(mod: any) => mod?.render?.toString()?.includes('"DialogButton","_DialogLayout","Secondary"')
|
||||
(mod: any) => mod?.render?.toString?.()?.includes('"DialogButton","_DialogLayout","Secondary"')
|
||||
) as FC<DialogButtonProps>;
|
||||
|
||||
// This is the "main" button. The Primary can act as a submit button,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { FC, ReactNode } from 'react';
|
||||
|
||||
import { findModule } from '../webpack';
|
||||
import { findModuleExport } from '../webpack';
|
||||
import { DialogCommonProps } from './Dialog';
|
||||
import { FooterLegendProps } from './FooterLegend';
|
||||
|
||||
@@ -18,19 +18,16 @@ export interface DialogCheckboxProps extends DialogCommonProps, FooterLegendProp
|
||||
onClick?(evt: Event): void;
|
||||
}
|
||||
|
||||
export const DialogCheckbox = Object.values(
|
||||
findModule((m: any) => {
|
||||
if (typeof m !== 'object') return false;
|
||||
for (const prop in m) {
|
||||
if (m[prop]?.prototype?.GetPanelElementProps) return true;
|
||||
}
|
||||
return false;
|
||||
}),
|
||||
).find(
|
||||
(m: any) =>
|
||||
m.contextType &&
|
||||
m.prototype?.render.toString().includes('fallback:') &&
|
||||
m?.prototype?.SetChecked &&
|
||||
m?.prototype?.Toggle &&
|
||||
m?.prototype?.GetPanelElementProps,
|
||||
// Do not access KeyDown, SetChecked, Toggle here as they are getters and accessing them outside of a render breaks them globally
|
||||
export const DialogCheckbox = findModuleExport(e =>
|
||||
e?.prototype &&
|
||||
typeof e?.prototype == "object" &&
|
||||
"GetPanelElementProps" in e?.prototype &&
|
||||
"SetChecked" in e?.prototype &&
|
||||
"Toggle" in e?.prototype &&
|
||||
// beta || stable as of oct 2 2024
|
||||
(e?.prototype?.render?.toString?.().includes('="DialogCheckbox"') || (
|
||||
e.contextType &&
|
||||
e.prototype?.render?.toString?.().includes('fallback:')
|
||||
))
|
||||
) as FC<DialogCheckboxProps>;
|
||||
|
||||
@@ -11,5 +11,5 @@ export interface FocusRingProps {
|
||||
}
|
||||
|
||||
export const FocusRing = findModuleExport((e: Export) =>
|
||||
e?.toString()?.includes('.GetShowDebugFocusRing())'),
|
||||
e?.toString?.()?.includes('.GetShowDebugFocusRing())'),
|
||||
) as FC<FocusRingProps>;
|
||||
|
||||
@@ -31,11 +31,42 @@ export enum GamepadButton {
|
||||
STEAM_GUIDE,
|
||||
STEAM_QUICK_MENU,
|
||||
}
|
||||
export declare enum NavEntryPositionPreferences {
|
||||
export enum NavEntryPositionPreferences {
|
||||
/**
|
||||
* Always give focus to the first child element.
|
||||
*/
|
||||
FIRST,
|
||||
|
||||
/**
|
||||
* Always give focus to the last child element.
|
||||
*/
|
||||
LAST,
|
||||
|
||||
/**
|
||||
* Give focus to the child element that would maintain the flow in the X axis.
|
||||
*
|
||||
* Imagine you have a calculator window with 9 standard buttons.
|
||||
* You have 3 rows of buttons, with 3 buttons per row.
|
||||
* If you select button with number 8 and navigate down, the buttons
|
||||
* will be navigated in the following order 8->5->3.
|
||||
* The flow is maintained for the X axis while you're navigating the Y axis.
|
||||
*/
|
||||
MAINTAIN_X,
|
||||
|
||||
/**
|
||||
* Give focus to the child element that would maintain the flow in the Y axis.
|
||||
*
|
||||
* Imagine you have a calculator window with 9 standard buttons.
|
||||
* You have 3 columns of buttons, with 3 buttons per column.
|
||||
* If you select button with number 4 and navigate right, the buttons
|
||||
* will be navigated in the following order 4->5->6.
|
||||
* The flow is maintained for the Y axis while you're navigating the X axis.
|
||||
*/
|
||||
MAINTAIN_Y,
|
||||
|
||||
/**
|
||||
* Give focus to the first child element with `preferredFocus == true` prop.
|
||||
*/
|
||||
PREFERRED_CHILD,
|
||||
}
|
||||
export interface GamepadEventDetail {
|
||||
@@ -48,6 +79,25 @@ export declare type ActionDescriptionMap = {
|
||||
};
|
||||
export declare type GamepadEvent = CustomEvent<GamepadEventDetail>;
|
||||
export interface FooterLegendProps {
|
||||
/**
|
||||
* Navigation entry strategy to be used when gaining focus during navigation.
|
||||
*
|
||||
* This is meant to be used on a parent container that has children. Once the
|
||||
* container (e.g. Focusable) is navigated to and has children in it, the children
|
||||
* is then navigated to (focused) using the provided strategy.
|
||||
*
|
||||
* If no strategy is provided, it seems that the `NavEntryPositionPreferences.FIRST`
|
||||
* is used initialy, but for the next time the parent remembers previously focused
|
||||
* child and focused back on it instead.
|
||||
*/
|
||||
navEntryPreferPosition?: NavEntryPositionPreferences;
|
||||
|
||||
/**
|
||||
* Mark the element as the preferred child (to be focused) whenever the parent uses the
|
||||
* `NavEntryPositionPreferences.PREFERRED_CHILD` navigation strategy.
|
||||
*/
|
||||
preferredFocus?: boolean;
|
||||
|
||||
actionDescriptionMap?: ActionDescriptionMap;
|
||||
onOKActionDescription?: ReactNode;
|
||||
onCancelActionDescription?: ReactNode;
|
||||
|
||||
@@ -26,7 +26,7 @@ export interface MenuGroupProps {
|
||||
}
|
||||
|
||||
const MenuGoupModule = findModuleByExport(e => e?.prototype?.Focus && e?.prototype?.OnOKButton && e?.prototype?.render?.toString().includes?.(`"emphasis"==this.props.tone`));
|
||||
export const MenuGroup: FC<MenuGroupProps> = MenuGoupModule && Object.values(MenuGoupModule).find((e: Export) => typeof e == "function" && e?.toString()?.includes("bInGamepadUI:"));
|
||||
export const MenuGroup: FC<MenuGroupProps> = MenuGoupModule && Object.values(MenuGoupModule).find((e: Export) => typeof e == "function" && e?.toString?.()?.includes("bInGamepadUI:"));
|
||||
export interface MenuItemProps extends FooterLegendProps {
|
||||
bInteractableItem?: boolean;
|
||||
onClick?(evt: Event): void;
|
||||
@@ -42,7 +42,7 @@ export interface MenuItemProps extends FooterLegendProps {
|
||||
|
||||
export const MenuItem: FC<MenuItemProps> = findModuleExport(
|
||||
(e: Export) =>
|
||||
e?.render?.toString()?.includes('bPlayAudio:') || (e?.prototype?.OnOKButton && e?.prototype?.OnMouseEnter),
|
||||
e?.render?.toString?.()?.includes('bPlayAudio:') || (e?.prototype?.OnOKButton && e?.prototype?.OnMouseEnter),
|
||||
);
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { FC, ReactNode } from 'react';
|
||||
|
||||
import { findSP } from '../utils';
|
||||
import { Export, findModule, findModuleByExport, findModuleExport } from '../webpack';
|
||||
import { Export, findModule, findModuleDetailsByExport, findModuleExport } from '../webpack';
|
||||
|
||||
// All of the popout options + strTitle are related. Proper usage is not yet known...
|
||||
export interface ShowModalProps {
|
||||
@@ -50,7 +50,7 @@ export const showModal = (
|
||||
bHideMainWindowForPopouts: false,
|
||||
},
|
||||
): ShowModalResult => {
|
||||
return showModalRaw(modal, parent || findSP(), props.strTitle, props, undefined, {
|
||||
return showModalRaw(modal, parent || findSP() || window, props.strTitle, props, undefined, {
|
||||
bHideActions: props.bHideActionIcons,
|
||||
});
|
||||
};
|
||||
@@ -98,14 +98,14 @@ export const ModalRoot = Object.values(
|
||||
|
||||
return false;
|
||||
}) || {},
|
||||
)?.find((x: any) => x?.type?.toString()?.includes('((function(){')) as FC<ModalRootProps>;
|
||||
)?.find((x: any) => x?.type?.toString?.()?.includes('((function(){')) as FC<ModalRootProps>;
|
||||
|
||||
interface SimpleModalProps {
|
||||
active?: boolean;
|
||||
children: ReactNode;
|
||||
}
|
||||
|
||||
const ModalModule = findModuleByExport((e: Export) => e?.toString().includes('.ModalPosition,fallback:'), 5);
|
||||
const [ModalModule, _ModalPosition] = findModuleDetailsByExport((e: Export) => e?.toString().includes('.ModalPosition'), 5)
|
||||
|
||||
const ModalModuleProps = ModalModule ? Object.values(ModalModule) : [];
|
||||
|
||||
@@ -114,6 +114,4 @@ export const SimpleModal = ModalModuleProps.find((prop) => {
|
||||
return string?.includes('.ShowPortalModal()') && string?.includes('.OnElementReadyCallbacks.Register(');
|
||||
}) as FC<SimpleModalProps>;
|
||||
|
||||
export const ModalPosition = ModalModuleProps.find((prop) =>
|
||||
prop?.toString().includes('.ModalPosition,fallback:'),
|
||||
) as FC<SimpleModalProps>;
|
||||
export const ModalPosition = _ModalPosition as FC<SimpleModalProps>;
|
||||
|
||||
@@ -22,5 +22,5 @@ export interface PanelSectionRowProps {
|
||||
children?: ReactNode;
|
||||
}
|
||||
export const PanelSectionRow = Object.values(mod).filter(
|
||||
(exp: any) => !exp?.toString()?.includes('.PanelSection'),
|
||||
(exp: any) => !exp?.toString?.()?.includes('.PanelSection'),
|
||||
)[0] as FC<PanelSectionRowProps>;
|
||||
|
||||
@@ -24,11 +24,11 @@ export interface ProgressBarWithInfoProps extends ProgressBarItemProps {
|
||||
}
|
||||
|
||||
export const ProgressBar = findModuleExport((e: Export) =>
|
||||
e?.toString()?.includes('.ProgressBar,"standard"=='),
|
||||
e?.toString?.()?.includes('.ProgressBar,"standard"=='),
|
||||
) as FC<ProgressBarProps>;
|
||||
|
||||
export const ProgressBarWithInfo = findModuleExport((e: Export) =>
|
||||
e?.toString()?.includes('.ProgressBarFieldStatus},'),
|
||||
e?.toString?.()?.includes('.ProgressBarFieldStatus},'),
|
||||
) as FC<ProgressBarWithInfoProps>;
|
||||
|
||||
const progressBarItemRegex = createPropListRegex(["indeterminate", "nTransitionSec", "nProgress"]);
|
||||
|
||||
@@ -29,5 +29,6 @@ export interface SliderFieldProps extends ItemProps {
|
||||
}
|
||||
|
||||
export const SliderField = Object.values(CommonUIModule).find((mod: any) =>
|
||||
mod?.toString()?.includes('SliderField,fallback'),
|
||||
// stable || beta as of oct 2 2024
|
||||
mod?.toString?.()?.includes('SliderField,fallback') || mod?.toString?.()?.includes("SliderField\",")
|
||||
) as FC<SliderFieldProps>;
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
import { FC, ReactNode, createElement, useEffect, useState } from 'react';
|
||||
|
||||
import { fakeRenderComponent, findInReactTree, sleep } from '../utils';
|
||||
import { Export, findModuleByExport } from '../webpack';
|
||||
import { FC, ReactNode } from 'react';
|
||||
import { findModuleByExport } from '../webpack';
|
||||
import { FooterLegendProps } from './FooterLegend';
|
||||
import { SteamSpinner } from './SteamSpinner';
|
||||
|
||||
/**
|
||||
* Individual tab objects for the Tabs component
|
||||
@@ -65,63 +62,9 @@ export interface TabsProps {
|
||||
autoFocusContents?: boolean;
|
||||
}
|
||||
|
||||
let tabsComponent: any;
|
||||
|
||||
const getTabs = async () => {
|
||||
if (tabsComponent) return tabsComponent;
|
||||
// @ts-ignore
|
||||
while (!window?.DeckyPluginLoader?.routerHook?.routes) {
|
||||
console.debug('[DFL:Tabs]: Waiting for Decky router...');
|
||||
await sleep(500);
|
||||
}
|
||||
return (tabsComponent = fakeRenderComponent(
|
||||
() => {
|
||||
return findInReactTree(
|
||||
findInReactTree(
|
||||
// @ts-ignore
|
||||
window.DeckyPluginLoader.routerHook.routes
|
||||
.find((x: any) => x.props.path == '/library/app/:appid/achievements')
|
||||
.props.children.type(),
|
||||
(x) => x?.props?.scrollTabsTop,
|
||||
).type({ appid: 1 }),
|
||||
(x) => x?.props?.tabs,
|
||||
).type;
|
||||
},
|
||||
{
|
||||
useRef: () => ({ current: { reaction: { track: () => {} } } }),
|
||||
useContext: () => ({ match: { params: { appid: 1 } } }),
|
||||
useMemo: () => ({ data: {} }),
|
||||
},
|
||||
));
|
||||
};
|
||||
|
||||
let oldTabs: any;
|
||||
|
||||
try {
|
||||
const oldTabsModule = findModuleByExport((e: Export) => e.Unbleed);
|
||||
if (oldTabsModule)
|
||||
oldTabs = Object.values(oldTabsModule).find((x: any) => x?.type?.toString()?.includes('((function(){'));
|
||||
} catch (e) {
|
||||
console.error('Error finding oldTabs:', e);
|
||||
}
|
||||
const tabsModule = findModuleByExport(e => e?.toString?.()?.includes(".TabRowTabs") && e?.toString?.()?.includes("activeTab:"));
|
||||
|
||||
/**
|
||||
* Tabs component as used in the library and media tabs. See {@link TabsProps}.
|
||||
* Unlike other components in `decky-frontend-lib`, this requires Decky Loader to be running.
|
||||
*/
|
||||
export const Tabs = (oldTabs ||
|
||||
((props: TabsProps) => {
|
||||
const found = tabsComponent;
|
||||
const [tc, setTC] = useState<FC<TabsProps>>(found);
|
||||
useEffect(() => {
|
||||
if (found) return;
|
||||
(async () => {
|
||||
console.debug('[DFL:Tabs]: Finding component...');
|
||||
const t = await getTabs();
|
||||
console.debug('[DFL:Tabs]: Found!');
|
||||
setTC(t);
|
||||
})();
|
||||
}, []);
|
||||
console.log('tc', tc);
|
||||
return tc ? createElement(tc, props) : <SteamSpinner />;
|
||||
})) as FC<TabsProps>;
|
||||
export const Tabs = tabsModule && Object.values(tabsModule).find((e: any) => e?.type?.toString?.()?.includes("((function()")) as FC<TabsProps>;
|
||||
|
||||
@@ -10,5 +10,5 @@ export interface ToggleProps {
|
||||
}
|
||||
|
||||
export const Toggle = Object.values(CommonUIModule).find((mod: any) =>
|
||||
mod?.render?.toString()?.includes('.ToggleOff)'),
|
||||
mod?.render?.toString?.()?.includes('.ToggleOff)'),
|
||||
) as FC<ToggleProps>;
|
||||
|
||||
@@ -11,5 +11,6 @@ export interface ToggleFieldProps extends ItemProps {
|
||||
}
|
||||
|
||||
export const ToggleField = Object.values(CommonUIModule).find((mod: any) =>
|
||||
mod?.render?.toString()?.includes('ToggleField,fallback'),
|
||||
// stable || beta as of oct 2 2024
|
||||
mod?.render?.toString?.()?.includes('ToggleField,fallback') || mod?.render?.toString?.()?.includes("ToggleField\",")
|
||||
) as FC<ToggleFieldProps>;
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { WindowRouter } from '../modules/Router';
|
||||
import { AppDetails, LogoPosition, SteamAppOverview } from './SteamClient';
|
||||
declare global {
|
||||
interface Window {
|
||||
@@ -46,5 +47,11 @@ declare global {
|
||||
GetCustomLogoPosition: (app: SteamAppOverview) => LogoPosition | null;
|
||||
SaveCustomLogoPosition: (app: SteamAppOverview, logoPositions: LogoPosition) => any;
|
||||
};
|
||||
SteamUIStore: {
|
||||
GetFocusedWindowInstance: () => WindowRouter;
|
||||
};
|
||||
securitystore: {
|
||||
IsLockScreenActive: () => boolean;
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { sleep } from '../utils';
|
||||
import Logger from '../logger';
|
||||
import { Export, findModuleExport } from '../webpack';
|
||||
|
||||
export enum SideMenu {
|
||||
@@ -88,14 +88,23 @@ export interface WindowStore {
|
||||
|
||||
export interface Router {
|
||||
WindowStore?: WindowStore;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
CloseSideMenus(): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
Navigate(path: string): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
NavigateToAppProperties(): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
NavigateToExternalWeb(url: string): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
NavigateToInvites(): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
NavigateToChat(): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
NavigateToLibraryTab(): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
NavigateToLayoutPreview(e: unknown): void;
|
||||
/** @deprecated use {@link Navigation} instead */
|
||||
OpenPowerMenu(unknown?: any): void;
|
||||
get RunningApps(): AppOverview[];
|
||||
get MainRunningApp(): AppOverview | undefined;
|
||||
@@ -117,58 +126,58 @@ export interface Navigation {
|
||||
OpenQuickAccessMenu(quickAccessTab?: QuickAccessTab): void;
|
||||
OpenMainMenu(): void;
|
||||
OpenPowerMenu(unknown?: any): void;
|
||||
/** if calling this to perform navigation, call it after Navigate to prevent a race condition in desktop Big Picture mode that hides the overlay unintentionally */
|
||||
CloseSideMenus(): void;
|
||||
}
|
||||
|
||||
export let Navigation = {} as Navigation;
|
||||
|
||||
const logger = new Logger("Navigation");
|
||||
|
||||
try {
|
||||
(async () => {
|
||||
let InternalNavigators: any = {};
|
||||
if (!Router.NavigateToAppProperties || (Router as unknown as any).deckyShim) {
|
||||
function initInternalNavigators() {
|
||||
try {
|
||||
InternalNavigators = findModuleExport((e: Export) => e.GetNavigator && e.SetNavigator)?.GetNavigator();
|
||||
} catch (e) {
|
||||
console.error('[DFL:Router]: Failed to init internal navigators, trying again');
|
||||
}
|
||||
function createNavigationFunction(fncName: string, handler?: (win: any) => any) {
|
||||
return (...args: any) => {
|
||||
let win: WindowRouter | undefined;
|
||||
try {
|
||||
win = window.SteamUIStore.GetFocusedWindowInstance();
|
||||
} catch (e) {
|
||||
logger.warn("Navigation interface failed to call GetFocusedWindowInstance", e);
|
||||
}
|
||||
initInternalNavigators();
|
||||
while (!InternalNavigators?.AppProperties) {
|
||||
console.log('[DFL:Router]: Trying to init internal navigators again');
|
||||
await sleep(2000);
|
||||
initInternalNavigators();
|
||||
if (!win) {
|
||||
logger.warn("Navigation interface could not find any focused window. Falling back to Main Window Instance");
|
||||
win = Router.WindowStore?.GamepadUIMainWindowInstance || Router?.WindowStore?.SteamUIWindows?.[0];
|
||||
}
|
||||
|
||||
if (win) {
|
||||
try {
|
||||
const thisObj = handler && handler(win);
|
||||
(thisObj || win)[fncName](...args);
|
||||
} catch (e) {
|
||||
logger.error("Navigation handler failed", e);
|
||||
}
|
||||
} else {
|
||||
logger.error("Navigation interface could not find a window to navigate");
|
||||
}
|
||||
}
|
||||
const newNavigation = {
|
||||
Navigate: Router.Navigate?.bind(Router),
|
||||
NavigateBack: Router.WindowStore?.GamepadUIMainWindowInstance?.NavigateBack?.bind(
|
||||
Router.WindowStore.GamepadUIMainWindowInstance,
|
||||
),
|
||||
NavigateToAppProperties: InternalNavigators?.AppProperties || Router.NavigateToAppProperties?.bind(Router),
|
||||
NavigateToExternalWeb: InternalNavigators?.ExternalWeb || Router.NavigateToExternalWeb?.bind(Router),
|
||||
NavigateToInvites: InternalNavigators?.Invites || Router.NavigateToInvites?.bind(Router),
|
||||
NavigateToChat: InternalNavigators?.Chat || Router.NavigateToChat?.bind(Router),
|
||||
NavigateToLibraryTab: InternalNavigators?.LibraryTab || Router.NavigateToLibraryTab?.bind(Router),
|
||||
NavigateToLayoutPreview: Router.NavigateToLayoutPreview?.bind(Router),
|
||||
NavigateToSteamWeb: Router.WindowStore?.GamepadUIMainWindowInstance?.NavigateToSteamWeb?.bind(
|
||||
Router.WindowStore.GamepadUIMainWindowInstance,
|
||||
),
|
||||
OpenSideMenu: Router.WindowStore?.GamepadUIMainWindowInstance?.MenuStore.OpenSideMenu?.bind(
|
||||
Router.WindowStore.GamepadUIMainWindowInstance.MenuStore,
|
||||
),
|
||||
OpenQuickAccessMenu: Router.WindowStore?.GamepadUIMainWindowInstance?.MenuStore.OpenQuickAccessMenu?.bind(
|
||||
Router.WindowStore.GamepadUIMainWindowInstance.MenuStore,
|
||||
),
|
||||
OpenMainMenu: Router.WindowStore?.GamepadUIMainWindowInstance?.MenuStore.OpenMainMenu?.bind(
|
||||
Router.WindowStore.GamepadUIMainWindowInstance.MenuStore,
|
||||
),
|
||||
CloseSideMenus: Router.CloseSideMenus?.bind(Router),
|
||||
OpenPowerMenu: Router.OpenPowerMenu?.bind(Router),
|
||||
} as Navigation;
|
||||
}
|
||||
const newNavigation = {
|
||||
Navigate: createNavigationFunction("Navigate"),
|
||||
NavigateBack: createNavigationFunction("NavigateBack"),
|
||||
NavigateToAppProperties: createNavigationFunction("AppProperties", win => win.Navigator),
|
||||
NavigateToExternalWeb: createNavigationFunction("ExternalWeb", win => win.Navigator),
|
||||
NavigateToInvites: createNavigationFunction("Invites", win => win.Navigator),
|
||||
NavigateToChat: createNavigationFunction("Chat", win => win.Navigator),
|
||||
NavigateToLibraryTab: createNavigationFunction("LibraryTab", win => win.Navigator),
|
||||
NavigateToLayoutPreview: Router.NavigateToLayoutPreview?.bind(Router),
|
||||
NavigateToSteamWeb: createNavigationFunction("NavigateToSteamWeb"),
|
||||
OpenSideMenu: createNavigationFunction("OpenSideMenu", win => win.MenuStore),
|
||||
OpenQuickAccessMenu: createNavigationFunction("OpenQuickAccessMenu", win => win.MenuStore),
|
||||
OpenMainMenu: createNavigationFunction("OpenMainMenu", win => win.MenuStore),
|
||||
CloseSideMenus: createNavigationFunction("CloseSideMenus", win => win.MenuStore),
|
||||
OpenPowerMenu: Router.OpenPowerMenu?.bind(Router),
|
||||
} as Navigation;
|
||||
|
||||
Object.assign(Navigation, newNavigation);
|
||||
})();
|
||||
Object.assign(Navigation, newNavigation);
|
||||
} catch (e) {
|
||||
console.error('[DFL:Router]: Error initializing Navigation interface', e);
|
||||
logger.error('Error initializing Navigation interface', e);
|
||||
}
|
||||
|
||||
@@ -25,7 +25,7 @@ export function findSP(): Window {
|
||||
if (document.title == 'SP') return window;
|
||||
// new (SP as popup)
|
||||
const navTrees = getGamepadNavigationTrees();
|
||||
return navTrees?.find((x: any) => x.m_ID == 'root_1_').Root.Element.ownerDocument.defaultView;
|
||||
return navTrees?.find((x: any) => x.m_ID == 'root_1_')?.Root?.Element?.ownerDocument?.defaultView;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -40,6 +40,6 @@ export function getFocusNavController(): any {
|
||||
*/
|
||||
export function getGamepadNavigationTrees(): any {
|
||||
const focusNav = getFocusNavController();
|
||||
const context = focusNav.m_ActiveContext || focusNav.m_LastActiveContext;
|
||||
const context = focusNav?.m_ActiveContext || focusNav?.m_LastActiveContext;
|
||||
return context?.m_rgGamepadNavigationTrees;
|
||||
}
|
||||
|
||||
@@ -52,6 +52,7 @@ export function injectFCTrampoline(component: FC, customHooks?: any): FCTrampoli
|
||||
// we have to redirect this to return an object with component's prototype as a constructor returning a value overrides its prototype
|
||||
window.SP_REACT.createElement = () => {
|
||||
loggingEnabled && logger.debug("createElement hook called");
|
||||
loggingEnabled && console.trace("createElement trace");
|
||||
return Object.create(component.prototype);
|
||||
};
|
||||
}
|
||||
@@ -66,12 +67,16 @@ export function injectFCTrampoline(component: FC, customHooks?: any): FCTrampoli
|
||||
}
|
||||
}
|
||||
|
||||
let renderHookStep = 0;
|
||||
|
||||
// Accessed two times, once directly before class instantiation, and again in some extra logic we don't need to worry about that we hanlde below just in case.
|
||||
Object.defineProperty(component, "contextType", {
|
||||
configurable: true,
|
||||
get: function () {
|
||||
loggingEnabled && logger.debug("get contexttype", this, stubsApplied);
|
||||
applyStubsIfNeeded();
|
||||
loggingEnabled && logger.debug("get contexttype", this, stubsApplied, renderHookStep);
|
||||
loggingEnabled && console.trace("contextType trace");
|
||||
if (renderHookStep == 0) renderHookStep = 1;
|
||||
else if (renderHookStep == 3) renderHookStep = 4;
|
||||
return this._contextType;
|
||||
},
|
||||
set: function (value) {
|
||||
@@ -79,16 +84,20 @@ export function injectFCTrampoline(component: FC, customHooks?: any): FCTrampoli
|
||||
}
|
||||
});
|
||||
|
||||
// Undoes the second contextType access we can't detect shortly before render before it's able to cause any damage
|
||||
Object.defineProperty(component, "getDerivedStateFromProps", {
|
||||
// Always accessed directly after contextType for the path we want to catch.
|
||||
Object.defineProperty(component, "contextTypes", {
|
||||
configurable: true,
|
||||
get: function () {
|
||||
loggingEnabled && logger.debug("get getDerivedStateFromProps", this, stubsApplied);
|
||||
removeStubsIfNeeded();
|
||||
return this._getDerivedStateFromProps;
|
||||
loggingEnabled && logger.debug("get contexttypes", this, stubsApplied, renderHookStep);
|
||||
loggingEnabled && console.trace("contextTypes trace");
|
||||
if (renderHookStep == 1) {
|
||||
renderHookStep = 2;
|
||||
applyStubsIfNeeded();
|
||||
};
|
||||
return this._contextTypes;
|
||||
},
|
||||
set: function (value) {
|
||||
this._getDerivedStateFromProps = value;
|
||||
this._contextTypes = value;
|
||||
}
|
||||
});
|
||||
|
||||
@@ -99,11 +108,32 @@ export function injectFCTrampoline(component: FC, customHooks?: any): FCTrampoli
|
||||
return this._updater;
|
||||
},
|
||||
set: function (value) {
|
||||
loggingEnabled && logger.debug("set updater", this, value, stubsApplied);
|
||||
removeStubsIfNeeded();
|
||||
loggingEnabled && logger.debug("set updater", this, value, stubsApplied, renderHookStep);
|
||||
loggingEnabled && console.trace("updater trace");
|
||||
if (renderHookStep == 2) {
|
||||
renderHookStep = 0;
|
||||
removeStubsIfNeeded();
|
||||
}
|
||||
return this._updater = value;
|
||||
}
|
||||
});
|
||||
|
||||
// Prevents the second contextType+contextTypes access from leaving its hooks around
|
||||
Object.defineProperty(component, "getDerivedStateFromProps", {
|
||||
configurable: true,
|
||||
get: function () {
|
||||
loggingEnabled && logger.debug("get getDerivedStateFromProps", this, stubsApplied, renderHookStep);
|
||||
loggingEnabled && console.trace("getDerivedStateFromProps trace");
|
||||
if (renderHookStep == 2) {
|
||||
renderHookStep = 0;
|
||||
removeStubsIfNeeded();
|
||||
}
|
||||
return this._getDerivedStateFromProps;
|
||||
},
|
||||
set: function (value) {
|
||||
this._getDerivedStateFromProps = value;
|
||||
}
|
||||
});
|
||||
|
||||
return userComponent;
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
import * as React from 'react';
|
||||
import { Ref, useState } from 'react';
|
||||
|
||||
// this shouldn't need to be redeclared but it does for some reason
|
||||
|
||||
@@ -104,19 +105,15 @@ export function wrapReactClass(node: any, prop: any = 'type') {
|
||||
|
||||
export function getReactRoot(o: HTMLElement | Element | Node) {
|
||||
return (
|
||||
// @ts-expect-error 7053
|
||||
o[Object.keys(o).find((k) => k.startsWith('__reactContainer$')) as string] ||
|
||||
// @ts-expect-error 7053
|
||||
o['_reactRootContainer']?._internalRoot?.current
|
||||
(o as any)[Object.keys(o).find((k) => k.startsWith('__reactContainer$')) as string] ||
|
||||
(o as any)['_reactRootContainer']?._internalRoot?.current
|
||||
);
|
||||
}
|
||||
|
||||
export function getReactInstance(o: HTMLElement | Element | Node) {
|
||||
return (
|
||||
// @ts-expect-error 7053
|
||||
o[Object.keys(o).find((k) => k.startsWith('__reactFiber')) as string] ||
|
||||
// @ts-expect-error 7053
|
||||
o[Object.keys(o).find((k) => k.startsWith('__reactInternalInstance')) as string]
|
||||
(o as any)[Object.keys(o).find((k) => k.startsWith('__reactFiber')) as string] ||
|
||||
(o as any)[Object.keys(o).find((k) => k.startsWith('__reactInternalInstance')) as string]
|
||||
);
|
||||
}
|
||||
|
||||
@@ -154,3 +151,21 @@ export const findInReactTree = (node: any, filter: findInTreeFilter) =>
|
||||
// Specialised findInTree for React nodes
|
||||
walkable: ['props', 'children', 'child', 'sibling'],
|
||||
});
|
||||
|
||||
/**
|
||||
* Finds the parent window of a DOM element
|
||||
*/
|
||||
export function getParentWindow<WindowType = Window>(elem: HTMLElement | null): WindowType | null | undefined {
|
||||
return elem?.ownerDocument?.defaultView as any;
|
||||
}
|
||||
|
||||
/**
|
||||
* React hook to find the host window of a component
|
||||
* Pass the returned ref into a React element and window will be its host window.
|
||||
* @returns [ref, window]
|
||||
*/
|
||||
export function useWindowRef<RefElementType extends HTMLElement, WindowType = Window>(): [Ref<RefElementType>, WindowType | null | undefined] {
|
||||
const [win, setWin] = useState<WindowType | null | undefined>(null);
|
||||
|
||||
return [(elem) => setWin(getParentWindow<WindowType>(elem)), win];
|
||||
}
|
||||
Reference in New Issue
Block a user