Constructor
JavaScript:
-
new Coral.QuickActions()
ordocument.createElement('coral-quickactions')
HTML Tag:
-
<coral-quickactions>
Extends
Sub-components
Static Properties
-
Coral.QuickActions.interaction {String}
-
Properties:
Name Type Value Description ON String on Show when the target is hovered or focused and hide when the mouse is moved out or focus is lost. OFF String off Do not show or hide automatically. -
Coral.QuickActions.placement {String}
-
Properties:
Name Type Value Description TOP String top QuickActions inset to the top of the target. CENTER String center QuickActions inset to the center of the target. BOTTOM String bottom QuickActions inset to the bottom the target. -
Coral.QuickActions.target {String}
-
Properties:
Name Type Value Description PARENT String _parent Use the parent element in the DOM. PREVIOUS String _prev Use the previous sibling element in the DOM. NEXT String _next Use the next sibling element in the DOM.
Instance Properties
-
instance.alignAt {Coral.Overlay.align}
-
- Default Value:
- Coral.Overlay.align.CENTER_TOP
- HTML Attribute:
- alignat
-
instance.alignMy {Coral.Overlay.align}
-
- Default Value:
- Coral.Overlay.align.CENTER_TOP
- HTML Attribute:
- alignmy
-
instance.collision {Coral.Overlay.collision}
-
- Inherited From:
- Default Value:
- Coral.Overlay.collision.FLIP_FIT
- HTML Attribute:
- collision
-
instance.focusOnShow {String}
-
- Inherited From:
Properties:
Name Type Value Description ON String on When the overlay is opened, it will be focused. OFF String off The overlay will not focus itself when opened. -
instance.hidden {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- hidden
-
instance.interaction {Coral.QuickActions.interaction}
-
- Default Value:
- Coral.QuickActions.interaction.ON
- HTML Attribute:
- interaction
-
instance.items {Coral.Collection}
Readonly -
-
instance.offset {Number}
-
- Default Value:
- 10
- HTML Attribute:
- offset
-
instance.placement {Coral.Overlay.placement}
-
- Default Value:
- null
- HTML Attribute:
- placement
-
instance.returnFocus {String}
-
- Inherited From:
Properties:
Name Type Value Description ON String on When the overlay is closed, the element that was focused before the it was shown will be focused again. OFF String off Nothing will be focused when the overlay is closed. -
instance.target {Coral.Overlay.target | HTMLElement | String}
-
- Inherited From:
- Default Value:
- null
- HTML Attribute:
- target
-
instance.threshold {Number}
-
- Default Value:
- 4
- HTML Attribute:
- threshold
-
instance.trapFocus {String}
-
- Inherited From:
Properties:
Name Type Value Description ON String on Focus is trapped such that the use cannot focus outside of the overlay. OFF String off The user can focus outside the overlay as normal. -
instance.within {HTMLElement | String}
-
- Inherited From:
- Default Value:
- window
Methods
-
instance._layout
-
-
instance.get
-
- Parameters:
-
Name Type Description property String The name of the property to fetch the value of. - Returns:
-
Property value. {*}
- Inherited From:
-
instance.hide
-
- Returns:
-
this, chainable {Coral.Component}
- Inherited From:
-
instance.off
-
- Parameters:
-
Name Type Optional Description eventName String No
The event name to stop listening for. selector String Yes
The selector that was used for event delegation. func function No
The function that was passed to on()
.useCapture Boolean Yes
Only remove listeners with useCapture
set to the value passed in. - Returns:
-
this, chainable. {Coral.Component}
- Inherited From:
-
instance.on
-
- Parameters:
-
Name Type Optional Default Description eventName String No
The event name to listen for. selector String Yes
The selector to use for event delegation. func function No
The function that will be called when the event is triggered. useCapture Boolean Yes
Whether or not to listen during the capturing or bubbling phase. - Returns:
-
this, chainable. {Coral.Component}
- Inherited From:
-
instance.remove
-
- Inherited From:
-
instance.reposition
-
- Inherited From:
-
instance.set
-
- Parameters:
-
Name Type Description property String The name of the property to set. value * The value to set the property to. silent Boolean If true, events should not be triggered as a result of this set. - Returns:
-
this, chainable. {Coral.Component}
- Inherited From:
-
instance.show
-
- Returns:
-
this, chainable {Coral.Component}
- Inherited From:
-
instance.trigger
-
- Parameters:
-
Name Type Optional Default Description eventName String No
The event name to trigger. props Object Yes
Additional properties to make available to handlers as event.detail
.bubbles Boolean Yes
Set to false
to prevent the event from bubbling.cancelable Boolean Yes
Set to false
to prevent the event from being cancelable. - Returns:
-
CustomEvent object {CustomEvent}
- Inherited From:
Events
-
coral-component:attached
-
- Callback Parameters:
-
Name Type Description event Object Event object.
- Inherited From:
- Deprecated:
- since 1.14.0, use
MutationObserver
instead.
- since 1.14.0, use
-
coral-component:detached
-
- Callback Parameters:
-
Name Type Description event Object Event object.
- Inherited From:
- Deprecated:
- since 1.14.0, use
MutationObserver
instead.
- since 1.14.0, use
-
coral-component:ready
-
- Callback Parameters:
-
Name Type Description event Object Event object.
- Inherited From:
- Deprecated:
- since 1.9.0, use
Coral.commons.ready()
instead.
- since 1.9.0, use
-
coral-overlay:positioned
-
- Callback Parameters:
-
Name Type Description event Object Event object.
Name Type Description event.detail.vertical String The vertical position of the target relative to the overlay. top
when the overlay is at the bottom,bottom
when it is at the top.event.detail.horizontal String The horizontal position of the target relative to the overlay. left
when the overlay is to the right,right
when it is to the left.event.detail.target String The target's position. event.detail.element String The overlay's position.
- Inherited From: