An open API service indexing awesome lists of open source software.

https://github.com/uiwjs/react-clock

An analog clock for your React app.
https://github.com/uiwjs/react-clock

clock react react-component reactjs uiwjs

Last synced: 5 months ago
JSON representation

An analog clock for your React app.

Awesome Lists containing this project

README

          


React Clock




[![NPM Downloads](https://img.shields.io/npm/dm/@uiw/react-clock.svg?style=flat)](https://www.npmjs.com/package/@uiw/react-clock)
[![Build & Deploy](https://github.com/uiwjs/react-clock/actions/workflows/ci.yml/badge.svg)](https://github.com/uiwjs/react-clock/actions/workflows/ci.yml)
[![Open in unpkg](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-clock/file/README.md)
[![npm version](https://img.shields.io/npm/v/@uiw/react-clock.svg)](https://www.npmjs.com/package/@uiw/react-clock)
[![Open in Gitpod](https://shields.io/badge/Open%20in-Gitpod-green?logo=Gitpod)](https://gitpod.io/#https://github.com/uiwjs/react-clock)

An analog clock for your react app.

## Quick Start

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

function Demo() {
return (

);
}
```

## Props

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

## Development

Runs the project in development mode.

```bash
# Step 1, run first, listen to the component compile and output the .js and type .d.ts file
npm run watch
# Step 2, 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!

## Contributors

As always, thanks to our amazing contributors!



Made with [github-action-contributors](https://github.com/jaywcjlove/github-action-contributors).

### License

Licensed under the MIT License.