CraydelRadioGroup
Installation
Get the latest version by NPM:
$ npm i @craydel/craydel-radio-group
Register Plugin
If you use the plugin API, the component will be registered as a global component just like when
including it with the script tag, but you won't need to re-register it through the components
property in your own
components.
Create the plugin file e.g craydel-components.js
file.
// craydel-components.js
import Vue from 'vue'
import CraydelRadioGroup from '@craydel/craydel-radio-group/src/CraydelRadioGroup.vue'
const Components = {
CraydelRadioGroup,
};
Object.keys(Components).forEach(name => {
Vue.component(name, Components[name]);
});
export default Components;
Next reference the plugin file in your nuxt.config.js
// Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
plugins: [
'~/plugins/craydel-components.js'
]
Props
Name | Type | Default | Description |
---|---|---|---|
id | string | random ID | Sets the DOM id on the component. |
is-required | boolean | false | Puts component in a required state. |
required-error | string | 'Field is required' | Puts the component in an error state and passes through the custom required error message. |
hint | string | undefined | Hint text. |
items | array | [] | Can be an array of objects or array of strings. When using objects, will look for a label and value keys. |
row | boolean | false | Displays radio buttons in a row. |
Events
Name | Description |
---|---|
change | Emitted when the input is changed by user interaction. |
Usage
An example showing a radio group.
<craydel-radio-group :items="items"></craydel-radio-group>
data()
{
return {
items: [
{
label: 'Radio 1',
value: '1'
},
{
label: 'Radio 2',
value: '2'
},
{
label: 'Radio 3',
value: '3'
}
]
}
}