Markup Examples

|

Basic

The following is an example of a slider with a min="10", max="20", and step="2".
Show Markup

                      

Tooltips

The following is an example of a configuration with tooltips, specified via tooltips attribute.
Show Markup

                      

Filled

The following is an example of a configuration with a filled bar, specified via filled attribute.
Show Markup

                      

Items

The following is an example of a slider with label items.
First Second Third Fourth Fifth
Show Markup

            

Ranged Slider

|

Basic

The following is an example of a ranged slider with a min="10", max="20", and step="2".
Show Markup

                      

Tooltips

The following is an example of a configuration with tooltips, specified via tooltips attribute.
Show Markup

                      

Items

The following is an example of a ranged slider with label items.
First Second Third Fourth Fifth
Show Markup

            

Vertical Layout

Required Information
Error Message
Show Markup

                      

Aligned Layout

Required Information
Error Message
Show Markup

            

JS Class Initialization - Slider

The following is an example of creating a Slider.
Show Markup

                  

The following JavaScript manually initializes the component on page initialization.

                        

No example content provided!

JS Class Initialization - Ranged Slider

The following is an example of creating a ranged Slider. Note this is accomplished by providing startValue and endValue
Show Markup

                  

The following JavaScript manually initializes the component on page initialization.

                        

No example content provided!

Coral.Slider API

Constructor

JavaScript:

new Coral.Slider() or document.createElement('coral-slider')

HTML Tag:

<coral-slider>

Extends

Sub-components

Static Properties

Coral.Slider.orientation {String}

Slider orientations.

Properties:

Name Type Value Description
HORIZONTAL String horizontal Horizontal slider.
VERTICAL String vertical Vertical slider.

Instance Properties

instance.disabled {Boolean}

Reflected
Whether this field is disabled or not. This value is reflected as an attribute in the DOM. Implementers should additionally set 'aria-disabled' to improve accessibility of the component.
Default Value:
  • false
HTML Attribute:
  • disabled

instance.filled {Boolean}

Reflected
Fill a value or value range using a highlight color.
Default Value:
  • false
HTML Attribute:
  • filled

instance.invalid {Boolean}

Reflected
Whether the current value of this field is invalid or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • invalid

instance.items {Coral.Collection}

Readonly
The Collection Interface that allows interacting with the items that the component contains. See Coral.Collection for more details.

instance.labelledBy {String}

Reference to a space delimited set of ids for the HTML elements that provide a label for the formField. Implementers should override this method to ensure that the appropriate descendant elements are labelled using the aria-labelledby attribute. This will ensure that the component is properly identified for accessibility purposes. It reflects the aria-labelledby attribute to the DOM.
Inherited From:
Default Value:
  • null
HTML Attribute:
  • labelledby

instance.max {Number}

Reflected
The maximum value.
Default Value:
  • 100
HTML Attribute:
  • max

instance.min {Number}

Reflected
The minimum value.
Default Value:
  • 1
HTML Attribute:
  • min

instance.name {String}

Reflected
Name used to submit the data in a form.
Inherited From:
Default Value:
  • ""
HTML Attribute:
  • name

instance.orientation {Coral.Slider.orientation}

Orientation of the slider, which can be VERTICAL or HORIZONTAL.
Default Value:
  • Coral.Slider.orientation.HORIZONTAL
HTML Attribute:
  • orientation

instance.readOnly {Boolean}

Reflected
Whether this field is readOnly or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • readonly

instance.required {Boolean}

Reflected
Whether this field is required or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • required

instance.step {Number}

Reflected
Increment value of one step.
Default Value:
  • 1
HTML Attribute:
  • step

instance.tooltips {Boolean}

Reflected
Display tooltips for the slider value.
Default Value:
  • false
HTML Attribute:
  • tooltips

instance.value {String}

Reflected
The current value of the slider.
Default Value:
HTML Attribute:
  • value

Methods

instance.get

Get the value of a property.
Parameters:
Name Type Description
property String The name of the property to fetch the value of.
Returns:
Property value. {*}
Inherited From:

instance.hide

Hide this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.off

Remove an event listener.
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

Add an event listener.
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
false Whether or not to listen during the capturing or bubbling phase.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.remove

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. This is different from using jQuery's remove(), which is destructive in that it removes data and listeners.
Inherited From:

instance.show

Show this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.trigger

Trigger an event.
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
true Set to false to prevent the event from bubbling.
cancelable Boolean Yes
true Set to false to prevent the event from being cancelable.
Returns:
CustomEvent object {CustomEvent}
Inherited From:

Events

change

Triggered when the value has changed. This event is only triggered by user interaction.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:attached

Triggered when the component is attached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:detached

Triggered when the component is detached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:hide

