@vonage/vivid-react/v3/VwcRadioGroup/index.js

Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings

/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
 "kind": "class",
 "description": "",
 "name": "RadioGroup",
 "slots": [
  {
   "description": "Default slot.",
   "name": ""
  },
  {
   "description": "Describes how to use the text-field. Alternative to the `helper-text` attribute.",
   "name": "helper-text"
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "label",
   "type": {
    "text": "string"
   },
   "description": "The label for the radio group",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "required",
   "type": {
    "text": "boolean"
   },
   "description": "When true, the radio group and all its radio buttons will be required",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "readOnly",
   "type": {
    "text": "boolean"
   },
   "description": "When true, the child radios 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": "disabled",
   "type": {
    "text": "boolean"
   },
   "description": "Disables the radio group and child radios.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "name",
   "type": {
    "text": "string"
   },
   "description": "The name of the radio group. Setting this value will set the name value\nfor all child radio elements.",
   "privacy": "public"
  },
  {
   "kind": "method",
   "name": "nameChanged",
   "return": {
    "type": {
     "text": "void"
    }
   }
  },
  {
   "kind": "field",
   "name": "value",
   "type": {
    "text": "string"
   },
   "description": "The value of the checked radio",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "errorText",
   "type": {
    "text": "string"
   }
  },
  {
   "kind": "field",
   "name": "orientation",
   "type": {
    "text": "Orientation | 'horizontal' | 'vertical'"
   },
   "description": "The orientation of the group",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "#focusableRadioButtons",
   "privacy": "private",
   "readonly": true
  },
  {
   "kind": "field",
   "name": "isInsideToolbar",
   "type": {
    "text": "boolean"
   },
   "privacy": "private",
   "readonly": true
  },
  {
   "kind": "field",
   "name": "radioErrorHandler",
   "privacy": "private"
  },
  {
   "kind": "method",
   "name": "setupRadioButtons",
   "privacy": "private",
   "return": {
    "type": {
     "text": "void"
    }
   }
  },
  {
   "kind": "field",
   "name": "radioChangeHandler",
   "privacy": "private"
  },
  {
   "kind": "field",
   "name": "moveToRadioByIndex",
   "privacy": "private"
  },
  {
   "kind": "field",
   "name": "moveRightOffGroup",
   "privacy": "private"
  },
  {
   "kind": "field",
   "name": "moveLeftOffGroup",
   "privacy": "private"
  },
  {
   "kind": "method",
   "name": "#setTabRovingTarget",
   "parameters": [
    {
     "name": "radio",
     "type": {
      "text": "Radio"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "checkFocusedRadio",
   "privacy": "private",
   "parameters": [
    {
     "name": "target",
     "type": {
      "text": "Radio"
     }
    }
   ]
  },
  {
   "kind": "field",
   "name": "moveRight",
   "privacy": "private"
  },
  {
   "kind": "field",
   "name": "moveLeft",
   "privacy": "private"
  },
  {
   "kind": "field",
   "name": "helperText",
   "type": {
    "text": "string | undefined"
   },
   "description": "Provides additional information to help the user enter the correct information.\nTo add HTML to the helper text, use the helper-text slot instead.",
   "privacy": "public",
   "inheritedFrom": {
    "name": "WithFeedback",
    "module": "src/shared/feedback/mixins.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 value changes",
   "name": "change"
  }
 ],
 "attributes": [
  {
   "name": "label",
   "type": {
    "text": "string"
   },
   "description": "The label for the radio group",
   "fieldName": "label"
  },
  {
   "name": "required",
   "type": {
    "text": "boolean"
   },
   "description": "When true, the radio group and all its radio buttons will be required",
   "fieldName": "required"
  },
  {
   "name": "readonly",
   "type": {
    "text": "boolean"
   },
   "description": "When true, the child radios 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": "disabled",
   "type": {
    "text": "boolean"
   },
   "description": "Disables the radio group and child radios.",
   "fieldName": "disabled"
  },
  {
   "name": "name",
   "type": {
    "text": "string"
   },
   "description": "The name of the radio group. Setting this value will set the name value\nfor all child radio elements.",
   "fieldName": "name"
  },
  {
   "name": "value",
   "type": {
    "text": "string"
   },
   "description": "The value of the checked radio",
   "fieldName": "value"
  },
  {
   "name": "error-text",
   "type": {
    "text": "string"
   },
   "fieldName": "errorText"
  },
  {
   "name": "orientation",
   "type": {
    "text": "Orientation | 'horizontal' | 'vertical'"
   },
   "description": "The orientation of the group",
   "fieldName": "orientation"
  },
  {
   "name": "helper-text",
   "type": {
    "text": "string | undefined"
   },
   "description": "Provides additional information to help the user enter the correct information.\nTo add HTML to the helper text, use the helper-text slot instead.",
   "fieldName": "helperText",
   "inheritedFrom": {
    "name": "WithFeedback",
    "module": "src/shared/feedback/mixins.ts"
   }
  }
 ],
 "mixins": [
  {
   "name": "WithFeedback",
   "module": "/src/shared/feedback/mixins"
  }
 ],
 "superclass": {
  "name": "VividElement",
  "module": "/src/shared/foundation/vivid-element/vivid-element"
 },
 "vividComponent": {
  "public": true,
  "name": "radio-group",
  "vueModels": [
   {
    "name": "modelValue",
    "propName": "value",
    "eventNames": [
     "change"
    ],
    "valueMapping": "event.currentTarget.value"
   }
  ]
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerRadioGroup } from '@vonage/vivid'

registerRadioGroup('vvd3')

const VwcRadioGroup = wrapper(`vvd3-radio-group`,  {
    events: [{"name":"change","propName":"onChange"}],
    attributes: [],
    properties: ['label', 'required', 'readOnly', 'disabled', 'name', 'value', 'errorText', 'orientation', 'helperText', 'VIVID_VERSION', 'componentName']
})

VwcRadioGroup.displayName = 'VwcRadioGroup'

export default VwcRadioGroup