2.0.9 • Published 1 year ago

@ramazanyigit/react-cron-generator v2.0.9

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

react-cron-generator

Simple react component to generate cron expression

Getting Started

Package helps to build linux scheduler cron expression.

data = '* * * * * * *'
npm install react-cron-generator

demo

Live demo

alt text

alt text

import React, { Component } from 'react'
import Cron from 'react-cron-generator'
import 'react-cron-generator/dist/cron-builder.css'


class App extends Component {

  constructor(props) {
      super(props);
      this.state = {
       
      };
  }

  render() {
    return (<div>
      <Cron
        onChange={(e)=> {this.setState({value:e});}}
        value={this.state.value}
        showResultText={true}
        showResultCron={true}
        />
                            
    </div>)
  }
}

export default App;

props

PropDescriptionDefaultMandatory
valuecron expressionNo
onChangehave 2 arguments, 1st is cron value and 2nd is cron result text from cronstrueYes
showResultTextshow in readable text formatfalseNo
showResultCronshow cron expressionfalseNo
translateFntranslate function callbackmethodNo
localelocale for cronstrueenNo
optionsOptions for Cron component, *Must pass a valid cron value for available headersAll available headersNo

translateFn

Expects a method. Use this prop for localization support. react-cron-generator will call this method for every key. List of keys are available here

locale option should be set for correct ResultText translation. Please visit cronstrue for supported locales.

Options

options.headers

import { HEADER } from 'react-cron-generator';

const options = {
  headers: [HEADER.MONTHLY, HEADER.WEEKLY, HEADER.MINUTES, HEADER.HOURLY, HEADER.DAILY, HEADER.CUSTOM]
};

Release notes 2.x.x

  1. Build Procedure updated
  2. Updated to latest react(18)
  3. Migrated to hooks and typescript

Sojin Antony

Acknowledgments

cronstrue

Viswanath Lekshmanan