Brightcove Player v5.22.2 Class: ModalDialog

new ModalDialog(player [, options])

Create an instance of this class.

Parameters:

Name Type Argument Description

player

Player

The Player that this class should be attached to.

options

Object

The key/value store of player options.

Properties

Name	Type	Argument	Default	Description
`content`	Mixed	<optional>		Provide customized content for this modal.
`description`	string	<optional>		A text description for the modal, primarily for accessibility.
`fillAlways`	boolean	<optional>	false	Normally, modals are automatically filled only the first time they open. This tells the modal to refresh its content every time it opens.
`label`	string	<optional>		A text label for the modal, primarily for accessibility.
`temporary`	boolean	<optional>	true	If `true`, the modal can only be opened once; it will be disposed as soon as it's closed.
`uncloseable`	boolean	<optional>	false	If `true`, the user will not be able to close the modal through the UI in the normal ways. Programmatic closing is still possible.

Source:: modal-dialog.js

Extends

Component

Methods

$(selector [, context])

Find a single DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Parameters:

Name	Type	Argument	Default	Description
`selector`	string			A valid CSS selector, which will be passed to `querySelector`.
`context`	Element \| string	<optional>	this.contentEl()	A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing `this.contentEl()` gets used. If `this.contentEl()` returns nothing it falls back to `document`.

Inherited From:

Component#$

Source:

component.js

See:

Information on CSS Selectors

Returns:

the dom element that was found, or null

Type: Element | null

$$(selector [, context])

Finds all DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Parameters:

Name	Type	Argument	Default	Description
`selector`	string			A valid CSS selector, which will be passed to `querySelectorAll`.
`context`	Element \| string	<optional>	this.contentEl()	A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing `this.contentEl()` gets used. If `this.contentEl()` returns nothing it falls back to `document`.

Inherited From:

Component#$$

Source:

component.js

See:

Information on CSS Selectors

Returns:

a list of dom elements that were found

Type: NodeList

addChild(child [, options] [, index])

Add a child Component inside the current Component.

Parameters:

Name	Type	Argument	Default	Description
`child`	string \| Component			The name or instance of a child to add.
`options`	Object	<optional>	{}	The key/value store of options that will get passed to children of the child.
`index`	number	<optional>	this.children_.length	The index to attempt to add a child into.

Inherited From:

Component#addChild

Source:

component.js

Returns:

The Component that gets added as a child. When using a string the Component will get created by this process.

Type: Component

addClass(classToAdd)

Add a CSS class name to the Components element.

Parameters:

Name	Type	Description
`classToAdd`	string	CSS class name to add

Inherited From:

Component#addClass

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

blur()

Remove the focus from this component

Inherited From:

Component#blur

Source:

component.js

buildCSSClass()

Builds the default DOM className.

Overrides:

Component#buildCSSClass

Source:

modal-dialog.js

Returns:

The DOM className for this object.

Type: string

children()

Get an array of all child components

Inherited From:

Component#children

Source:

component.js

Returns:

The children

Type: Array

clearInterval(intervalId)

Clears an interval that gets created via window.setInterval or Component#setInterval. If you set an inteval via Component#setInterval use this function instead of window.clearInterval. If you don't your dispose listener will not get cleaned up until Component#dispose!

Parameters:

Name	Type	Description
`intervalId`	number	The id of the interval to clear. The return value of Component#setInterval or `window.setInterval`.

Inherited From:

Component#clearInterval

Source:

component.js

See:

Similar to

Returns:

Returns the interval id that was cleared.

Type: number

clearTimeout(timeoutId)

Clears a timeout that gets created via window.setTimeout or Component#setTimeout. If you set a timeout via Component#setTimeout use this function instead of window.clearTimout. If you don't your dispose listener will not get cleaned up until Component#dispose!

Parameters:

Name	Type	Description
`timeoutId`	number	The id of the timeout to clear. The return value of Component#setTimeout or `window.setTimeout`.

Inherited From:

Component#clearTimeout

Source:

component.js

See:

Similar to

Returns:

Returns the timeout id that was cleared.

Type: number

close()

Closes the modal, does nothing if the ModalDialog is not open.

Source:: modal-dialog.js

Fires:

Returns:

Returns itself; method can be chained.

Type: ModalDialog

closeable( [value])

Check to see if the ModalDialog is closeable via the UI.

Parameters:

Name	Type	Argument	Description
`value`	boolean	<optional>	If given as a boolean, it will set the `closeable` option.

Source:: modal-dialog.js

Returns:

Returns the final value of the closable option.

Type: boolean

content( [value])

Gets or sets the modal content, which gets normalized before being rendered into the DOM.

This does not update the DOM or fill the modal, but it is called during that process.

Parameters:

Name	Type	Argument	Description
`value`	Mixed	<optional>	If defined, sets the internal content value to be used on the next call(s) to `fill`. This value is normalized before being inserted. To "clear" the internal content value, pass `null`.

Source:: modal-dialog.js

Returns:

The current content of the modal dialog

Type: Mixed

contentEl()

Return the Components DOM element. This is where children get inserted. This will usually be the the same as the element returned in Component#el.

Inherited From:

Component#contentEl

Source:

component.js

Returns:

The content element for this Component.

Type: Element

createEl()

Create the ModalDialog's DOM element

Overrides:

Component#createEl

Source:

modal-dialog.js

Returns:

The DOM element that gets created.

Type: Element

currentDimension(widthOrHeight)

Get the width or the height of the Component elements computed style. Uses window.getComputedStyle.

Parameters:

Name	Type	Description
`widthOrHeight`	string	A string containing 'width' or 'height'. Whichever one you want to get.

Inherited From:

Component#currentDimension

Source:

component.js

Returns:

The dimension that gets asked for or 0 if nothing was set for that dimension.

Type: number

currentDimensions()

Get an object that contains width and height values of the Components computed style.

Inherited From:

Component#currentDimensions

Source:

component.js

Returns:

The dimensions of the components element

Type: Component~DimensionObject

currentHeight()

Get the height of the Components computed style. Uses window.getComputedStyle.

Inherited From:

Component#currentHeight

Source:

component.js

Returns:

height The height of the Components computed style.

Type: number

currentWidth()

Get the width of the Components computed style. Uses window.getComputedStyle.

Inherited From:

Component#currentWidth

Source:

component.js

Returns:

width The width of the Components computed style.

Type: number

description()

Returns the description string for this modal. Primarily used for accessibility.

Source:: modal-dialog.js

Returns:

The localized or raw description of this modal.

Type: string

dimension(widthOrHeight [, num] [, skipListeners])

Get or set width or height of the Component element. This is the shared code for the Component#width and Component#height.

Things to know:

If the width or height in an number this will return the number postfixed with 'px'.
If the width/height is a percent this will return the percent postfixed with '%'
Hidden elements have a width of 0 with window.getComputedStyle. This function defaults to the Components style.width and falls back to window.getComputedStyle. See this for more information
If you want the computed style of the component, use Component#currentWidth and {Component#currentHeight

Parameters:

Name	Type	Argument	Description
`widthOrHeight`	string		8 'width' or 'height'
`num`	number \| string	<optional>	8 New dimension
`skipListeners`	boolean	<optional>	Skip resize event trigger

Inherited From:

Component#dimension

Source:

component.js

Fires:

Component#event:resize

Returns:

the dimension when getting or 0 if unset

  - Returns itself when setting; method can be chained.

Type: Component

dimensions(width, height)

Set both the width and height of the Component element at the same time.

Parameters:

Name	Type	Description
`width`	number \| string	Width to set the `Component`s element to.
`height`	number \| string	Height to set the `Component`s element to.

Inherited From:

Component#dimensions

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

dispose()

Dispose of the Component and all child components.

Inherited From:

Component#dispose

Source:

component.js

Fires:

Component#event:dispose

el()

Get the Components DOM element

Inherited From:

Component#el

Source:

component.js

Returns:

The DOM element for this Component.

Type: Element

empty()

Empties the content element. This happens anytime the modal is filled.

Source:: modal-dialog.js

Fires:

Returns:

Returns itself; method can be chained.

Type: ModalDialog

enableTouchActivity()

This function reports user activity whenever touch events happen. This can get turned off by any sub-components that wants touch events to act another way.

Report user touch activity when touch events occur. User activity gets used to determine when controls should show/hide. It is simple when it comes to mouse events, because any mouse event should show the controls. So we capture mouse events that bubble up to the player and report activity when that happens. With touch events it isn't as easy as touchstart and touchend toggle player controls. So touch events can't help us at the player level either.

User activity gets checked asynchronously. So what could happen is a tap event on the video turns the controls off. Then the touchend event bubbles up to the player. Which, if it reported user activity, would turn the controls right back on. We also don't want to completely block touch events from bubbling up. Furthermore a touchmove event and anything other than a tap, should not turn controls back on.

Inherited From:

Component#enableTouchActivity

Source:

component.js

Listens to Events:

Component#event:touchstart
Component#event:touchmove
Component#event:touchend
Component#event:touchcancel

fill()

Fill the modal's content element with the modal's "content" option. The content element will be emptied before this change takes place.

Source:: modal-dialog.js

Returns:

Returns itself; method can be chained.

Type: ModalDialog

fillWith( [content])

Fill the modal's content element with arbitrary content. The content element will be emptied before this change takes place.

Parameters:

Name	Type	Argument	Description
`content`	Mixed	<optional>	The same rules apply to this as apply to the `content` option.

Source:: modal-dialog.js

Fires:

Returns:

Returns itself; method can be chained.

Type: ModalDialog

focus()

Set the focus to this component

Inherited From:

Component#focus

Source:

component.js

getAttribute(attribute)

Get the value of an attribute on the Components element.

Parameters:

Name	Type	Description
`attribute`	string	Name of the attribute to get the value from.

Inherited From:

Component#getAttribute

Source:

component.js

See:

DOM API

Returns:

The value of the attribute that was asked for.

  - Can be an empty string on some browsers if the attribute does not exist
    or has no value
  - Most browsers will return null if the attibute does not exist or has
    no value.

Type: string | null

getChild(name)

Returns the child Component with the given name.

Parameters:

Name	Type	Description
`name`	string	The name of the child `Component` to get.

Inherited From:

Component#getChild

Source:

component.js

Returns:

The child Component with the given name or undefined.

Type: Component | undefined

getChildById(id)

Returns the child Component with the given id.

Parameters:

Name	Type	Description
`id`	string	The id of the child `Component` to get.

Inherited From:

Component#getChildById

Source:

component.js

Returns:

The child Component with the given id or undefined.

Type: Component | undefined

handleKeyPress(e)

Handles keydown events on the document, looking for ESC, which closes the modal.

Parameters:

Name	Type	Description
`e`	EventTarget~Event	The keypress that triggered this event.

Source:: modal-dialog.js

Listens to Events:

event:keydown

hasClass(classToCheck)

Check if a component's element has a CSS class name.

Parameters:

Name	Type	Description
`classToCheck`	string	CSS class name to check.

Inherited From:

Component#hasClass

Source:

component.js

Returns:

True if the Component has the class.

  - False if the `Component` does not have the class`

Type: boolean

height( [num] [, skipListeners])

Get or set the height of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:

Name	Type	Argument	Description
`num`	number \| string	<optional>	The height that you want to set postfixed with '%', 'px' or nothing.
`skipListeners`	boolean	<optional>	Skip the resize event trigger

Inherited From:

Component#height

Source:

component.js

Returns:

The width when getting, zero if there is no width. Can be a string

    postpixed with '%' or 'px'.
  - Returns itself when setting; method can be chained.

Type: Component | number | string

hide()

Hide the Components element if it is currently showing by adding the 'vjs-hidden` class name to it.

Inherited From:

Component#hide

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

id()

Get this Components ID

Inherited From:

Component#id

Source:

component.js

Returns:

The id of this Component

Type: string

initChildren()

Add and initialize default child Components based upon options.

Inherited From:

Component#initChildren

Source:

component.js

label()

Returns the label string for this modal. Primarily used for accessibility.

Source:: modal-dialog.js

Returns:

the localized or raw label of this modal.

Type: string

localize(string)

Localize a string given the string in english.

Parameters:

Name	Type	Description
`string`	string	The string to localize.

Inherited From:

Component#localize

Source:

component.js

Returns:

The localized string or if no localization exists the english string.

Type: string

name()

Get the Components name. The name gets used to reference the Component and is set during registration.

Inherited From:

Component#name

Source:

component.js

Returns:

The name of this Component.

Type: string

off( [first] [, second] [, third])

Remove an event listener from this Components element. If the second argument is exluded all listeners for the type passed in as the first argument will be removed.

Parameters:

Name	Type	Argument	Description
`first`	string \| Component \| Array.<string>	<optional>	The event name, and array of event names, or another `Component`.
`second`	EventTarget~EventListener \| string \| Array.<string>	<optional>	The listener function, an event name, or an Array of events names.
`third`	EventTarget~EventListener	<optional>	The event handler if `first` is a `Component` and `second` is an event name or an Array of event names.

Inherited From:

Component#off

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

on( [first] [, second] [, third])

