@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
248 lines (243 loc) • 5.46 kB
JavaScript
/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
"kind": "class",
"description": "",
"name": "ProgressRing",
"cssProperties": [
{
"name": "--vvd-progress-ring-cta-firm",
"default": "var(--vvd-color-cta-600)"
},
{
"name": "--vvd-progress-ring-alert-firm",
"default": "var(--vvd-color-alert-600)"
},
{
"name": "--vvd-progress-ring-success-firm",
"default": "var(--vvd-color-success-600)"
},
{
"name": "--vvd-progress-ring-accent-firm",
"default": "var(--vvd-color-canvas-text)"
}
],
"members": [
{
"kind": "field",
"name": "connotation",
"type": {
"text": "ProgressRingConnotation | undefined"
}
},
{
"kind": "field",
"name": "size",
"type": {
"text": "-6 | -5 | -4 | -3 | -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5 | undefined"
}
},
{
"kind": "field",
"name": "_vividAriaBehaviour",
"default": "'delegate'",
"type": {
"text": "'delegate'"
},
"inheritedFrom": {
"name": "DelegatesAria",
"module": "src/shared/aria/delegates-aria.ts"
}
},
{
"kind": "field",
"name": "value",
"type": {
"text": "number | null"
},
"description": "The value of the progress",
"privacy": "public",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"kind": "field",
"name": "min",
"type": {
"text": "number"
},
"description": "The minimum value",
"privacy": "public",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"kind": "field",
"name": "max",
"type": {
"text": "number"
},
"description": "The maximum value",
"privacy": "public",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"kind": "method",
"name": "maxChanged",
"privacy": "private",
"description": "",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"kind": "field",
"name": "paused",
"type": {
"text": "boolean"
},
"description": "Indicates the progress is paused",
"privacy": "public",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"kind": "method",
"name": "updatePercentComplete",
"privacy": "private",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.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"
}
}
],
"attributes": [
{
"name": "connotation",
"type": {
"text": "ProgressRingConnotation | undefined"
},
"fieldName": "connotation"
},
{
"name": "size",
"type": {
"text": "-6 | -5 | -4 | -3 | -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5 | undefined"
},
"fieldName": "size"
},
{
"name": "value",
"type": {
"text": "number | null"
},
"description": "The value of the progress",
"fieldName": "value",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"name": "min",
"type": {
"text": "number"
},
"description": "The minimum value",
"fieldName": "min",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"name": "max",
"type": {
"text": "number"
},
"description": "The maximum value",
"fieldName": "max",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
},
{
"name": "paused",
"type": {
"text": "boolean"
},
"description": "Indicates the progress is paused",
"fieldName": "paused",
"inheritedFrom": {
"name": "BaseProgress",
"module": "src/shared/foundation/progress/base-progress.ts"
}
}
],
"mixins": [
{
"name": "DelegatesAria",
"module": "/src/shared/aria/delegates-aria"
}
],
"superclass": {
"name": "BaseProgress",
"module": "/src/shared/foundation/progress/base-progress"
},
"vividComponent": {
"public": true,
"name": "progress-ring"
}
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerProgressRing } from '@vonage/vivid'
registerProgressRing('vvd3')
const VwcProgressRing = wrapper(`vvd3-progress-ring`, {
events: [],
attributes: [],
properties: ['connotation', 'size', '_vividAriaBehaviour', 'value', 'min', 'max', 'paused', 'VIVID_VERSION', 'componentName']
})
VwcProgressRing.displayName = 'VwcProgressRing'
export default VwcProgressRing