mirror of
https://github.com/SteamDeckHomebrew/decky-frontend-lib.git
synced 2026-05-23 11:28:48 +02:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d46251bb91 | ||
|
|
5b29447cfa | ||
|
|
e993d06963 | ||
|
|
a3c136a07e | ||
|
|
994b9e2cc6 |
14
CHANGELOG.md
14
CHANGELOG.md
@@ -1,3 +1,17 @@
|
|||||||
|
# [1.3.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.4...v1.3.0) (2022-08-02)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **plugin:** api for patching existing routes ([5b29447](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/5b29447cfa597773a81aa233da9362346683505d))
|
||||||
|
|
||||||
|
## [1.2.4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.3...v1.2.4) (2022-07-25)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **Modal:** add closeModal ([994b9e2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/994b9e2cc6f41da3d813e6f339bd2fd30e4fa3ad))
|
||||||
|
|
||||||
## [1.2.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.2...v1.2.3) (2022-07-25)
|
## [1.2.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.2...v1.2.3) (2022-07-25)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
26
README.md
26
README.md
@@ -1 +1,27 @@
|
|||||||
# Decky Frontend Library
|
# Decky Frontend Library
|
||||||
|
|
||||||
|
Library used to develop plugins used for use with [decky-loader](https://github.com/SteamDeckHomebrew/decky-loader).
|
||||||
|
|
||||||
|
## Decky Loader Discord [](https://discord.gg/ZU74G2NJzk)
|
||||||
|
|
||||||
|
Please contact the developers here for questions and support that cannot be addressed via a Github issue.
|
||||||
|
|
||||||
|
## Developers and Contributors
|
||||||
|
|
||||||
|
This library is focused on usage by developers to provide custom React components based on those found in the Steam Deck's React UI.
|
||||||
|
This method allows developers to add UI elements and code without clobbering the existing UI of the deck in order to do so.
|
||||||
|
This library can also theoretically be used to extend existing UI elements of the Steam Deck UI but this has not been tested extensively.
|
||||||
|
|
||||||
|
### Getting Started (Contributors)
|
||||||
|
|
||||||
|
1. Clone the repository to your preferred location
|
||||||
|
2. If you wish to add features such as new UI components, please create a feature branch to PR to the original repo.
|
||||||
|
3. Bug/hotfixes are acceptable on the main branch,
|
||||||
|
|
||||||
|
### Getting Started (Developers)
|
||||||
|
|
||||||
|
If you would like a feature added to decky-frontend-lib, please request it via a Github issue.
|
||||||
|
|
||||||
|
If you want to start making a plugin with decky-frontend-lib, please direct your attention to the [decky-plugin-template](https://github.com/SteamDeckHomebrew/decky-plugin-template) repository.
|
||||||
|
|
||||||
|
This library can be found on [npm](https://www.npmjs.com/package/decky-frontend-lib) and as such you can pull it without a local copy for your project as needed.
|
||||||
|
|||||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "decky-frontend-lib",
|
"name": "decky-frontend-lib",
|
||||||
"version": "1.2.3",
|
"version": "1.3.0",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "decky-frontend-lib",
|
"name": "decky-frontend-lib",
|
||||||
"version": "1.2.3",
|
"version": "1.3.0",
|
||||||
"hasInstallScript": true,
|
"hasInstallScript": true,
|
||||||
"license": "GPL-2.0-or-later",
|
"license": "GPL-2.0-or-later",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "decky-frontend-lib",
|
"name": "decky-frontend-lib",
|
||||||
"version": "1.2.3",
|
"version": "1.3.0",
|
||||||
"description": "A library for building decky plugins",
|
"description": "A library for building decky plugins",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ export interface ModalRootProps {
|
|||||||
onCancel?(): void;
|
onCancel?(): void;
|
||||||
onOK?(): void;
|
onOK?(): void;
|
||||||
onEscKeypress?(): void;
|
onEscKeypress?(): void;
|
||||||
|
closeModal?(): void;
|
||||||
className?: string;
|
className?: string;
|
||||||
modalClassName?: string;
|
modalClassName?: string;
|
||||||
bAllowFullSize?: boolean;
|
bAllowFullSize?: boolean;
|
||||||
|
|||||||
@@ -20,8 +20,12 @@ interface ServerResponseError {
|
|||||||
|
|
||||||
type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
|
type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
|
||||||
|
|
||||||
|
type RoutePatch = (route: RouteProps) => RouteProps;
|
||||||
|
|
||||||
interface RouterHook {
|
interface RouterHook {
|
||||||
addRoute(path: string, component: ComponentType, props?: Omit<RouteProps, 'path' | 'children'>): void;
|
addRoute(path: string, component: ComponentType, props?: Omit<RouteProps, 'path' | 'children'>): void;
|
||||||
|
addPatch(path: string, patch: RoutePatch): RoutePatch;
|
||||||
|
removePatch(path: string, patch: RoutePatch): void;
|
||||||
removeRoute(path: string): void;
|
removeRoute(path: string): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user