Skip to content

Commit 7342f59

Browse files
committed
update docs
1 parent b0b7433 commit 7342f59

1 file changed

Lines changed: 16 additions & 73 deletions

File tree

docs/en/guide/webuix/config.md

Lines changed: 16 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -4,83 +4,26 @@ The `WebUIConfig` class defines the configuration settings for the WebUI. Below
44

55
Location: `/data/adb/modules/<ID>/webroot/config.json`
66

7-
## Properties
8-
9-
### `require`
10-
11-
- **Type**: `WebUIConfigRequire`
12-
- **Description**: Specifies the required configuration settings for the WebUI. This includes mandatory parameters needed for the WebUI to function correctly.
13-
- **Default Value**: `WebUIConfigRequire()`
14-
15-
### `permissions`
16-
17-
- **Type**: `List<String>`
18-
- **Description**: A list of permissions required by the WebUI. These permissions are represented as strings.
19-
- **Default Value**: `emptyList()`
20-
21-
### `historyFallback`
22-
23-
- **Type**: `Boolean`
24-
- **Description**: Indicates whether the application should fall back to using history in case of certain failures or conditions.
25-
- **Default Value**: `false`
26-
27-
### `title`
28-
29-
- **Type**: `String?`
30-
- **Description**: The title of the configuration. This is an optional property and can be `null`.
31-
- **Default Value**: `null`
32-
33-
### `icon`
34-
35-
- **Type**: `String?`
36-
- **Description**: The icon associated with the configuration. This is an optional property and can be `null` if no icon is specified.
37-
- **Default Value**: `null`
38-
39-
### `windowResize`
40-
41-
- **Type**: `Boolean`
42-
- **Description**: Indicates whether the application window can be resized. If set to `true`, the window resizing feature is enabled.
43-
- **Default Value**: `true`
44-
45-
### `backHandler`
46-
47-
- **Type**: `Boolean`
48-
- **Description**: Indicates whether the back button handler is enabled. When set to `true`, the application will handle back button presses.
49-
- **Default Value**: `true`
50-
51-
### `exitConfirm`
52-
53-
- **Type**: `Boolean`
54-
- **Description**: Indicates whether a confirmation dialog should be displayed before exiting the application. If set to `true`, the user will be prompted to confirm their action before the application exits.
55-
- **Default Value**: `true`
56-
57-
### `historyFallbackFile`
58-
59-
- **Type**: `String`
60-
- **Description**: The name of the fallback file to be used for history-based routing. Typically used in single-page applications (SPAs) to serve a default file (e.g., "index.html") when a route does not match any static files.
61-
- **Default Value**: `"index.html"`
62-
63-
## Nested Classes
64-
65-
### `WebUIConfigRequire`
66-
67-
- **Description**: Represents the required configuration settings for the WebUI.
68-
- **Properties**:
69-
- `version`: An instance of `WebUIConfigRequireVersion` that specifies the version requirements for the WebUI.
70-
71-
### `WebUIConfigRequireVersion`
72-
73-
- **Description**: Represents the required version configuration for the WebUI.
74-
- **Properties**:
75-
- `required`: Specifies the required value for this configuration. Default is `1`.
76-
- `supportText`: Optional text providing additional support information or guidance. Can be `null`.
77-
- `supportLink`: A nullable string representing the support link. Can be used to provide a URL or contact information for support purposes.
78-
797
## Example Usage
808

81-
```json
9+
```jsonc
8210
{
8311
"require": {
12+
"packages": [
13+
{
14+
/* required */ "code": 33624,
15+
/* required */ "packageName": ["com.dergoogler.mmrl", "com.dergoogler.mmrl.debug"],
16+
"supportText": "Update",
17+
"supportLink": "https://github.com/MMRLApp/MMRL/releases"
18+
},
19+
{
20+
/* required */ "code": 26,
21+
/* required */ "packageName": "com.dergoogler.mmrl.wx",
22+
"supportText": "Update",
23+
"supportLink": "https://github.com/MMRLApp/WebUI-X-Portable/releases"
24+
}
25+
],
26+
// Deprecated
8427
"version": {
8528
"required": 2,
8629
"supportText": "Please update to the latest version.",

0 commit comments

Comments
 (0)