Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eclipsesource/tabris-plugin-calendar
A custom calendar widget for Tabris.js
https://github.com/eclipsesource/tabris-plugin-calendar
android calendar-widget tabris tabris-js
Last synced: about 1 month ago
JSON representation
A custom calendar widget for Tabris.js
- Host: GitHub
- URL: https://github.com/eclipsesource/tabris-plugin-calendar
- Owner: eclipsesource
- License: bsd-3-clause
- Created: 2015-08-24T12:41:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-01T14:31:07.000Z (about 5 years ago)
- Last Synced: 2024-09-17T01:15:35.621Z (3 months ago)
- Topics: android, calendar-widget, tabris, tabris-js
- Language: Kotlin
- Size: 240 KB
- Stars: 4
- Watchers: 19
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tabris.js Calendar Plugin
A calendar widget for [Tabris.js](https://tabrisjs.com), allowing to show and pick a date. Currently only Android is supported.
## Compatibility
Compatible with [Tabris.js 3.x](https://github.com/eclipsesource/tabris-js/releases/tag/v3.0.0). For [Tabris.js 2.x](https://github.com/eclipsesource/tabris-js/releases/tag/v3.0.0) compatibility see the branch [1.x-tabris-2.x](https://github.com/eclipsesource/tabris-plugin-calendar/tree/1.x-tabris-2.x).
## Example
The following snippet shows how the `tabris-plugin-calendar` plugin can be used in a Tabris.js app:
```javascript
new escalendar.Calendar({
left: 0, right: 0, top: 0, bottom: 0,
date: 946684800000 // year 2000
}).on('dateChanged', ({value: date}) => console.log(date))
.appendTo(tabris.ui.contentView);
```
A more elaborate example can be found in the [example](example/) folder. It provides a Tabris.js project that demonstrates the various features of the `tabris-plugin-calendar` widget. Consult the [README](example/README.md) of the example for build instructions.
## Integrating the plugin
The Tabris.js website provides detailed information on how to [integrate custom widgets](https://tabrisjs.com/documentation/latest/build#adding-plugins) in your Tabris.js app. To add the plugin to your app add the following entry in your apps `config.xml`:
```xml
```
To fetch the latest development version use the GitHub URL:
```xml
```
## API
The widget api consists of the object `escalendar.Calendar` with the following properties and events.
### Properties
The following properties can be applied on top of the [common Tabris.js properties](https://tabrisjs.com/documentation/latest/api/Widget#properties):
* `date` : _number_
* The currently selected date as a unix timestamp in milliseconds
* `minDate` : _number_
* The minimum date as a unix timestamp in milliseconds. Defaults to January 1 1900
* `maxDate` : _number_
* The maximum date as a unix timestamp in milliseconds. Defaults to January 1 2100
### Events
#### dateChanged
Fired when the user selects a date in the calendar widget.
##### Event parameter
* `event.value`: _number_
* The new date as a unix timestamp in milliseconds
### Supported platforms
* Android
## Development of the widget
While not required by the consumer or the widget, this repository provides a `project` folder that contains platform specific development artifacts. These artifacts allow to more easily consume the native source code when developing the native parts of the widget.
### Android
The project provides a gradle based build configuration, which also allows to import the project into Android Studio.
In order to reference the Tabris.js specific APIs, the environment variable `TABRIS_ANDROID_PLATFORM` has to point to the Tabris.js Android Cordova platform root directory.
```bash
export TABRIS_ANDROID_PLATFORM=/home/user/tabris-android-cordova
```
The environment variable is consumed in the gradle projects [build.gradle](project/android/build.gradle) file.
## Copyright
See [LICENSE](LICENSE) notice.