react-js-cron

ReactJS Cron

A React cron editor with antd inspired by jqCron

Live demo and usage at https://xrutayisire.github.io/react-js-cron/

Install

Be sure that you have these dependencies on your project:

• antd
• react
• react-dom

# Yarn
yarn add react-js-cron

# NPM
npm install --save react-js-cron

Usage

Learn more at https://xrutayisire.github.io/react-js-cron/

API

CronProps {
  value: string
  setValue: 
    | (value: string) => void
    | Dispatch<SetStateAction<string>> 
  className?: string
  humanizeLabels?: boolean // Default: true
  humanizeValue?: boolean // Default: false
  leadingZero?: 'never' | 'always' | ['month-days', 'hours', 'minutes'] // Default: 'never'
  defaultPeriod?: 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' // Default: 'day'
  disabled?: boolean // Default: false
  readOnly?: boolean // Default: false
  allowEmpty?: 'always' | 'never' | 'for-default-value' // Default: 'for-default-value'
  clearButton?: boolean // Default: true
  clearButtonProps?: ButtonProps // Extends antd button props without onClick
  displayError?: boolean // Default: true
  setError?: 
    | (error: {
      type: 'invalid_cron'
      description: string
    }) => void
    | Dispatch<SetStateAction<{
      type: 'invalid_cron'
      description: string
    }>>
    | undefined
  locale?: {
    everyText?: string
    emptyMonths?: string
    emptyMonthDays?: string
    emptyMonthDaysShort?: string
    emptyWeekDays?: string
    emptyWeekDaysShort?: string
    emptyHours?: string
    emptyMinutes?: string
    emptyMinutesForHourPeriod?: string
    yearOption?: string
    monthOption?: string
    weekOption?: string
    dayOption?: string
    hourOption?: string
    minuteOption?: string
    prefixPeriod?: string
    prefixMonths?: string
    prefixMonthDays?: string
    prefixWeekDays?: string
    prefixWeekDaysForMonthAndYearPeriod?: string
    prefixHours?: string
    prefixMinutes?: string
    prefixMinutesForHourPeriod?: string
    suffixMinutesForHourPeriod?: string
    errorInvalidCron?: string
    weekDays?: string[]
    months?: string[]
  }  // Default: See file 'src/locale.ts'
}

License

MIT © xrutayisire

Changelog

1.0.5

• Update README image with new features
• Add a prop leadingZero to add a '0' before number lower than 10
• Add a prop to make the component read only
• Add a prop to disable the component
• Set day as default period
• Add missing support for mixing week days with month and month days
• Rename some locale properties to fix typos
• Fix typo in jqCron name