Triggerred after the component is hidden with Coral.Component#hide.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

Coral.Slider.Item API

Constructor

JavaScript:

new Coral.Slider.Item() or document.createElement('coral-slider-item')

HTML Tag:

<coral-slider-item>

Extends

Instance Properties

instance.value {Number}

Reflected
The slider's item value. Although this must be a number in the current implement, this may change.
Default Value:
  • null
HTML Attribute:
  • value

Methods

instance.get

Get the value of a property.
Parameters:
Name Type Description
property String The name of the property to fetch the value of.
Returns:
Property value. {*}
Inherited From:

instance.hide

Hide this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.off

Remove an event listener.
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

Add an event listener.
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
false Whether or not to listen during the capturing or bubbling phase.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.remove

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. This is different from using jQuery's remove(), which is destructive in that it removes data and listeners.
Inherited From:

instance.show

Show this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.trigger

Trigger an event.
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
true Set to false to prevent the event from bubbling.
cancelable Boolean Yes
true Set to false to prevent the event from being cancelable.
Returns:
CustomEvent object {CustomEvent}
Inherited From:

Events

coral-component:attached

Triggered when the component is attached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:detached

Triggered when the component is detached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:hide

Triggerred after the component is hidden with Coral.Component#hide.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

Coral.RangedSlider API

Constructor

JavaScript:

new Coral.RangedSlider() or document.createElement('coral-rangedslider')

HTML Tag:

<coral-rangedslider>

Extends

Instance Properties

instance.disabled {Boolean}

Reflected
Whether this field is disabled or not. This value is reflected as an attribute in the DOM. Implementers should additionally set 'aria-disabled' to improve accessibility of the component.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • disabled

instance.endValue {String}

Reflected
The ending value of the range.
Default Value:
HTML Attribute:
  • endValue

instance.filled {Boolean}

Reflected
Fill a value or value range using a highlight color.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • filled

instance.invalid {Boolean}

Reflected
Whether the current value of this field is invalid or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • invalid

instance.items {Coral.Collection}

Readonly
The Collection Interface that allows interacting with the items that the component contains. See Coral.Collection for more details.
Inherited From:

instance.labelledBy {String}

Reference to a space delimited set of ids for the HTML elements that provide a label for the formField. Implementers should override this method to ensure that the appropriate descendant elements are labelled using the aria-labelledby attribute. This will ensure that the component is properly identified for accessibility purposes. It reflects the aria-labelledby attribute to the DOM.
Inherited From:
Default Value:
  • null
HTML Attribute:
  • labelledby

instance.max {Number}

Reflected
The maximum value.
Inherited From:
Default Value:
  • 100
HTML Attribute:
  • max

instance.min {Number}

Reflected
The minimum value.
Inherited From:
Default Value:
  • 1
HTML Attribute:
  • min

instance.name {String}

Reflected
Name used to submit the data in a form.
Inherited From:
Default Value:
  • ""
HTML Attribute:
  • name

instance.orientation {Coral.Slider.orientation}

Orientation of the slider, which can be VERTICAL or HORIZONTAL.
Inherited From:
Default Value:
  • Coral.Slider.orientation.HORIZONTAL
HTML Attribute:
  • orientation

instance.readOnly {Boolean}

Reflected
Whether this field is readOnly or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • readonly

instance.required {Boolean}

Reflected
Whether this field is required or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • required

instance.startValue {String}

Reflected
The starting value of the range.
Default Value:
HTML Attribute:
  • startValue

instance.step {Number}

Reflected
Increment value of one step.
Inherited From:
Default Value:
  • 1
HTML Attribute:
  • step

instance.tooltips {Boolean}

Reflected
Display tooltips for the slider value.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • tooltips

instance.values {Array.<String>}

The current values of the ranged slider.
Default Value:

Methods

instance.get

Get the value of a property.
Parameters:
Name Type Description
property String The name of the property to fetch the value of.
Returns:
Property value. {*}
Inherited From:

instance.hide

Hide this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.off

Remove an event listener.
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

Add an event listener.
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
false Whether or not to listen during the capturing or bubbling phase.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.remove

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. This is different from using jQuery's remove(), which is destructive in that it removes data and listeners.
Inherited From:

instance.show

Show this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.trigger

Trigger an event.
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
true Set to false to prevent the event from bubbling.
cancelable Boolean Yes
true Set to false to prevent the event from being cancelable.
Returns:
CustomEvent object {CustomEvent}
Inherited From:

Events

change

Triggered when the value has changed. This event is only triggered by user interaction.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:attached

Triggered when the component is attached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:detached

Triggered when the component is detached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:

coral-component:hide

Triggerred after the component is hidden with Coral.Component#hide.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From: