# react-clock

**Repository Path**: uiw/react-clock

## Basic Information

- **Project Name**: react-clock
- **Description**: 模拟时钟 React 组件。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <h2>React Clock</h2>
  <a href="https://uiwjs.github.io/react-clock">
    <img src="https://user-images.githubusercontent.com/1680273/99911627-b3040f80-2d30-11eb-9c48-669f1745f348.png">
  </a>
</p>

<!--dividing-->
[![Build & Deploy](https://github.com/uiwjs/react-clock/workflows/Build%20&%20Deploy/badge.svg)](https://github.com/uiwjs/react-clock/actions)
[![Issues](https://img.shields.io/github/issues/uiwjs/react-clock.svg)](https://github.com/uiwjs/react-clock/issues)
[![Forks](https://img.shields.io/github/forks/uiwjs/react-clock.svg)](https://github.com/uiwjs/react-clock/network)
[![Stars](https://img.shields.io/github/stars/uiwjs/react-clock.svg)](https://github.com/uiwjs/react-clock/stargazers)
[![Release](https://img.shields.io/github/release/uiwjs/react-clock)](https://github.com/uiwjs/react-clock/releases)
[![npm version](https://img.shields.io/npm/v/@uiw/react-clock.svg)](https://www.npmjs.com/package/@uiw/react-clock)

An analog clock for your react app.

## Quick Start

```jsx
import ReactClock from '@uiw/react-clock';

function Demo() {
  return (
    <ReactClock />
  );
}
```

## Props

```typescript
type ClockProps = {
  width?: number;
  height?: number;
  value?: Date;
  run?: boolean
} & React.SVGProps<SVGSVGElement>;
```

## Development

Runs the project in development mode.  

```bash
# Step 1, run first, listen to the component compile and output the .js file
npm run ts:watch
# Step 2, listen for compilation output type .d.ts file
npm run types:watch
# Step 3, development mode, listen to compile preview website instance
npm run start
```

Builds the app for production to the build folder.

```bash
npm run build
```

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!