Usage
Signature:
interface SliderElement
Typescript Import Format
//To typecheck the element APIs, import as below.
import { SliderElement } from "ojs/ojslider";
//For the transpiled javascript to load the element's module, import as below
import "ojs/ojslider";
For additional information visit:
Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.
Styling Classes
-
.oj-focus-highlight
-
Under normal circumstances this class is applied automatically. It is documented here for the rare cases that an app developer needs per-instance control.
The oj-focus-highlight class applies focus styling that may not be desirable when the focus results from pointer interaction (touch or mouse), but which is needed for accessibility when the focus occurs by a non-pointer mechanism, for example keyboard or initial page load.
The application-level behavior for this component is controlled in the theme by the$focusHighlightPolicy
SASS variable; however, note that this same variable controls the focus highlight policy of many components and patterns. The values for the variable are:
nonPointer:
oj-focus-highlight is applied only when focus is not the result of pointer interaction. Most themes default to this value.
all:
oj-focus-highlight is applied regardless of the focus mechanism.
none:
oj-focus-highlight is never applied. This behavior is not accessible, and is intended for use when the application wishes to use its own event listener to precisely control when the class is applied (see below). The application must ensure the accessibility of the result.
To change the behavior on a per-instance basis, the application can set the SASS variable as desired and then use event listeners to toggle this class as needed.
Example
<oj-slider class="oj-focus-highlight"> <!-- Content --> </oj-slider>
-
.oj-form-control-full-width
-
Changes the max-width to 100% so that form components will occupy all the available horizontal space.
Example
<oj-slider class="oj-form-control-full-width"> </oj-slider>
-
Category: Max Width
-
Note: This category of style classes is not supported in the following themes:
Alta
In the Redwood theme the default max width of a text field is 100%. These max width convenience classes are available to create a medium or small field.
The class is applied to the root element.Classes:
-
.oj-form-control-max-width-sm
-
.oj-form-control-max-width-md
Example
<oj-slider class="oj-form-control-max-width-md"></oj-slider>
-
-
Category: Width
-
Note: This category of style classes is not supported in the following themes:
Alta
In the Redwood theme the default width of a text field is 100%. These width convenience classes are available to create a medium or small field.
The class is applied to the root element.Classes:
-
.oj-form-control-width-sm
-
.oj-form-control-width-md
Example
<oj-slider class="oj-form-control-width-md"></oj-slider>
-
-
CSS Variables
-
Enabled
-
Hovered
-
Active
-
Disabled
Name | Type | Description |
---|---|---|
--oj-slider-thumb-width |
<length> | Slider thumb width |
--oj-slider-thumb-height |
<length> | Slider thumb height |
--oj-slider-thumb-border-radius |
<length> | <percentage> | Slider thumb border radius |
--oj-slider-thumb-border-width |
<length> | Slider thumb border width |
--oj-slider-track-thickness |
<length> | Slider track thickness |
Name | Type | Description |
---|---|---|
--oj-slider-thumb-bg-color |
<color> | Slider thumb background color when enabled |
--oj-slider-thumb-border-color |
<color> | Slider thumb border color when enabled |
--oj-slider-thumb-box-shadow |
Slider thumb box shadow when enabled | |
--oj-slider-track-bg-color |
<color> | Slider track background color when enabled |
--oj-slider-value-bg-color |
<color> | Slider value background color when enabled |
Name | Type | Description |
---|---|---|
--oj-slider-thumb-bg-color-hover |
<color> | Slider thumb background color when hovered |
--oj-slider-thumb-box-shadow-hover |
Slider thumb box shadow when hovered |
Name | Type | Description |
---|---|---|
--oj-slider-thumb-bg-color-active |
<color> | Slider thumb background color when active |
--oj-slider-thumb-border-color-active |
<color> | Slider thumb border color when active |
--oj-slider-thumb-box-shadow-active |
Slider thumb box shadow when active | |
--oj-slider-thumb-scale-active |
<number> | Slider thumb scale when active |
Name | Type | Description |
---|---|---|
--oj-slider-thumb-bg-color-disabled |
<color> | Slider thumb background color when disabled |
--oj-slider-thumb-border-color-disabled |
<color> | Slider thumb border color when disabled |
--oj-slider-track-bg-color-disabled |
<color> | Slider track background color when disabled |
--oj-slider-value-bg-color-disabled |
<color> | Slider value background color when disabled |
Slots
JET components that allow child content support slots. Please see the slots section of the JET component overview doc for more information on allowed slot content and slot types.
-
contextMenu
-
The contextMenu slot is set on the
oj-menu
within this element. This is used to designate the JET Menu that this component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the JET Menu specified in this slot.The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.
To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc of the individual components for details.
Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.
Attributes
-
(nullable) described-by :string
-
The oj-label sets the described-by attribute programmatically on the form component. This attribute is not meant to be set by an application developer directly. The described-by is copied to the aria-describedby attribute on the component's inner dom element, and it is needed for accessibility.
- Since:
- 4.0.0
Names
Item Name Property describedBy
Property change event describedByChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-described-by-changed
-
disabled :boolean
-
Whether the component is disabled. The default is false.
A disabled component does not show messages or user assistance text.
When the
disabled
property changes due to programmatic intervention, the component may clear messages and run validation in some cases.
- when a required component is initialized as disabled
value="{{currentValue}}" required disabled
, deferred validation is skipped. - when a disabled component is enabled,
- if component is invalid and showing messages then all component messages are cleared,
and full validation run using the display value.
- if there are validation errors, they are shown.
- if no errors result from the validation, the
value
property is updated. Page authors can listen to thevalueChanged
event to clear custom errors.
- if component is valid and has no errors then deferred validation is run.
- if there is a deferred validation error, then the valid property is updated.
- if component is invalid and deferred errors then component messages are cleared and
deferred validation re-run.
- if there is a deferred validation error, then the valid property is updated.
- if component is invalid and showing messages then all component messages are cleared,
and full validation run using the display value.
- when enabled component is disabled then no validation is run and the component appears disabled.
- Default Value:
false
- Since:
- 0.7.0
Names
Item Name Property disabled
Property change event disabledChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-disabled-changed
- when a required component is initialized as disabled
-
display-options :Object
-
Display options for auxiliary content that determines whether or not it should be displayed.
In the Redwood theme, the sub-properties of the display-options configure whether or not the types of information is shown. The values of these sub-properties are either 'display' or 'none'.
When display-options changes due to programmatic intervention, the component updates its display to reflect the updated choices. For example, if you don't want to show the converter hint, set the display-options.converter-hint to 'none'.
A side note: help.instruction and message detail text can include formatted HTML text, whereas hints and message summary text cannot. If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there. The allowed html tags are: span, b, i, em, br, hr, li, ol, ul, p, small, pre. To format the help.instruction, you could do this:
<html>Enter <b>at least</b> 6 characters</html>
- Since:
- 0.7
Names
Item Name Property displayOptions
Property change event displayOptionsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-display-options-changed
-
display-options.converter-hint :('display'|'none')
-
Display options for auxiliary converter hint text. The supported attribute values are theme dependent.
In the Redwood theme, this attribute determines whether or not the converter hint should be displayed. The supported values are 'display' and 'none'. If you don't want to show the converter hint, set display-options.converter-hint to 'none'. It defaults to 'display'. To control where the hints display, e.g., inline or in a notewindow, then use the user-assistance-density attribute.
- Since:
- 9.1.0
Names
Item Name Property displayOptions.converterHint
-
display-options.help-instruction :Array<'notewindow'|'none'>|'notewindow'|'none'
-
Display options for auxiliary help instruction text that determines where it should be displayed in relation to the component.
- Default Value:
['notewindow']
- Since:
- 9.0.0
Names
Item Name Property displayOptions.helpInstruction
-
display-options.messages :('display'|'none')
-
Display options for auxiliary message text. The supported attribute values are theme dependent.
In the Redwood theme, this attribute determines whether or not the messages should be displayed. The supported values are 'display' and 'none'. If you don't want to show messages, set display-options.messages to 'none'. It defaults to 'display'. To control where the messages display, e.g., inline or in a notewindow, then use the user-assistance-density attribute.
- Since:
- 9.1.0
Names
Item Name Property displayOptions.messages
-
display-options.validator-hint :('display'|'none')
-
Display options for auxiliary validator hint text. The supported attribute values are theme dependent.
In the Redwood theme, this attribute determines whether or not the validator hint should be displayed. The supported values are 'display' and 'none'. If you don't want to show the validator hint, set display-options.validator-hint to 'none'. It defaults to 'display'. To control where the hints display, e.g., inline or in a notewindow, then use the user-assistance-density attribute.
- Since:
- 9.1.0
Names
Item Name Property displayOptions.validatorHint
-
help :Object
-
Form component help information.
- Since:
- 0.7.0
Names
Item Name Property help
Property change event helpChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-help-changed
-
help.instruction :string
-
A type of user assistance text. User assistance text is used to provide guidance to help the user understand what data to enter or select.
In the Redwood theme for clarity only one user assistance text shows to the user. The precedence rules are:
- help.instruction shows;
- if no help.instruction, then validator hint shows;
- if no help.instruction or validator hint, then help-hints.definition shows;
- if no help.instruction, validator hint, or help-hints.definition, then converter hint shows.
- help-hints.source always shows along side the above.
In the Redwood theme, by default all user assistance text shows inline. For input components, it shows when the field takes focus. In other components it shows all the time. See the user-assistance-density property for other ways the user assistance text can render.
How is help.instruction better than the html 'title' attribute? The html 'title' attribute only shows up as a tooltip on mouse over, not on keyboard and not in a mobile device. So the html 'title' would only be for text that is not important enough to show all users, or for text that you show the users in another way as well, like in the label. Also you cannot theme the native browser's title window like you can the JET notewindow, so low vision users may have a hard time seeing the 'title' window. For these reasons, the JET EditableValue components do not use the HTML's 'title' attribute and instead use the help.instruction attribute.
To include formatted text in the help.instruction, format the string using html tags. The allowed html tags are: span, b, i, em, br, hr, li, ol, ul, p, small, pre. For example the help.instruction might look like:
If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there.<oj-some-element help.instruction="<html>Enter <b>at least</b> 6 characters</html>"></oj-some-element>
- Default Value:
""
- Since:
- 4.0.0
Names
Item Name Property help.instruction
-
help-hints :Object
-
The helpHints object contains a definition property and a source property.
definition
- hint for help definition text.source
- hint for help source URL.
- Since:
- 4.1.0
Names
Item Name Property helpHints
Property change event helpHintsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-help-hints-changed
-
(nullable) help-hints.definition :string
-
A type of user assistance text. User assistance text is used to provide guidance to help the user understand what data to enter or select. help-hints could come from a help system.
In the Redwood theme for clarity only one user assistance text shows to the user. The precedence rules are:
- help.instruction shows;
- if no help.instruction, then validator hint shows;
- if no help.instruction or validator hint, then help-hints.definition shows;
- if no help.instruction, validator hint, or help-hints.definition, then converter hint shows.
- help-hints.source always shows along side the above.
In the Redwood theme, by default all user assistance text shows inline. For input components, it shows when the field takes focus. In other components it shows all the time. See the user-assistance-density property for other ways the user assistance text can render.
No formatted text is available for help definition attribute.
See the help-hints attribute for usage examples.
- Default Value:
""
- Since:
- 4.1.0
Names
Item Name Property helpHints.definition
-
(nullable) help-hints.source :string
-
Help source URL associated with the component.
In the Redwood theme, the help-hints.source will show as a link inline to the field. For input components, it shows when the field takes focus. For other components, it shows all the time.
For security reasons we only support urls with protocol 'http:' or 'https:'. If the url doesn't comply we ignore it and throw an error. Pass in an encoded URL since we do not encode the URL.
See the help-hints attribute for usage examples.
- Default Value:
""
- Since:
- 4.1.0
Names
Item Name Property helpHints.source
-
label-edge :('inside'|'none'|'provided')
-
Specifies how the label of the component is created when the
label-hint
attribute is set on the component.The default value varies by theme, and it works well for the theme in most cases. If the component is in an oj-form-layout, the label-edge attribute could come from the oj-form-layout's label-edge attribute. The oj-form-layout component uses the MetadataTypes.PropertyBinding
provide
property to provide and uses the MetadataTypes.ProvidePropertytransform
property to transform itslabel-edge
attribute to any descendent components that are configured to consume it. For example, if the oj-form-layout's label-edge attribute is set to "top" or "start", and a descendent form component does not have its label-edge attribute set, the form component's label-edge will be the transformed value "provided".- Since:
- 8.0.0
Supported Values:
Value Description inside
The component creates the label using the label-hint
attribute.For text input components (such as oj-input-text), the label floats over the input element but moves up on focus or when the component has a value.
For non-text input components (such as oj-checkboxset), the label is created at the top of the component and doesn't move.
none
The component will not have a label, regardless of whether it's in an oj-form-layout or not. If the component has a
label-hint
attribute but no labelled-by, aria-label, or aria-labelledby attribute, the label-hint value will be used as the aria-label.Note that if the component already has an external label, "none" should not be specified and "provided" should be used instead. Otherwise it may end up with conflicting label information.
provided
Label is provided by the parent if the parent is an oj-form-layout. oj-form-layout provides the label using the label-hint from the form control and the label-edge from oj-form-layout.
If there is no oj-form-layout, use an oj-label.
Names
Item Name Property labelEdge
Property change event labelEdgeChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-label-edge-changed
-
label-hint :string
-
Represents a hint for rendering a label on the component.
This is used in combination with the label-edge attribute to control how the label should be rendered.
When label-edge is "provided", it gives a hint to oj-form-layout parent element to create an oj-label element for the component. When the
label-hint
attribute changes, oj-form-layout element refreshes to display the updated label information.When label-edge is "inside", it gives a hint to the component itself to render a label.
When label-edge is "none", and if the component has no labelled-by, aria-label, or aria-labelledby attribute, the label-hint value will be used as the aria-label.
- Default Value:
""
- Since:
- 4.1.0
Names
Item Name Property labelHint
Property change event labelHintChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-label-hint-changed
-
labelled-by :string|null
-
The oj-label sets the labelledBy property programmatically on the form component to make it easy for the form component to find its oj-label component (a document.getElementById call.)
The application developer should use the 'for'/'id api to link the oj-label with the form component; the 'for' on the oj-label to point to the 'id' on the input form component. This is the most performant way for the oj-label to find its form component.
- Default Value:
null
- Since:
- 7.0.0
Names
Item Name Property labelledBy
Property change event labelledByChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-labelled-by-changed
-
(nullable) max :number
-
The maximum value of the slider. The
max
must not be less than themin
, or else an Error is thrown during initialization.- Default Value:
100
- Since:
- 0.7.0
Names
Item Name Property max
Property change event maxChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-max-changed
-
messages-custom :Array<oj.Message>
-
List of messages an app would add to the component when it has business/custom validation errors that it wants the component to show. This allows the app to perform further validation before sending data to the server. When this option is set the message shows to the user right away. To clear the custom message, set
messagesCustom
back to an empty array.
Each message in the array is an object that duck types oj.Message. See Message for details. message detail text can include formatted HTML text, whereas hints and message summary text cannot. If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there. The allowed html tags are: span, b, i, em, br, hr, li, ol, ul, p, small, pre. To format the message detail, you could do this:
<html>Enter <b>at least</b> 6 characters</html>
A messagesCustom message with severity error will make the component's valid state invalidShown. However, a messagesCustom message, no matter the severity, does not prevent the value from being changed, as well as pushed to the view model.
Messages are shown on an enabled component, but not on a disabled component. On a readonly component, if readonlyMessagesCustom is set to 'confirmationOrInfoMessages', then info and confirmation custom messages are shown.
See the Validation and Messages section for details on when the component clears
messagesCustom
; for example, when full validation is run.In the Redwood theme, the Message summary is not displayed to the user, so make sure to have a Message detail set in your Message object.
- Default Value:
[]
- Supports writeback:
true
- Since:
- 0.7.0
Names
Item Name Property messagesCustom
Property change event messagesCustomChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-messages-custom-changed
-
(nullable) min :number
-
The minimum value of the slider. The
min
must not be greater than themax
, or else an Error is thrown during initialization.- Default Value:
0
- Since:
- 0.7.0
Names
Item Name Property min
Property change event minChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-min-changed
-
orientation :"horizontal"|"vertical"
-
Specify the orientation of the slider.
- Default Value:
"horizontal"
- Since:
- 0.7.0
Supported Values:
Value Description horizontal
Orient the slider horizontally. vertical
Orient the slider vertically. Names
Item Name Property orientation
Property change event orientationChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-orientation-changed
-
(nullable) step :number
-
Determines the size or amount of each interval or step the slider takes between min and max. The full specified value of the range (max - min) should be divisible by step.
- Default Value:
1
- Since:
- 0.7.0
Names
Item Name Property step
Property change event stepChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-step-changed
-
(readonly) transient-value :number
-
The
transientValue
is the read-only attribute for retrieving the transient value from the slider.The
transientValue
updates to display the transient changes of the slider thumb value (subject to the step constraints). The difference in behavior istransientValue
will be updated as the thumb is sliding, where asvalue
is updated only after the thumb is released (or after a key press).This is a read-only attribute so page authors cannot set or change it directly.
- Supports writeback:
true
- Since:
- 5.0
Names
Item Name Property transientValue
Property change event transientValueChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-transient-value-changed
-
translations :object|null
-
A collection of translated resources from the translation bundle, or
null
if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.If the component does not contain any translatable resource, the default value of this attribute will be
null
. If not, an object containing all resources relevant to the component.If this component has translations, their documentation immediately follows this doc entry.
Names
Item Name Property translations
Property change event translationsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-translations-changed
-
(nullable) translations.invalid-step :string
-
Invalid step value.
See the translations attribute for usage examples.
- Default Value:
"Invalid step; step must be > 0"
- Since:
- 1.1.1
Names
Item Name Property translations.invalidStep
-
(nullable) translations.max-min :string
-
Max is greater than min.
See the translations attribute for usage examples.
- Default Value:
"Max must not be less than min"
- Since:
- 1.1.1
Names
Item Name Property translations.maxMin
-
(nullable) translations.no-value :string
-
Missing value exception.
See the translations attribute for usage examples.
- Default Value:
"ojSlider has no value"
- Since:
- 1.1.1
Names
Item Name Property translations.noValue
-
(nullable) translations.option-num :string
-
The option is not a number.
See the translations attribute for usage examples.
- Default Value:
"{option} option is not a number"
- Since:
- 1.1.1
Names
Item Name Property translations.optionNum
-
(nullable) translations.value-range :string
-
Value outside min to max range.
See the translations attribute for usage examples.
- Default Value:
"Value must be within min to max range"
- Since:
- 1.1.1
Names
Item Name Property translations.valueRange
-
(nullable) type :"fromMin"|"fromMax"|"single"
-
The slider type determines how the value is represented in the UI.
- Default Value:
"fromMin"
- Since:
- 0.7.0
Supported Values:
Value Description fromMax
A single-thumb slider where the value bar goes from the slider thumb to the slider max. fromMin
A single-thumb slider where the value bar goes from the slider min to the slider thumb. single
A single-thumb slider where the value bar has no additional styling. Names
Item Name Property type
Property change event typeChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-type-changed
-
user-assistance-density :('reflow'|'efficient'|'compact')
-
Note: This attribute is not supported in the following themes:
Alta
-
Specifies the density of the form component's user assistance presentation. It can be shown inline with reserved rows to prevent reflow if a user assistance text shows up, inline without reserved rows that would reflow if a user assistance text shows up, or it can be shown compactly in a popup instead.
The default value is 'reflow' when the form component is not a descendent of an oj-form-layout component. When the form component is a descendent of an oj-form-layout, the default value comes from the oj-form-layout's
user-assistance-density
attribute value.The oj-form-layout component uses the MetadataTypes.PropertyBinding
provide
property to provide itsuser-assistance-density
attribute value to be consumed by descendent components. The form components are configured to consume theuser-assistance-density
property if an ancestor provides it and it is not explicitly set on the form component. Example, oj-form-layout defaults user-assistance-density='efficient', so all its form components descendents will have user-assistance-density='efficient' by default.- Default Value:
"reflow"
- Since:
- 9.0.0
Supported Values:
Value Description compact
Messages, help, hints, and required will not be shown inline; they will show in a mode that keeps the screen more compact, like a popup for the messages, and a required icon to indicate Required. efficient
Messages, help, hints, and required are all shown inline under the field with reserved space. reflow
Messages, help, hints, and required are all shown inline under the field with no reserved space. Names
Item Name Property userAssistanceDensity
Property change event userAssistanceDensityChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-user-assistance-density-changed
-
(readonly) valid :"valid"|"pending"|"invalidHidden"|"invalidShown"
-
The current valid state of the component. It is evaluated on initial render. It is re-evaluated
- after each validator (validators or async-validators) is run (full or deferred)
- when messagesCustom is updated, since messagesCustom can be added by the app developer any time, and error messages make the valid state 'invalidShown'.
- when showMessages() is called. Since showMessages() moves the hidden messages into messages shown, if the valid state was "invalidHidden" then it would become "invalidShown".
- when the required property has changed. If a component is empty and has required set, the valid state may be "invalidHidden" (if no invalid messages are being shown as well). If required property is removed, the valid state would change to "valid".
Note: New valid states may be added to the list of valid values in future releases. Any new values will start with "invalid" if it is an invalid state, "pending" if it is pending state, and "valid" if it is a valid state.
- Supports writeback:
true
- Since:
- 4.2.0
Supported Values:
Value Description invalidHidden
The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity "error" or higher. invalidShown
The component has invalid messages showing. An invalid message is one with severity "error" or higher. pending
The component is waiting for the validation state to be determined. The "pending" state is set at the start of the convert/validate process. valid
The component is valid Names
Item Name Property valid
Property change event validChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-valid-changed
-
(nullable) value :number
-
The numerical value of the slider.
Note that the
value
attribute should be compatible with thetype
attribute, as described above.- Default Value:
0
- Supports writeback:
true
- Since:
- 0.7.0
Names
Item Name Property value
Property change event valueChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-value-changed
Events
-
ojAnimateEnd
-
Triggered when a default animation has ended.
- "inline-open" - when an inline message container opens or increases in size
- "inline-close" - when an inline message container closes or decreases in size
- "notewindow-open" - when a note window opens
- "notewindow-close" - when a note window closes
- Since:
- 12.1.0
Properties:
All of the event payloads listed below can be found under
event.detail
. See Events and Listeners for additional information.Name Type Description action
string The action that triggered the animation.
Supported values are:element
Element The element being animated. -
ojAnimateStart
-
Triggered when a default animation is about to start on an element owned by the component.
The default animation can be cancelled by calling
event.preventDefault
, followed by a call toevent.detail.endCallback
.event.detail.endCallback
should be called immediately afterevent.preventDefault
if the application merely wants to cancel animation, or it should be called when the custom animation ends if the application is invoking another animation function. Failure to callevent.detail.endCallback
may prevent the component from working properly.For more information on customizing animations, see the documentation of AnimationUtils.
The default animations are controlled via the theme:// default animations for notewindow help and hints and messages $popupTailOpenAnimation: (effect: "zoomIn", transformOrigin: "#myPosition") !default; $popupTailCloseAnimation: (effect: "none") !default; // default animations for Redwood's inline messages shown when userAssistanceDensity // is reflow or efficient. $messageComponentInlineOpenAnimation: (effect: "fadeIn", duration: "100ms", timingFunction: "linear") !default; $messageComponentInlineCloseAnimation: (effect: "fadeOut", duration: "100ms", timingFunction: "linear") !default;
- "inline-hints-open" - when an inline helphints container opens
- "inline-hints-close" - when an inline helphints container closes
- "inline-open" - when an inline message container opens or increases in size
- "inline-close" - when an inline message container closes or decreases in size
- "notewindow-open" - when a note window opens
- "notewindow-close" - when a note window closes
- Since:
- 12.1.0
Properties:
All of the event payloads listed below can be found under
event.detail
. See Events and Listeners for additional information.Name Type Description action
string The action that triggers the animation.
Supported values are:element
Element The element being animated. endCallback
function():void If the event listener calls event.preventDefault to cancel the default animation, it must call the endCallback function when it finishes its own animation handling and any custom animation has ended.
Methods
-
getProperty(property) : {any}
-
Retrieves the value of a property or a subproperty. The return type will be the same as the type of the property as specified in this API document. If the method is invoked with an incorrect property/subproperty name, it returns undefined.
Parameters:
Name Type Description property
string The property name to get. Supports dot notation for subproperty access. - Since:
- 4.0.0
Returns:
- Type
- any
Example
Get a single subproperty of a complex property:
let subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');
-
refresh : {void}
-
Called when the DOM underneath the component changes requiring a re-render of the component. An example is when the
id
for the input changes.
Another time when refresh might be called is when the locale for the page changes. When it changes, attributes used by its converter and validator that are locale specific, its hints, messages and translations will be updated.
When
refresh
method is called, the component may take various steps such as clearing messages, running validation etc., based on the state it is in.
Steps Performed Always
- The converter and validators used by the component are reset, and new converter and validator hints is pushed to messaging. E.g., notewindow displays the new hint(s).
Running Validation
- if component is valid when refresh() is called, the display value is refreshed if component has a converter set.
- if component is invalid and is showing messages when
refresh()
is called, then all component messages are cleared and full validation run using the display value on the component.- if there are validation errors, then
value
attribute is not updated and the error is shown. - if no errors result from the validation, the
value
attribute is updated; page author can listen to thevalueChanged
event to clear custom errors.
- if there are validation errors, then
- if component is invalid and has deferred messages when
refresh()
is called, then all component messages are cleared and deferred validation is run.
Clearing Messages
- If clearing messages only those created by the component are cleared.
messagesCustom
attribute is not cleared.
- Since:
- 0.7.0
Returns:
- Type
- void
-
reset : {void}
-
Resets the component by clearing all messages and messages attributes -
messagesCustom
- and updates the component's display value using the attribute value. User entered values will be erased when this method is called.- Since:
- 0.7.0
Returns:
- Type
- void
-
setProperties(properties) : {void}
-
Performs a batch set of properties. The type of value for each property being set must match the type of the property as specified in this API document.
Parameters:
Name Type Description properties
Object An object containing the property and value pairs to set. - Since:
- 4.0.0
Returns:
- Type
- void
Example
Set a batch of properties:
myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});
-
setProperty(property, value) : {void}
-
Sets a property or a subproperty (of a complex property) and notifies the component of the change, triggering a [property]Changed event. The value should be of the same type as the type of the attribute mentioned in this API document.
Parameters:
Name Type Description property
string The property name to set. Supports dot notation for subproperty access. value
any The new value to set the property to. - Since:
- 4.0.0
Returns:
- Type
- void
Example
Set a single subproperty of a complex property:
myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");
-
showMessages : {void}
-
Takes all deferred messages and shows them. It then updates the valid property; e.g., if the valid state was "invalidHidden" before showMessages(), the valid state will become "invalidShown" after showMessages().
If there were no deferred messages this method simply returns.
Messages are shown on an enabled component, but not on a readonly or disabled component.
- Since:
- 0.7.0
Returns:
- Type
- void