Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@auraxy/react-radio-checkbox

auraxy272MIT2.4.8TypeScript support: included

react radio checkbox component

react, radio, checkbox

readme

@auraxy/react-radio-checkbox

NPM Version Download Month gzip with dependencies: kb typescript pkg.module

pkg.module supported, which means that you can apply tree-shaking in you project

中文文档

react radio checkbox component

Installation

npm i -S @auraxy/react-radio-checkbox

Global name - The variable the module exported in umd bundle

ReactRadioCheckbox

Interface

See what method or params you can use in index.d.ts

Usage

`typescript jsx import React, { useState } from 'react' import { Radio, Checkbox } from '@auraxy/react-radio-checkbox'

const items = [ { label: 'male', value: 1 }, { label: (item, isChecked) => isChecked ? <span style={{color: 'red'}}>female : 'female', value: 2 }, ]

const App = () => { const [gender, setGender] = useState() const [multiGender, setMultiGender] = useState([])

return ( <> <Radio value={gender} items={items} onChange={(val, item) => setGender(val)} /> <Checkbox value={multiGender} items={items} onChange={(val, currItem) => setMultiGender(val)} /> gender: {gender} multi gender: {multiGender.join(',')} </> ) }


Use in html, see what your can use in [CDN: unpkg](https://unpkg.com/@auraxy/react-radio-checkbox/lib/umd/)
```html
<-- use what you want -->
<script src="https://unpkg.com/@auraxy/react-radio-checkbox/lib/umd/<--module-->.js"></script>

style

For building style, you may need to import the css or scss file:

// scss
import '@auraxy/react-radio-checkbox/lib/css/index.scss'

// css
import '@auraxy/react-radio-checkbox/lib/css/index.css'

Or

// scss
@import 'node_modules/@auraxy/react-radio-checkbox/lib/css/index.scss'

// css
@import 'node_modules/@auraxy/react-radio-checkbox/lib/css/index.css'

Or, you can build your custom style by copying, editing and importing node_modules/@auraxy/react-radio-checkbox/lib/css/index.scss

QA

  1. Error Error: spawn node-sass ENOENT

You may need install node-sass globally, npm i -g node-sass