1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-10 11:10:19 +02:00

docs(ModalDialog): add missing documentation for pauseOnOpen (#5908)

This commit is contained in:
mister-ben 2019-04-03 16:46:58 +01:00 committed by Gary Katsevman
parent c030eda294
commit b2eae7bdbf

View File

@ -44,6 +44,10 @@ class ModalDialog extends Component {
* @param {string} [options.label]
* A text label for the modal, primarily for accessibility.
*
* @param {boolean} [options.pauseOnOpen=true]
* If `true`, playback will will be paused if playing when
* the modal opens, and resumed when it closes.
*
* @param {boolean} [options.temporary=true]
* If `true`, the modal can only be opened once; it will be
* disposed as soon as it's closed.