Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .dumirc.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { defineConfig } from 'dumi';

export default defineConfig({
themeConfig: {
name: 'Checkbox',
},
});
10 changes: 0 additions & 10 deletions .fatherrc.js

This file was deleted.

5 changes: 5 additions & 0 deletions .fatherrc.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { defineConfig } from 'father';

export default defineConfig({
plugins: ['@rc-component/father-plugin'],
});
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,13 @@ es
coverage
yarn.lock


# dumi
.umi
.dumi/tmp
.dumi/tmp-production
.umi-production
.umi-test
.docs
.docs

pnpm-lock.yaml
5 changes: 5 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx --no-install lint-staged --quiet
npx --no-install jest
8 changes: 0 additions & 8 deletions .umirc.ts

This file was deleted.

3 changes: 0 additions & 3 deletions docs/demo/simple.md

This file was deleted.

125 changes: 125 additions & 0 deletions docs/demo/simple.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
/* eslint no-console:0, jsx-a11y/label-has-for: 0, jsx-a11y/label-has-associated-control: 0 */
import React from 'react';
import Checkbox from 'rc-checkbox';
import '../../assets/index.less';

import type { CheckboxProps } from 'rc-checkbox';

const onChange = (e: any) => {
console.log('Checkbox checked:', e.target.checked);
};

const onKeyDown: CheckboxProps['onKeyDown'] = (e) => {
console.log('Checkbox key down:', e.key);
};

const onKeyPress: CheckboxProps['onKeyPress'] = (e) => {
console.log('Checkbox key press:', e.key);
};

const onKeyUp: CheckboxProps['onKeyUp'] = (e) => {
console.log('Checkbox key up:', e.key);
};

export default () => {
const [disabled, setDisabled] = React.useState(false);

const toggle = () => {
setDisabled((disabled) => !disabled);
};

return (
<div style={{ margin: 20 }}>
<div>
<p>
<label>
<Checkbox checked onChange={onChange} disabled={disabled} />
&nbsp; controlled checked rc-checkbox
</label>
&nbsp;&nbsp;
</p>
<p>
<label>
<input checked type="checkbox" onChange={onChange} disabled={disabled} />
&nbsp; controlled checked native
</label>
&nbsp;&nbsp;
</p>
</div>

<div>
<p>
<label>
<Checkbox defaultChecked onChange={onChange} disabled={disabled} />
&nbsp; defaultChecked rc-checkbox
</label>
&nbsp;&nbsp;
</p>
<p>
<label>
<input type="checkbox" defaultChecked onChange={onChange} disabled={disabled} />
&nbsp; defaultChecked native
</label>
&nbsp;&nbsp;
</p>
</div>

<div>
<p>
<label>
<Checkbox name="my-checkbox" defaultChecked onChange={onChange} disabled={disabled} />
&nbsp; defaultChecked rc-checkbox with name
</label>
&nbsp;&nbsp;
</p>
<p>
<label>
<input
name="my-checkbox"
type="checkbox"
defaultChecked
onChange={onChange}
disabled={disabled}
/>
&nbsp; defaultChecked native with name
</label>
&nbsp;&nbsp;
</p>
</div>

<div>
<p>
<label>
<Checkbox
onChange={onChange}
onKeyDown={onKeyDown}
onKeyPress={onKeyPress}
onKeyUp={onKeyUp}
disabled={disabled}
/>
&nbsp; rc-checkbox with key events
</label>
&nbsp;&nbsp;
</p>
<p>
<label>
<input
type="checkbox"
onChange={onChange}
onKeyDown={onKeyDown}
onKeyPress={onKeyPress}
onKeyUp={onKeyUp}
disabled={disabled}
/>
&nbsp; native checkbox with key events
</label>
&nbsp;&nbsp;
</p>
</div>

<button type="button" onClick={toggle}>
toggle disabled
</button>
</div>
);
};
8 changes: 8 additions & 0 deletions docs/example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Example
nav:
title: Example
path: /example
---

<code src="./demo/simple.tsx"></code>
139 changes: 0 additions & 139 deletions docs/examples/simple.jsx

This file was deleted.

28 changes: 28 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
hero:
title: rc-checkbox
description: checkbox ui component for react
---

## 📦 Install

```bash
# npm install
npm install rc-checkbox --save

# yarn install
yarn add rc-checkbox

# pnpm install
pnpm i rc-checkbox
```

## 🔨 Usage

```ts
import Checkbox from 'rc-checkbox';

export default () => {
return <Checkbox />;
};
```
10 changes: 10 additions & 0 deletions jest.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { createConfig } from '@umijs/test';

import type { Config } from '@umijs/test';

const config: Config.InitialOptions = {
...createConfig(),
testEnvironment: 'jsdom',
};

export default config;
Loading