# @sinoui/calendar

> 遵循 Material Design 的日历效果实现

Latest version **0.1.0-beta.0** (published 2020-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sinoui/calendar
pnpm add @sinoui/calendar
yarn add @sinoui/calendar
bun add @sinoui/calendar
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-beta.0 |
| Published | 2020-04-14 |
| First published | 2020-04-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 12 |
| Unpacked size | 421.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | chenaihua, tianyanqiu, jackingliu |

## Links

- npm: https://www.npmjs.com/package/@sinoui/calendar
- Repository: https://github.com/sinoui/calendar
- Homepage: https://sinoui.github.io/calendar
- Issues: https://github.com/sinoui/calendar/issues
- npm.io page: https://npm.io/package/@sinoui/calendar

## Dependencies (12)

- [dayjs](https://npm.io/package/dayjs.md) ^1.8.19
- [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.15
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [react-icons](https://npm.io/package/react-icons.md) ^3.8.0
- [@sinoui/theme](https://npm.io/package/@sinoui/theme.md) ^0.3.5
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.8.3
- [@babel/polyfill](https://npm.io/package/@babel/polyfill.md) ^7.8.3
- [@types/classnames](https://npm.io/package/@types/classnames.md) ^2.2.9
- [sinoui-components](https://npm.io/package/sinoui-components.md) ^0.2.9
- [react-transition-group](https://npm.io/package/react-transition-group.md) ^4.3.0
- [@types/styled-components](https://npm.io/package/@types/styled-components.md) ^4.4.2
- [@types/react-transition-group](https://npm.io/package/@types/react-transition-group.md) ^4.2.3

## Recent versions

- 0.1.0-beta.0 (latest) — 2020-04-14

## README

# calendar [![npm version](https://img.shields.io/npm/v/@sinoui/calendar)](https://www.npmjs.com/package/@sinoui/calendar) [![downloads](https://img.shields.io/npm/dm/@sinoui/calendar)](https://www.npmjs.com/package/@sinoui/calendar)

日历。遵循 [Material Design States](https://material.io/design/interaction/states.html#usage) 规范。 [文档](https://sinoui.github.io/calendar)

## 安装

```shell
yarn add @sinoui/calendar
```

## 使用

```tsx
import Calendar from '@sinoui/calendar';

function CalendarDemo() {
  return <Calendar />;
}
```

## 本地开发

项目中有以下有用的命令。

### `yarn start`

在开发和监听模式下启动项目。当代码发生变化时就会重新编译代码。它同时会实时地向你汇报项目中的代码错误。

### `yarn build`

打包，并将打包文件放在`dist`文件夹中。使用 rollup 对代码做优化并打包成多种格式（`Common JS`，`UMD`和`ES Module`）。

### `yarn lint`

`yarn lint`会检查整个项目是否有代码错误、风格错误。

开启 vscode 的 eslint、prettier 插件，在使用 vscode 编码时，就会自动修正风格错误、提示语法错误。

### `yarn format`

`yarn format`可以自动调整整个项目的代码风格问题。

### `yarn test`

`yarn test`以监听模式启动 jest，运行单元测试。

开启 vscode 的 jest 插件，会在文件变化时自动运行单元测试。

### 预览文档

```shell
yarn doc:dev
```

### 编译并打包文档

```shell
yarn doc:publish
```

### 发布文档

在发布文档之前，在`package.json`中配置好`homepage`，如下所示：

```json
{
  "homepage": "https://sinouiincubator.github.io/editable-data-table"
}
```

配置完之后就可以执行下面的命令行发布文档：

```shell
yarn doc:publish
```

# calendar

---
_Source: https://npm.io/package/@sinoui/calendar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._