fix(docs): update language and formatting in documentation; remove danmuku plugin file

This commit is contained in:
Harvey Zhao committed 2025-11-29 22:26:42 +08:00
1 parent 47085d1275
commit 86bbc95722
13 files changed
+404 -824

No files matched your search

@@ -1,18 +1,18 @@
# Controllers
# Controls
## Configuration
| Property | Type | Description |
| ----------- | ------------------- | ------------------------------------------------ |
| `disable` | `Boolean` | Whether to disable the component |
| `name` | `String` | Unique component name for CSS class identification |
| `index` | `Number` | Component index for display priority |
| `html` | `String`, `Element` | Component DOM element |
| `style` | `Object` | Component style object |
| `click` | `Function` | Component click event |
| `mounted` | `Function` | Triggered after component mounting |
| `tooltip` | `String` | Component tooltip text |
| `position` | `String` | `left` and `right` control controller placement |
| `disable` | `Boolean` | Whether to disable the control |
| `name` | `String` | Unique control name for CSS class identification |
| `index` | `Number` | Control index for display priority |
| `html` | `String`, `Element` | Control's DOM element |
| `style` | `Object` | Control style object |
| `click` | `Function` | Control click event handler |
| `mounted` | `Function` | Triggered after control is mounted |
| `tooltip` | `String` | Control tooltip text |
| `position` | `String` | `left` or `right` - controls display position |
| `selector` | `Array` | Array of selector list objects |
| `onSelect` | `Function` | Function triggered when selector item is clicked |
@@ -67,7 +67,7 @@ console.info(art.controls['your-button']);
console.info(art.controls['subtitle']);
```
## Addition
## Adding
<div className="run-code">▶ Run Code</div>
@@ -128,7 +128,7 @@ art.on('ready', () => {
});
```
## Update
## Updating
<div className="run-code">▶ Run Code</div>
@@ -1,16 +1,16 @@
# Business Layer
# Layer
## Configuration
| Property | Type | Description |
| --------- | ------------------- | ------------------------------------ |
| `disable` | `Boolean` | Whether to disable the component |
| `name` | `String` | Unique component name for class marking |
| `name` | `String` | Unique component name for CSS class |
| `index` | `Number` | Component index for display priority |
| `html` | `String`, `Element` | Component DOM element |
| `style` | `Object` | Component style object |
| `click` | `Function` | Component click event |
| `mounted` | `Function` | Triggered after component mounting |
| `mounted` | `Function` | Triggered after component mount |
| `tooltip` | `String` | Component tooltip text |
## Creation
@@ -18,15 +18,15 @@ var art = new Artplayer({
});
```
## Create - Button
## Creating - Buttons
| Property | Type | Description |
| ---------- | ------------------- | -------------------- |
| `html` | `String`, `Element` | Element DOM |
| `icon` | `String`, `Element` | Element icon |
| Property | Type | Description |
| --------- | ------------------- | -------------------- |
| `html` | `String`, `Element` | Element DOM |
| `icon` | `String`, `Element` | Element icon |
| `onClick` | `Function` | Element click event |
| `width` | `Number` | List width |
| `tooltip` | `String` | Tooltip text |
| `width` | `Number` | List width |
| `tooltip` | `String` | Tooltip text |
<div className="run-code">▶ Run Code</div>
@@ -49,16 +49,16 @@ var art = new Artplayer({
});
```
## Create - Selector List
## Creating - Selection Lists
| Property | Type | Description |
| ---------- | ------------------- | -------------------- |
| `html` | `String`, `Element` | Element DOM |
| `icon` | `String`, `Element` | Element icon |
| `selector` | `Array` | Element list |
| `onSelect` | `Function` | Element click event |
| `width` | `Number` | List width |
| `tooltip` | `String` | Tooltip text |
| Property | Type | Description |
| --------- | ------------------- | -------------------- |
| `html` | `String`, `Element` | Element DOM |
| `icon` | `String`, `Element` | Element icon |
| `selector`| `Array` | Element list |
| `onSelect`| `Function` | Element click event |
| `width` | `Number` | List width |
| `tooltip` | `String` | Tooltip text |
<div className="run-code">▶ Run Code</div>
@@ -118,7 +118,7 @@ var art = new Artplayer({
});
```
## Create - Nested List
## Creating - Nested Lists
<div className="run-code">▶ Run Code</div>