@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
766 lines (761 loc) • 16.8 kB
JavaScript
/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
"kind": "class",
"description": "",
"name": "Slider",
"cssProperties": [
{
"name": "--vvd-slider-cta-primary",
"default": "var(--vvd-color-cta-500)"
},
{
"name": "--vvd-slider-accent-primary",
"default": "var(--vvd-color-canvas-text)"
}
],
"members": [
{
"kind": "field",
"name": "readOnly",
"type": {
"text": "boolean"
},
"description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
"privacy": "public"
},
{
"kind": "field",
"name": "valueAsNumber",
"type": {
"text": "number"
},
"description": "The value property, typed as a number.",
"privacy": "public"
},
{
"kind": "field",
"name": "valueTextFormatter",
"type": {
"text": "(value: string) => string"
},
"description": "Custom function that generates a string for the component's \"aria-valuetext\" attribute based on the current value.",
"privacy": "public"
},
{
"kind": "field",
"name": "min",
"type": {
"text": "number"
},
"default": "0",
"description": "The minimum allowed value.",
"privacy": "public"
},
{
"kind": "field",
"name": "max",
"type": {
"text": "number"
},
"default": "10",
"description": "The maximum allowed value.",
"privacy": "public"
},
{
"kind": "field",
"name": "step",
"type": {
"text": "number"
},
"default": "1",
"description": "Value to increment or decrement via arrow keys, mouse click or drag.",
"privacy": "public"
},
{
"kind": "field",
"name": "orientation",
"type": {
"text": "Orientation"
},
"description": "The orientation of the slider.",
"privacy": "public"
},
{
"kind": "field",
"name": "mode",
"type": {
"text": "SliderMode"
},
"description": "The selection mode.",
"privacy": "public"
},
{
"kind": "method",
"name": "increment",
"return": {
"type": {
"text": "void"
}
},
"description": "Increment the value by the step",
"privacy": "public"
},
{
"kind": "method",
"name": "decrement",
"return": {
"type": {
"text": "void"
}
},
"description": "Decrement the value by the step",
"privacy": "public"
},
{
"kind": "field",
"name": "keypressHandler",
"privacy": "protected"
},
{
"kind": "method",
"name": "setThumbPositionForOrientation",
"privacy": "public",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "_",
"type": {
"text": "Direction"
}
},
{
"description": "writing mode",
"name": "direction"
}
],
"description": "Places the thumb based on the current value"
},
{
"kind": "method",
"name": "#thumbTrackEndOffset",
"parameters": [
{
"name": "value",
"type": {
"text": "number"
}
}
]
},
{
"kind": "method",
"name": "updateStepMultiplier",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"description": "Update the step multiplier used to ensure rounding errors from steps that\nare not whole numbers"
},
{
"kind": "field",
"name": "setupTrackConstraints",
"privacy": "private"
},
{
"kind": "field",
"name": "setupListeners",
"privacy": "private"
},
{
"kind": "field",
"name": "midpoint",
"type": {
"text": "string"
},
"privacy": "private",
"readonly": true
},
{
"kind": "method",
"name": "setupDefaultValue",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "handleThumbMouseDown",
"privacy": "private",
"description": "Handle mouse moves during a thumb drag operation\nIf the event handler is null it removes the events"
},
{
"kind": "field",
"name": "handleMouseMove",
"privacy": "private",
"description": "Handle mouse moves during a thumb drag operation"
},
{
"kind": "method",
"name": "#calculateValueFromMouseEvent",
"parameters": [
{
"name": "e",
"type": {
"text": "Pick<MouseEvent, 'pageX' | 'pageY'>"
}
}
]
},
{
"kind": "field",
"name": "handleWindowMouseUp",
"privacy": "private",
"description": "Handle a window mouse up during a drag operation"
},
{
"kind": "field",
"name": "stopDragging",
"privacy": "private"
},
{
"kind": "field",
"name": "handleMouseDown",
"privacy": "private",
"parameters": [
{
"description": "MouseEvent or null. If there is no event handler it will remove the events",
"name": "e"
}
],
"description": ""
},
{
"kind": "method",
"name": "#roundToNearestStep",
"parameters": [
{
"name": "value",
"type": {
"text": "number"
}
}
]
},
{
"kind": "field",
"name": "markers",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Display markers on/off",
"privacy": "public"
},
{
"kind": "field",
"name": "pin",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Show current value on the thumb.",
"privacy": "public"
},
{
"kind": "field",
"name": "connotation",
"type": {
"text": "SliderConnotation | undefined"
},
"description": "slider connotation",
"privacy": "public"
},
{
"kind": "field",
"name": "#isNonVisibleFocus",
"privacy": "private",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "method",
"name": "#registerThumbListeners"
},
{
"kind": "method",
"name": "#unregisterThumbListeners"
},
{
"kind": "field",
"name": "#onMouseOver",
"privacy": "private"
},
{
"kind": "field",
"name": "#onMouseOut",
"privacy": "private"
},
{
"kind": "field",
"name": "_vividAriaBehaviour",
"default": "'delegate'",
"type": {
"text": "'delegate'"
},
"inheritedFrom": {
"name": "DelegatesAria",
"module": "src/shared/aria/delegates-aria.ts"
}
},
{
"kind": "field",
"name": "validity",
"type": {
"text": "ValidityState"
},
"description": "Returns the validity state of the element",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "form",
"type": {
"text": "HTMLFormElement | null"
},
"description": "Retrieve a reference to the associated form.\nReturns null if not associated to any form.",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "validationMessage",
"type": {
"text": "string"
},
"description": "Retrieve the localized validation message,\nor custom validation message if set.",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "willValidate",
"type": {
"text": "boolean"
},
"description": "Whether the element will be validated when the\nform is submitted",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "labels",
"type": {
"text": "ReadonlyArray<Node>"
},
"description": "A reference to all associated label elements",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "value",
"type": {
"text": "string"
},
"description": "The current value of the element.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "currentValue",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "initialValue",
"type": {
"text": "string"
},
"description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "disabled",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "name",
"type": {
"text": "string"
},
"description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "required",
"type": {
"text": "boolean"
},
"description": "Require the field to be completed prior to form submission.",
"default": "false",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "method",
"name": "checkValidity",
"return": {
"type": {
"text": "boolean"
}
},
"description": "Return the current validity of the element.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "method",
"name": "reportValidity",
"return": {
"type": {
"text": "boolean"
}
},
"description": "Return the current validity of the element.\nIf false, fires an invalid event at the element.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "VIVID_VERSION",
"static": true,
"default": "__PACKAGE_VERSION__",
"description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.",
"type": {
"text": "string"
},
"inheritedFrom": {
"name": "VividElement",
"module": "src/shared/foundation/vivid-element/vivid-element.ts"
}
},
{
"kind": "field",
"name": "componentName",
"type": {
"text": "string"
},
"static": true,
"description": "Core component name, without prefix",
"inheritedFrom": {
"name": "VividElement",
"module": "src/shared/foundation/vivid-element/vivid-element.ts"
}
}
],
"events": [
{
"type": {
"text": "CustomEvent<undefined>"
},
"description": "Fires a custom 'change' event when the slider value changes",
"name": "change"
}
],
"attributes": [
{
"name": "readonly",
"type": {
"text": "boolean"
},
"description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
"fieldName": "readOnly"
},
{
"name": "min",
"type": {
"text": "number"
},
"default": "0",
"description": "The minimum allowed value.",
"fieldName": "min"
},
{
"name": "max",
"type": {
"text": "number"
},
"default": "10",
"description": "The maximum allowed value.",
"fieldName": "max"
},
{
"name": "step",
"type": {
"text": "number"
},
"default": "1",
"description": "Value to increment or decrement via arrow keys, mouse click or drag.",
"fieldName": "step"
},
{
"name": "orientation",
"type": {
"text": "Orientation"
},
"description": "The orientation of the slider.",
"fieldName": "orientation"
},
{
"name": "mode",
"type": {
"text": "SliderMode"
},
"description": "The selection mode.",
"fieldName": "mode"
},
{
"name": "markers",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Display markers on/off",
"fieldName": "markers"
},
{
"name": "pin",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Show current value on the thumb.",
"fieldName": "pin"
},
{
"name": "connotation",
"type": {
"text": "SliderConnotation | undefined"
},
"description": "slider connotation",
"fieldName": "connotation"
},
{
"name": "current-value",
"type": {
"text": "string"
},
"description": "The current value of the element.",
"fieldName": "value",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "value",
"type": {
"text": "string"
},
"description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
"fieldName": "initialValue",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "disabled",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
"fieldName": "disabled",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "name",
"type": {
"text": "string"
},
"description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
"fieldName": "name",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "required",
"type": {
"text": "boolean"
},
"description": "Require the field to be completed prior to form submission.",
"default": "false",
"fieldName": "required",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
}
],
"mixins": [
{
"name": "Localized",
"module": "/src/shared/patterns"
},
{
"name": "DelegatesAria",
"module": "/src/shared/aria/delegates-aria"
},
{
"name": "FormAssociated",
"module": "/src/shared/foundation/form-associated/form-associated"
}
],
"superclass": {
"name": "VividElement",
"module": "/src/shared/foundation/vivid-element/vivid-element"
},
"vividComponent": {
"public": true,
"name": "slider",
"vueModels": [
{
"name": "modelValue",
"propName": "value",
"eventNames": [
"change"
],
"valueMapping": "event.currentTarget.value"
},
{
"name": "valueAsNumber",
"propName": "valueAsNumber",
"eventNames": [
"change"
],
"valueMapping": "event.currentTarget.valueAsNumber"
}
]
},
"vividTesting": {
"selectors": [
{
"name": "byLabel",
"args": [
"byLabel"
]
}
],
"actions": [
{
"name": "slideTo",
"args": [
"slideTo",
"#track",
"#thumb"
]
}
],
"queries": [
{
"name": "valueAsNumber",
"args": [
"valueAsNumber"
]
}
],
"refs": [
{
"name": "track",
"args": [
"shadow",
".control"
]
},
{
"name": "thumb",
"args": [
"shadow",
".thumb-container"
]
}
]
}
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerSlider } from '@vonage/vivid'
registerSlider('vvd3')
const VwcSlider = wrapper(`vvd3-slider`, {
events: [{"name":"change","propName":"onChange"}],
attributes: [],
properties: ['min', 'max', 'step', 'orientation', 'markers', 'connotation', 'pin', 'disabled', 'value', 'readOnly', 'valueAsNumber', 'valueTextFormatter', 'min', 'max', 'step', 'orientation', 'mode', 'markers', 'pin', 'connotation', '_vividAriaBehaviour', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
})
VwcSlider.displayName = 'VwcSlider'
export default VwcSlider