Protected_A collection of view instances, which have been added directly into the module:ui/template~Template#children.
Protected_Collections registered with #createCollection.
An additional CSS class added to the #element.
ReadonlycontentA collection of the child views that creates the balloon panel contents.
An HTML element of the view. null until module:ui/view~View#render rendered
from the module:ui/view~View#template template. The class-level example above illustrates typical usage. The
full description, fenced examples, and assignment note are in the block comment immediately above the element field
in the source.
ReadonlyisSet true when the view has already been module:ui/view~View#render rendered.
Controls whether the balloon panel is visible or not.
The absolute left position of the balloon panel in pixels.
ReadonlylocaleA set of tools to localize the user interface.
Also see module:core/editor/editor~Editor#locale.
The balloon panel's current position. The position name is reflected in the CSS class set
to the balloon, i.e. .ck-balloon-panel_arrow_nw for the "arrow_nw" position. The class
controls the minor aspects of the balloon's visual appearance like the placement
of an #withArrow arrow. To support a new position, an additional CSS must be created.
Default position names correspond with module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions.
See the #attachTo and #pin methods to learn about custom balloon positions.
Shorthand for module:utils/locale~Locale#t.
Note: If #locale instance hasn't been passed to the view this method may not be available.
OptionaltemplateTemplate of this view. It provides the #element representing the view in DOM, which is #render rendered.
The absolute top position of the balloon panel in pixels.
OptionalviewControls whether the balloon panel has an arrow. The presence of the arrow
is reflected in the ck-balloon-panel_with-arrow CSS class.
StaticarrowA height offset of the arrow from the edge of the balloon. Controlled by CSS.
┌───────────────────────┐
│ │
│ Balloon │
│ Content │ ╱-- arrow height offset
│ │ V
└──+ +───────────────┘ --- ─┼───────
\ / │
/ │
────────────────────────────────┼───────
^
>┼────┼< arrow height offset
│ │
│ ┌────────────────────────┐
│ │ │
│ ╱ │
│ ╱ Balloon │
│ ╲ Content │
│ ╲ │
│ │ │
│ └────────────────────────┘
StaticarrowA side offset of the arrow tip from the edge of the balloon. Controlled by CSS.
┌───────────────────────┐
│ │
│ Balloon │
│ Content │
│ │
└──+ +───────────────┘
| \ /
| /
>┼─────┼< ─────────────────────── side offset
StaticdefaultA default set of positioning functions used by the balloon panel view when attaching using the module:ui/panel/balloon/balloonpanelview~BalloonPanelView#attachTo method.
The available positioning functions are as follows:
North west
northWestArrowSouthWest +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northWestArrowSouthMiddleWest +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northWestArrowSouth +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northWestArrowSouthMiddleEast +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northWestArrowSouthEast +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
North
northArrowSouthWest +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northArrowSouthMiddleWest +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northArrowSouth +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northArrowSouthMiddleEast +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northArrowSouthEast +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
North east
northEastArrowSouthWest +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northEastArrowSouthMiddleWest +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northEastArrowSouth +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northEastArrowSouthMiddleEast +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
northEastArrowSouthEast +-----------------+
| Balloon |
+-----------------+
V
[ Target ]
South
southArrowNorthWest [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southArrowNorthMiddleWest [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southArrowNorth [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southArrowNorthMiddleEast [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southArrowNorthEast [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
South west
southWestArrowNorthWest [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southWestArrowNorthMiddleWest [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southWestArrowNorth [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southWestArrowNorthMiddleEast [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southWestArrowNorthEast [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
South east
southEastArrowNorthWest [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southEastArrowNorthMiddleWest [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southEastArrowNorth [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southEastArrowNorthMiddleEast [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
southEastArrowNorthEast [ Target ]
^
+-----------------+
| Balloon |
+-----------------+
West
westArrowEast +-----------------+
| Balloon |>[ Target ]
+-----------------+
East
eastArrowWest +-----------------+
[ Target ]<| Balloon |
+-----------------+
Sticky
viewportStickyNorth +---------------------------+
| [ Target ] |
| |
+-----------------------------------+
| | +-----------------+ | |
| | | Balloon | | |
| | +-----------------+ | |
| | | |
| | | |
| | | |
| | | |
| +---------------------------+ |
| Viewport |
+-----------------------------------+
See module:ui/panel/balloon/balloonpanelview~BalloonPanelView#attachTo.
Positioning functions must be compatible with module:utils/dom/position~DomPoint.
Default positioning functions with customized offsets can be generated using module:ui/panel/balloon/balloonpanelview~BalloonPanelView.generatePositions.
The name that the position function returns will be reflected in the balloon panel's class that controls the placement of the "arrow". See #position to learn more.
StaticstickyA vertical offset of the balloon panel from the edge of the viewport if sticky. It helps in accessing toolbar buttons underneath the balloon panel.
┌───────────────────────────────────────────────────┐
│ Target │
│ │
│ /── vertical offset │
┌─────────────────────────────V─────────────────────────┐
│ Toolbar ┌─────────────┐ │
├────────────────────│ Balloon │────────────────────┤
│ │ └─────────────┘ │ │
│ │ │ │
│ │ │ │
│ │ │ │
│ └───────────────────────────────────────────────────┘ │
│ Viewport │
└───────────────────────────────────────────────────────┘
Shorthand for module:ui/template~Template.bind, a binding module:ui/template~BindChain interface pre–configured for the view instance.
It provides module:ui/template~BindChain#to to() and
module:ui/template~BindChain#if if() methods that initialize bindings with
observable attributes and attach DOM listeners.
class SampleView extends View {
constructor( locale ) {
super( locale );
const bind = this.bindTemplate;
// These {@link module:utils/observablemixin~Observable observable} attributes will control
// the state of the view in DOM.
this.set( {
elementClass: 'foo',
isEnabled: true
} );
this.setTemplate( {
tag: 'p',
attributes: {
// The class HTML attribute will follow elementClass
// and isEnabled view attributes.
class: [
bind.to( 'elementClass' )
bind.if( 'isEnabled', 'present-when-enabled' )
]
},
on: {
// The view will fire the "clicked" event upon clicking <p> in DOM.
click: bind.to( 'clicked' )
}
} );
}
}
Attaches the panel to a specified module:utils/dom/position~DomOptimalPositionOptions#target with a smart positioning heuristics that chooses from available positions to make sure the panel is visible to the user i.e. within the limits of the viewport.
This method accepts configuration module:utils/dom/position~DomOptimalPositionOptions options
to set the target, optional limiter and positions the balloon should choose from.
const panel = new BalloonPanelView( locale );
const positions = BalloonPanelView.defaultPositions;
panel.render();
// Attach the panel to an element with the "target" id DOM.
panel.attachTo( {
target: document.querySelector( '#target' ),
positions: [
positions.northArrowSouth,
positions.southArrowNorth
]
} );
Note: Attaching the panel will also automatically #show it.
Note: An attached panel will not follow its target when the window is scrolled or resized. See the #pin method for a more permanent positioning strategy.
Positioning options compatible with module:utils/dom/position~getOptimalPosition.
Default positions array is module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions.
Whether the balloon was shown and successfully attached or not. Attaching can fail if the target provided in the options is invisible (e.g. element detached from DOM).
Creates a new collection of views, which can be used as module:ui/template~Template#children of this view.
class SampleView extends View {
constructor( locale ) {
super( locale );
const child = new ChildView( locale );
this.items = this.createCollection( [ child ] );
this.setTemplate( {
tag: 'p',
// `items` collection will render here.
children: this.items
} );
}
}
const view = new SampleView( locale );
view.render();
// It will append <p><child#element></p> to the <body>.
document.body.appendChild( view.element );
A new collection of view instances.
The opposite of #registerChild. Removes a child view from this view instance. Once removed, the child is no longer managed by its parent, e.g. it can safely become a child of another parent view.
Child views to be removed.
Recursively destroys the view instance and child views added by #registerChild and residing in collections created by the #createCollection.
Destruction disables all event listeners:
view.on( 'event', () => {} ),module:ui/template~Template.extend Extends the #template of the view with with given definition.
A shorthand for:
Template.extend( view.template, definition );
Note: Is requires the #template to be already set. See #setTemplate.
Definition which extends the #template.
Hides the panel.
See #isVisible.
Works the same way as the #attachTo method except that the position of the panel is continuously updated when:
Thanks to that, the panel always sticks to the module:utils/dom/position~DomOptimalPositionOptions#target and is immune to the changing environment.
const panel = new BalloonPanelView( locale );
const positions = BalloonPanelView.defaultPositions;
panel.render();
// Pin the panel to an element with the "target" id DOM.
panel.pin( {
target: document.querySelector( '#target' ),
positions: [
positions.northArrowSouth,
positions.southArrowNorth
]
} );
To leave the pinned state, use the #unpin method.
Note: Pinning the panel will also automatically #show it.
Positioning options compatible with module:utils/dom/position~getOptimalPosition.
Default positions array is module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions.
Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including #render rendering and #destroy destruction.
To revert this, use #deregisterChild.
class SampleView extends View {
constructor( locale ) {
super( locale );
this.childA = new SomeChildView( locale );
this.childB = new SomeChildView( locale );
this.setTemplate( { tag: 'p' } );
// Register the children.
this.registerChild( [ this.childA, this.childB ] );
}
render() {
super.render();
this.element.appendChild( this.childA.element );
this.element.appendChild( this.childB.element );
}
}
const view = new SampleView( locale );
view.render();
// Will append <p><childA#element><b></b><childB#element></p>.
document.body.appendChild( view.element );
Note: There's no need to add child views if they're already referenced in the #template:
class SampleView extends View {
constructor( locale ) {
super( locale );
this.childA = new SomeChildView( locale );
this.childB = new SomeChildView( locale );
this.setTemplate( {
tag: 'p',
// These children will be added automatically. There's no
// need to call {@link #registerChild} for any of them.
children: [ this.childA, this.childB ]
} );
}
// ...
}
Children views to be registered.
Recursively renders the view.
Once the view is rendered:
true.Note: The children of the view:
In general, render() method is the right place to keep the code which refers to the
#element and should be executed at the very beginning of the view's life cycle.
It is possible to module:ui/template~Template.extend the #template before
the view is rendered. To allow an early customization of the view (e.g. by its parent),
such references should be done in render().
class SampleView extends View {
constructor() {
this.setTemplate( {
// ...
} );
},
render() {
// View#element becomes available.
super.render();
// The "scroll" listener depends on #element.
this.listenTo( window, 'scroll', () => {
// A reference to #element would render the #template and make it non-extendable.
if ( window.scrollY > 0 ) {
this.element.scrollLeft = 100;
} else {
this.element.scrollLeft = 0;
}
} );
}
}
const view = new SampleView();
// Let's customize the view before it gets rendered.
view.extendTemplate( {
attributes: {
class: [
'additional-class'
]
}
} );
// Late rendering allows customization of the view.
view.render();
Sets the #template of the view with with given definition.
A shorthand for:
view.setTemplate( definition );
Definition of view's template.
Shows the panel.
See #isVisible.
Stops pinning the panel, as set up by #pin.
StaticgenerateInternal
Returns available module:ui/panel/balloon/balloonpanelview~BalloonPanelView module:utils/dom/position~PositioningFunction positioning functions adjusted by the specific offsets.
Optionaloptions: {Options to generate positions. If not specified, this helper will simply return module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions.
Optionalconfig?: objectAdditional configuration of the balloon balloon panel view. Currently only module:ui/panel/balloon/balloonpanelview~BalloonPanelView#withArrow is supported. Learn more about module:utils/dom/position~PositioningFunction positioning functions.
OptionalheightOffset?: numberA custom height offset (in pixels) of each position. If not specified, module:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowHeightOffset the default value will be used.
OptionalsideOffset?: numberA custom side offset (in pixels) of each position. If not specified, module:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowSideOffset the default value will be used.
OptionalstickyVerticalOffset?: numberA custom offset (in pixels) of the viewportStickyNorth positioning function.
If not specified, module:ui/panel/balloon/balloonpanelview~BalloonPanelView.stickyVerticalOffset the default value
will be used.
The balloon panel view class.
A floating container which can module:ui/panel/balloon/balloonpanelview~BalloonPanelView#pin pin to any module:utils/dom/position~DomOptimalPositionOptions#target target in the DOM and remain in that position e.g. when the web page is scrolled.
The balloon panel can be used to display contextual, non-blocking UI like forms, toolbars and the like in its module:ui/panel/balloon/balloonpanelview~BalloonPanelView#content view collection.
There is a number of module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions that the balloon can use, automatically switching from one to another when the viewport space becomes scarce to keep the balloon visible to the user as long as it is possible. The balloon will also accept any custom position set provided by the user compatible with the module:utils/dom/position~DomOptimalPositionOptions options.