Add an event listener to this Components element.

The benefit of using this over the following:

VjsEvents.on(otherElement, 'eventName', myFunc)
otherComponent.on('eventName', myFunc)
Is that the listeners will get cleaned up when either component gets disposed.

It will also bind myComponent as the context of myFunc.

NOTE: If you remove the element from the DOM that has used on you need to

 clean up references using: `myComponent.trigger(el, 'dispose')`
 This will also allow the browser to garbage collect it. In special
 cases such as with `window` and `document`, which are both permanent,
 this is not necessary.

Parameters:

Name	Type	Argument	Description
`first`	string \| Component \| Array.<string>	<optional>	The event name, and array of event names, or another `Component`.
`second`	EventTarget~EventListener \| string \| Array.<string>	<optional>	The listener function, an event name, or an Array of events names.
`third`	EventTarget~EventListener	<optional>	The event handler if `first` is a `Component` and `second` is an event name or an Array of event names.

Inherited From:

Component#on

Source:

component.js

Listens to Events:

Component#event:dispose

Returns:

Returns itself; method can be chained.

Type: Component

one( [first] [, second] [, third])

Add an event listener that gets triggered only once and then gets removed.

Parameters:

Name	Type	Argument	Description
`first`	string \| Component \| Array.<string>	<optional>	The event name, and array of event names, or another `Component`.
`second`	EventTarget~EventListener \| string \| Array.<string>	<optional>	The listener function, an event name, or an Array of events names.
`third`	EventTarget~EventListener	<optional>	The event handler if `first` is a `Component` and `second` is an event name or an Array of event names.

Inherited From:

Component#one

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

open()

Opens the modal.

Source:: modal-dialog.js

Fires:

Returns:

Returns itself; method can be chained.

Type: ModalDialog

opened( [value])

If the ModalDialog is currently open or closed.

Parameters:

Name	Type	Argument	Description
`value`	boolean	<optional>	If given, it will open (`true`) or close (`false`) the modal.

Source:: modal-dialog.js

Returns:

the current open state of the modaldialog

Type: boolean

options(obj)

Deep merge of options objects with new options.

Note: When both obj and options contain properties whose values are objects. The two properties get merged using module:mergeOptions

Parameters:

Name	Type	Description
`obj`	Object	The object that contains new options.

Inherited From:

Component#options

Deprecated:

since version 5

Source:

component.js

Returns:

A new object of this.options_ and obj merged together.

Type: Object

player()

Return the Player that the Component has attached to.

Inherited From:

Component#player

Source:

component.js

Returns:

The player that this Component has attached to.

Type: Player

ready(fn [, sync])

Bind a listener to the component's ready state. If the ready event has already happened it will trigger the function immediately.

Parameters:

Name	Type	Argument	Default	Description
`fn`	Component~ReadyCallback			A function to call when ready is triggered.
`sync`	boolean	<optional>	false	Execute the listener synchronously if `Component` is ready.

Inherited From:

Component#ready

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

removeAttribute(attribute)

Remove an attribute from the Components element.

Parameters:

Name	Type	Description
`attribute`	string	Name of the attribute to remove.

Inherited From:

Component#removeAttribute

Source:

component.js

See:

DOM API

Returns:

Returns itself; method can be chained.

Type: Component

removeChild(component)

Remove a child Component from this Components list of children. Also removes the child Components element from this Components element.

Parameters:

Name	Type	Description
`component`	Component	The child `Component` to remove.

Inherited From:

Component#removeChild

Source:

component.js

removeClass(classToRemove)

Remove a CSS class name from the Components element.

Parameters:

Name	Type	Description
`classToRemove`	string	CSS class name to remove

Inherited From:

Component#removeClass

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

setAttribute(attribute, value)

Set the value of an attribute on the Component's element

Parameters:

Name	Type	Description
`attribute`	string	Name of the attribute to set.
`value`	string	Value to set the attribute to.

Inherited From:

Component#setAttribute

Source:

component.js

See:

DOM API

Returns:

Returns itself; method can be chained.

Type: Component

setInterval(fn, interval)

Creates a function that gets run every x milliseconds. This function is a wrapper around window.setInterval. There are a few reasons to use this one instead though.

It gets cleared via Component#clearInterval when Component#dispose gets called.
The function callback will be a Component~GenericCallback

Parameters:

Name	Type	Description
`fn`	Component~GenericCallback	The function to run every `x` seconds.
`interval`	number	Execute the specified function every `x` milliseconds.

Inherited From:

Component#setInterval

Source:

component.js

See:

Similar to

Listens to Events:

Component#event:dispose

Returns:

Returns an id that can be used to identify the interval. It can also be be used in Component#clearInterval to clear the interval.

Type: number

setTimeout(fn, timeout)

Creates a function that runs after an x millisecond timeout. This function is a wrapper around window.setTimeout. There are a few reasons to use this one instead though:

It gets cleared via Component#clearTimeout when Component#dispose gets called.
The function callback will gets turned into a Component~GenericCallback

Note: You can use window.clearTimeout on the id returned by this function. This will cause its dispose listener not to get cleaned up! Please use Component#clearTimeout or Component#dispose.

Parameters:

Name	Type	Description
`fn`	Component~GenericCallback	The function that will be run after `timeout`.
`timeout`	number	Timeout in milliseconds to delay before executing the specified function.

Inherited From:

Component#setTimeout

Source:

component.js

See:

Similar to

Listens to Events:

Component#event:dispose

Returns:

Returns a timeout ID that gets used to identify the timeout. It can also get used in Component#clearTimeout to clear the timeout that was set.

Type: number

show()

Show the Components element if it is hidden by removing the 'vjs-hidden' class name from it.

Inherited From:

Component#show

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

toggleClass(classToToggle [, predicate])

Add or remove a CSS class name from the component's element.

classToToggle gets added when Component#hasClass would return false.
classToToggle gets removed when Component#hasClass would return true.

Parameters:

Name	Type	Argument	Description
`classToToggle`	string		The class to add or remove based on (@link Component#hasClass}
`predicate`	boolean \| Dom~predicate	<optional>	An Dom~predicate function or a boolean

Inherited From:

Component#toggleClass

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

trigger(event [, hash])

Trigger an event on an element.

Parameters:

Name	Type	Argument	Description
`event`	EventTarget~Event \| Object \| string		The event name, and Event, or an event-like object with a type attribute set to the event name.
`hash`	Object	<optional>	Data hash to pass along with the event

Inherited From:

Component#trigger

Source:

component.js

Returns:

Returns itself; method can be chained.

Type: Component

triggerReady()

Trigger all the ready listeners for this Component.

Inherited From:

Component#triggerReady

Source:

component.js

Fires:

Component#event:ready

width( [num] [, skipListeners])

Get or set the width of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:

Name	Type	Argument	Description
`num`	number \| string	<optional>	The width that you want to set postfixed with '%', 'px' or nothing.
`skipListeners`	boolean	<optional>	Skip the resize event trigger

Inherited From:

Component#width

Source:

component.js

Returns:

The width when getting, zero if there is no width. Can be a string

    postpixed with '%' or 'px'.
  - Returns itself when setting; method can be chained.

Type: Component | number | string

Events

beforemodalclose

Fired just before a ModalDialog is closed.

Type: EventTarget~Event

Source:: modal-dialog.js

beforemodalempty

Fired just before a ModalDialog is emptied.

Type: EventTarget~Event

Source:: modal-dialog.js

beforemodalfill

Fired just before a ModalDialog is filled with content.

Type: EventTarget~Event

Source:: modal-dialog.js

beforemodalopen

Fired just before a ModalDialog is opened.

Type: EventTarget~Event

Source:: modal-dialog.js

dispose

Triggered when a Component is disposed.

Type: EventTarget~Event

Properties:

Name	Type	Argument	Default	Description
`bubbles`	boolean	<optional>	false	set to false so that the close event does not bubble up

Inherited From:

Component#event:dispose

Source:

component.js

modalclose

Fired just after a ModalDialog is closed.

Type: EventTarget~Event

Source:: modal-dialog.js

modalempty

Fired just after a ModalDialog is emptied.

Type: EventTarget~Event

Source:: modal-dialog.js

modalfill

Fired just after a ModalDialog is filled with content.

Type: EventTarget~Event

Source:: modal-dialog.js

modalopen

Fired just after a ModalDialog is opened.

Type: EventTarget~Event

Source:: modal-dialog.js

ready

Triggered when a Component is ready.

Type: EventTarget~Event

Inherited From:

Component#event:ready

Source:

component.js

resize

Triggered when a component is resized.

Type: EventTarget~Event

Inherited From:

Component#event:resize

Source:

component.js

tap

Triggered when a Component is tapped.

Type: EventTarget~Event

Inherited From:

Component#event:tap

Source:

component.js