https://github.com/baymac/material-ui-cron
A React cron library using material ui
https://github.com/baymac/material-ui-cron
Last synced: 12 months ago
JSON representation
A React cron library using material ui
- Host: GitHub
- URL: https://github.com/baymac/material-ui-cron
- Owner: baymac
- License: mit
- Created: 2021-03-17T17:14:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-11-20T17:38:38.000Z (over 3 years ago)
- Last Synced: 2024-11-13T19:58:22.564Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://baymac.github.io/material-ui-cron/
- Size: 1.15 MB
- Stars: 6
- Watchers: 2
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Material UI Cron
[](https://www.npmjs.com/package/material-ui-cron)
[](https://github.com/baymac/material-ui-cron/blob/master/LICENSE.md)
A React cron editor built with [material ui](https://material-ui.com/)
Live **demo** and **usage** at
[https://baymac.github.io/material-ui-cron/](https://baymac.github.io/material-ui-cron/?path=/story/material-ui-cron--scheduler-demo)
## Inspired by
- [react-cron-js](https://github.com/xrutayisire/react-js-cron)
## Installation
Be sure that you have these dependencies on your project:
- react (>=17.0.1)
- @material-ui/core (>5.0.0-beta.1)
- @material-ui/styles: (>5.0.0-beta.1)
More dependencies
```bash
# Yarn
yarn add material-ui-cron
# NPM
npm install --save material-ui-cron
```
## Usage
```javascript
import Scheduler from 'material-ui-cron'
import React from 'react'
export default function SchedulerDemo() {
const [cronExp, setCronExp] = React.useState('0 0 * * *')
const [cronError, setCronError] = React.useState('') // get error message if cron is invalid
const [isAdmin, setIsAdmin] = React.useState(true) // set admin or non-admin to enable or disable high frequency scheduling (more than once a day)
return (
)
}
```
## TypeScript
`material-ui-cron` is written in TypeScript with complete definitions.
## Internalization and Localization
This library supports Internalization (i18n). Currently languages supported are:
1. English
We are welcoming translation contributions from the community.
### How to contribute to translation
1. Clone `/src/localization/enLocal.ts` and rename it to desired langauge prefix
(based on
https://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code).
2. Add language prefix to `definedLocales` type inside `/src/types.ts`
3. Add locale mapping inside `/src/i18n.ts`
### How to use translation
#### Using predefined locale:
```javascript
```
#### Using custom locale:
```javascript
```
## Acknowledgement
This library was developed as a part of [Udaan](https://udaan.com/)'s Data
Platform for scheduling queries. Big thanks to
[Amod Malviya](https://github.com/amodm) for supporting this project.
## License
MIT © [baymac](https://github.com/baymac)