Skip to content

Commit f344578

Browse files
committed
docs: update title docs
1 parent b5f4943 commit f344578

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

packages/mux-player-react/REFERENCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
| `hotkeys` | `string` (space separated enum list) | Similar to `className`, a space-separated string blocklist of keyboard shortcuts (hotkeys) you want to disable. Based on [Media Chrome's implementation](https://media-chrome-docs.vercel.app/en/keyboard-shortcuts) | `''` |
1818
| `nohotkeys` | `boolean` | Toggles keyboard shortcut (hot keys) support when focus in inside the player | `false` |
1919
| `thumbnailTime` | `number` (seconds) | [Time offset](https://docs.mux.com/guides/video/get-images-from-a-video#thumbnail-query-string-parameters) for the default `poster` image based on your `playback-id`. If no `thumbnail-time` is specified, `start-time` will be used by default. NOTE: This feature currently cannot be used with `token.thumbnail`. | `0` |
20-
| `title` (**deprecated**) | `string` | Title text to show for your content in the Mux Player UI. (**deprecated**: Use `videoTitle` instead. In most browsers the `title` attribute causes a tooltip on hover which is undesired hence in the next major Mux player version `title` will not cause any Mux player UI changes anymore. Only the native browser behavior will be kept.) | `""` |
20+
| `title` | `string` | Title text to show for your content in the Mux Player UI. (In most browsers the `title` property causes a tooltip on hover which is sometimes undesired. Use `videoTitle` to only show the title in the Mux player UI and not the tooltip.) | `""` |
2121
| `videoTitle` | `string` | Title text to show for your content in the Mux Player UI. | `""` |
2222
| `placeholder` | `string` (URI) | Image to show as various assets load. Typically a [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs) when used | N/A |
2323
| `primaryColor` | `string` (Any valid CSS color style) | The primary color used by the player's UI | `undefined` |

packages/mux-player/REFERENCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
| `hotkeys` | [`DOMTokenList`](https://developer.mozilla.org/en-US/docs/Web/API/DOMTokenList) (space separated enum list) | A blocklist of keyboard shortcuts (hotkeys) you want to disable. Based on [Media Chrome's implementation](https://media-chrome-docs.vercel.app/en/keyboard-shortcuts) | N/A |
5353
| `playbackrates` | `number[]` (space separated list) | A space separated string of playback rates used by the playback rate button. | N/A |
5454
| `default-show-remaining-time` | `boolean` | Show remaining playback time (instead of current playback time) by default | `false` |
55-
| `title` (**deprecated**) | `string` | Title text to show for your content in the Mux Player UI. (**deprecated**: Use `video-title` instead. In most browsers the `title` attribute causes a tooltip on hover which is undesired hence in the next major Mux player version `title` will not cause any Mux player UI changes anymore. Only the native browser behavior will be kept.) | `""` |
55+
| `title` | `string` | Title text to show for your content in the Mux Player UI. (In most browsers the `title` attribute causes a tooltip on hover which is sometimes undesired. Use `video-title` to only show the title in the Mux player UI and not the tooltip.) | `""` |
5656
| `video-title` | `string` | Title text to show for your content in the Mux Player UI. | `""` |
5757
| `placeholder` | `string` (URI) | Image to show as various assets load. Typically a [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs) when used | N/A |
5858
| `cast-receiver` | `string` (Receiver ID) | The app ID to use for a custom [Google cast receiver](https://developers.google.com/cast/docs/web_receiver/basic). If none is provided, the default receiver app will be used. | N/A |
@@ -114,7 +114,7 @@
114114
| `hotkeys` <sub><sup>Read only\*</sup></sub> | [`DOMTokenList`](https://developer.mozilla.org/en-US/docs/Web/API/DOMTokenList) | A `DOMTokenList` (similar to [`classList`](https://developer.mozilla.org/en-US/docs/Web/API/Element/classList)) blocklist of keyboard shortcuts (hotkeys) you want to disable. Based on [Media Chrome's implementation](https://media-chrome-docs.vercel.app/en/keyboard-shortcuts) | `''` |
115115
| `nohotkeys` | `boolean` | Toggles keyboard shortcut (hot keys) support when focus in inside the player | `false` |
116116
| `thumbnailTime` | `number` (seconds) | [Time offset](https://docs.mux.com/guides/video/get-images-from-a-video#thumbnail-query-string-parameters) for the default `poster` image based on your `playback-id`. If no `thumbnail-time` is specified, `start-time` will be used by default. NOTE: This feature currently cannot be used with `thumbnail-token`. | `0` |
117-
| `title` (**deprecated**) | `string` | Title text to show for your content in the Mux Player UI. (**deprecated**: Use `videoTitle` instead. In most browsers the `title` attribute causes a tooltip on hover which is undesired hence in the next major Mux player version `title` will not cause any Mux player UI changes anymore. Only the native browser behavior will be kept.) | `""` |
117+
| `title` | `string` | Title text to show for your content in the Mux Player UI. (In most browsers the `title` property causes a tooltip on hover which is sometimes undesired. Use `videoTitle` to only show the title in the Mux player UI and not the tooltip.) | `""` |
118118
| `videoTitle` | `string` | Title text to show for your content in the Mux Player UI. | `""` |
119119
| `placeholder` | `string` (URI) | Image to show as various assets load. Typically a [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs) when used | N/A |
120120
| `primaryColor` | `string` (Any valid CSS color style) | The primary color used by the player's UI | `undefined` |

0 commit comments

Comments
 (0)