@linkorb/rrule-input-js
v1.2.0
Published
rrule input javascript library.
Downloads
48
Readme
rrule-input-js
rrule input javascript library.
Available on npm as @linkorb/rrule-input-js
Usage
- Install dependencies
npm install
- Create JS bundle
npm run build
The bundled script will be located in the ./dist
folder. The script should be added to the bottom of the page. It looks for a container with class = rrule-container
and embeds the rrule form into it. The rrule string is located in the input element with id = rrule-result
. The container can also be used inside other custom form, in this way the rrule string can be accessible either through the document.forms['your-custom-form-name']['rrule-result'].value
or by #rrule-result
selector.
Demo
- Install dependencies
npm install
- Run demo
npm run demo
Demo contains three examples:
- separate use (see
./src/demo/separate-use.html
for markup example) - inside custom form (see
./src/demo/inside-custom-form.html
for markup example). This example also containsSubmit form
button, the rrule string will be logged in the browser console when that button is clicked. - predefined form (see
./src/demo/predefined-form.html
for markup example). This example does not have a form container and has a predefined form instead. In this case (when the container does not exist) the script looks for the form (by.rrule
selector) and handles it.
Running demo in a docker container:
docker build --tag rrule-demo . && docker run --publish 8080:3000 rrule-demo