Constructor
JavaScript:
-
new Coral.Progress()
ordocument.createElement('coral-progress')
HTML Tag:
-
<coral-progress>
Extends
Sub-components
Static Properties
-
Coral.Progress.labelPosition {String}
-
Properties:
Name Type Value Description LEFT String left Show the label to the left of the bar. RIGHT String right Show the label to the right of the bar. BOTTOM String bottom Show the label below the bar. -
Coral.Progress.size {String}
-
Properties:
Name Type Value Description SMALL String S A small progress bar. MEDIUM String M A medium progress bar. LARGE String L A large progress bar.
Enumeration representing progress bar label positions.
Enumeration representing progress bar sizes.
Instance Properties
-
instance.hidden {Boolean}
Reflected -
- Inherited From:
- Default Value:
- false
- HTML Attribute:
- hidden
-
instance.indeterminate {Boolean}
Reflected -
- Default Value:
- false
- HTML Attribute:
- indeterminate
-
instance.label {HTMLElement}
-
-
instance.labelPosition {Coral.Progress.labelPosition}
-
- Default Value:
- Coral.Progress.labelPosition.RIGHT
- HTML Attribute:
- labelposition
-
instance.showPercent {Boolean}
-
- Default Value:
- false
- HTML Attribute:
- showpercent
-
instance.size {Coral.Progress.size}
-
- Default Value:
- Coral.Progress.size.MEDIUM
- HTML Attribute:
- size
-
instance.value {Number}
Reflected -
- Default Value:
- 0
- HTML Attribute:
- value
Whether this component is hidden or not.
Whether to hide the current value and show an animation. Set to true for operations whose progress cannot be
determined.
Used to access to the Coral.Progress.Label element. Keep in mind that the width of a custom label is
limited for Coral.Progress.labelPosition.LEFT and Coral.Progress.labelPosition.RIGHT.
Label position.
Boolean attribute to toggle showing progress percent as the label content.
Default is true.
The vertical and text size of this progress bar. To adjust the width, simply set the CSS width property.
The current progress in percent.
Methods
-
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.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:
Get the value of a property.
Hide this component.
Remove an event listener.
Add an event listener.
Non-destructively remove this element. It can be re-added by simply appending it to the document again.
It will be garbage collected if there are no more references to it.
Set a single property.
Show this component.
Trigger an event.
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-progress:change
-
- Callback Parameters:
-
Name Type Description event Object Event object.
Name Type Description event.detail.value Object The current progress value in percent. event.detail.oldValue Object The previous progress value in percent.
Triggered when the component is attached to the DOM.
Triggered when the component is detached to the DOM.
Triggerred when the component has been upgraded and is ready for use.
Triggered when the progress value is changed.