Rrule-builder NPM

React RRule Builder

Recurrence rules generator form built with React

This project is no longer maintained by me. Thank you for all your past contributions. Let the forks rock it for you.

Screenshot

Description

This is ReactJS project based on Create React Library and using Bootstrap styling. It's built with the help of a great rrule.js library.

It also uses:

Demo

Installation

npm install --save rrule-builder@latest

Usage

In your CSS index file don't forget to import styles:

@import '~bootstrap/dist/css/bootstrap.css';       // this lib uses boostrap (v.5.3.3)

Then you're good to go.
Just use it:

import RRuleBuilder from "rrule-builder";

// render it as it is

const SimpleRender = () => <RRuleBuilder onChange={(rrule) => console.log(rrule)} rruleString={rrule} />;

API

Props

Name	Type	Description
onChange	`function`	REQUIRED. Callback trigger when the RRule changes. The callback receives newly generated RRule `string`.
rruleString	`string`	You can pass your own RRule value to RRuleGenerator and use it like controlled input component.
translations	`function` or `object`	Accepts a function or an object with translations for all labels in the component. By default all labels are in English. You can pass your own translation object or function, which has the following signature: `(key: string, replacements: object) => string`. It receives key of the label in form of `'repeat.yearly.on_the'` and an object for placeholder replacements, e.g., `{ value: error.value }`. Example translation objects are placed in `/src/lib/translations/`.