new MediaFrame()
wp.media.view.MediaFrame
The frame used to create the media modal.
- Mixes In:
- Source:
Extends
- wp.media.view.Frame
- wp.media.View
- wp.Backbone.View
- Backbone.View
Classes
Methods
-
_createModes()
-
A frame can be in a mode or multiple modes at one time. For example, the manage media frame can be in the `Bulk Select` or `Edit` mode.
- Inherited From:
- Source:
-
_createStates()
-
Create the frame's states.
- Inherited From:
- Source:
- See:
Fires:
- wp.media.controller.State#event:ready
-
activateMode(string)
-
Activate a mode on the frame.
Parameters:
Name Type Description stringmode Mode ID. - Inherited From:
- Source:
Returns:
Returns itself to allow chaining.- Type
- this
-
attach()
-
- Source:
Returns:
Returns itself to allow chaining. -
close()
-
- Source:
Returns:
Returns itself to allow chaining. -
createIframeStates(options)
-
Parameters:
Name Type Description optionsObject - Source:
-
createMenu(menu)
-
This:
Parameters:
Name Type Description menuObject - Source:
-
createRouter(router)
-
This:
Parameters:
Name Type Description routerObject - Source:
-
createTitle(title)
-
This:
Parameters:
Name Type Description titleObject - Source:
-
createToolbar(toolbar)
-
This:
Parameters:
Name Type Description toolbarObject - Source:
-
deactivateMode(string)
-
Deactivate a mode on the frame.
Parameters:
Name Type Description stringmode Mode ID. - Inherited From:
- Source:
Returns:
Returns itself to allow chaining.- Type
- this
-
detach()
-
- Source:
Returns:
Returns itself to allow chaining. -
dispose()
-
- Inherited From:
- Source:
- To Do:
-
- The internal comment mentions this might have been a stop-gap before Backbone 0.9.8 came out. Figure out if Backbone core takes care of this in Backbone.View now.
Returns:
Returns itself to allow chaining.- Type
- wp.media.View
-
escape()
-
- Source:
Returns:
Returns itself to allow chaining. -
iframeContent(content)
-
This:
Parameters:
Name Type Description contentObject - Source:
-
isModeActive(string)
-
Check if a mode is enabled on the frame.
Parameters:
Name Type Description stringmode Mode ID. - Inherited From:
- Source:
Returns:
bool -
open()
-
- Source:
Returns:
Returns itself to allow chaining. -
remove()
-
- Inherited From:
- Source:
Returns:
Returns itself to allow chaining.- Type
- wp.media.View
-
render()
-
- Source:
Returns:
Returns itself to allow chaining. -
reset()
-
Reset all states on the frame to their defaults.
- Inherited From:
- Source:
Returns:
Returns itself to allow chaining.- Type
- wp.media.view.Frame
-
setMenuTabPanelAriaAttributes()
-
Sets the attributes to be used on the menu ARIA tab panel.
- Since:
-
- 5.3.0
- Source:
Returns:
- Type
- void
-
setRouterTabPanelAriaAttributes()
-
Sets the attributes to be used on the router ARIA tab panel.
- Since:
-
- 5.3.0
- Source:
Returns:
- Type
- void
-
triggerModeEvents()
-
Map activeMode collection events to the frame.
- Inherited From:
- Source:
Events
-
{mode}:deactivate
-
Frame mode deactivation event.
- Inherited From:
- Source: