---
You can customize icon, theme or color for Checkbox/Radio
Vue /React/ Svelte
---
### Usage
Install the package
```js
npm install --save vue-radio-checkbox-z
```
Import the module in the place you want to use:
```js
import RadioCheckBox from "vue-radio-checkbox-z";
Vue.component('RadioCheckBox', RadioCheckBox)
```
### Snippet
```js
options: [
{ label: 'label1', value:'label1' },
'label2',
'label3',
// ...more,
// { label, value, disabled, className: 'itemClass', labelClassName: 'labelClass',... }
],
value: 'label1' //
// value: ['label1'] // radio || checkbox
// don't check duplicate value in options, so please pass unique value
```
### Props
The following props are accepted:
#### value (`Array` || `String`)
Selected value.
#### groupName (`String`)
groupName of radio/checkbox. Default (random) unique of RadioCheckBox
if you want to use multiple RadioCheckBox(same name), you can set the group name
```js
```
#### options (`Array`)
list data like. `[Object, String, ...]`
```js
[
{
label: 'Display', value: 'value', disabled: false, // disabled option
className: 'itemClass', labelClassName: 'labelClass',
htmlTemplate, // you chane change display label by htmlTemplate
checkedIcon // passing custom checked icon
},
...,
'value' // => make option { label: value, value: value }
]
```
#### disabled (`boolean`)
Disabled all options. Default `false`
#### checkBox (`boolean`)
Type is checkbox. Default `false` (radio)
#### displayBox (`boolean`)
Show check mark icon like a checkbox. Default `false` (radio)
#### vertical (`boolean`)
Display vertical `true`. Defaut `false`
#### theme (`String`)
```js
// default (nothing) of html
in: [
'fill', 'in', 'out',
'tick', 'tick-fill', 'tick-fill-in',
'x', 'x-fill', 'x-fill-in'
]
```
#### selectColor (`String`)
color when checked. Default [#4169E1]
#### unSelectColor (`String`)
color when unchecked. Default [#cbd1d8]
#### hoverColor (`String`)
color when hover. Default using (selectColor)
#### tickColor (`String`)
Use when `theme` = `tick..` || `x..`
`Color of tick when check.`
#### tabFocusColor (`String`)
box shadow color when focus by tab. (`#000`)
#### height (`number` or `number_px`)
min-height of line-options. (default: `24px`)
#### boxSize (`number` or `number_px`)
size of check. (default: `16px`)
#### className
The className added to group.
#### checkedIcon
customize checked icon (see live example)
###### customize icon check (another solution)
`You should refrain from using this method.`
With theme: `x...` || `tick...`
You can override css to see custom tick.
```css
/* set your className(.itemClass) for selector unique */
.itemClass.ldk-ve-radio-checkbox .ve-option-checked .ve-option-icon {
background: url('./assets/images/cal.png') no-repeat center;
}
.itemClass.ldk-ve-radio-checkbox .ve-option-checked .ve-option-icon::before {
content: '' !important;
}
```
### Example
LIVE EXAMPLE
A working example can be found in the `example` directory.
```js
npm install
```
```js
npm run dev
npm run start
```
### License
MIT