diff --git a/README.md b/README.md index 814ea91..fe33f8a 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,24 @@ The scheduler component can be configured and customized like any custom element | ------------- | ----------------- | ------- | ------------------------------------------------------------------------------------------------------ | | `header` | *Object* | | customize the header of the scheduler component. | | `events` | *Array* | [] | list of events to be displayed on the scheduler. | -| `default-view` | *String* | month | The default view to be displayed on the scheduler. | +| `default-view` | *String* | month | The default view to be displayed on the scheduler. +| `weekends` | *Boolean* | true | Whether to show the weekends or not. +| `rtl` | *Boolean* | false | RTL mode. +| `hidden-days` | *Array* | [] | List of days to be hidden. +| `week-numbers` | *Boolean* | false | Whether to show week numbers or not +| `business-hours` | *Object* | {} | Object that describes scheduler business hours. +| `height` | *string* | {} | Calendar's height. +| `default-date` | *Object* | {} | Default date to be displayed when the scheduler is opened. +| `editable` | *Boolean* | false | Enable or disable edit mode. +| `droppable` | *Boolean* | false | Whether to allow dropping elements on the scheduler or not. +| `event-start-editable` | *Boolean* | false | Whether to allow changing event's start date. +| `event-duration-editable` | *Boolean* | false | Whether to allow changing event's end date +| `all-day-slot` | *Boolean* | true | Whether to display the all day slot. +| `all-day-text` | *String* | all-day | Text to be displayed on the all day slot. +| `slot-duration` | *String* | 00:30:00 | Default slot duration. This duration will be used when a new event is added without specifing its duration. +| `min-time` | *String* | 00:00:00 | The min time to be displayed on the scheduler. +| `max-time` | *String* | 24:00:00 | The max time to be displayed on the scheduler. +| `scroll-time` | *String* | 06:00:00 | Time on which the scroll becomes enabled. | * Methods @@ -26,13 +43,21 @@ The list below describes methods that can be used to manipulate the scheduler : | ------------- | ----------------- | ------- | ------------------------------------------------------------------------------------------------------ | | `today` | void | -- | Navigates to the current date. | | `next` | void | -- | Navigates to the next date based on the current view. -| `prev` | void | -- | Navigates to the previous date based on the current view. | +| `prev` | void | -- | Navigates to the previous date based on the current view. +| `getView` | string | -- | Returns the current view of the scheduler. +| `changeView` | void | viewName | Changes the view of scheduler. +| `getDate` | date | -- | Return the current date displayed on the scheduler. +| `goToDate` | void | targetDate | Navigates to the given date. +| `prevYear` | void | -- | Navigates to the next year. +| `nextYear` | void | -- | Navigates to the previous year. +| `incrementDate` | void | duration | Increments the date displayed on the scheduler by the given duration. + | ## Events The scheduler element dispatches the events below : | Event | Detail | Description | -| ------------- | ----------------- | ------------------------------------------------------------------------------------------------------ | +| ----------------------- | -------------------- | ---------------------------------------------------------------------------------------- | | `day-click` | *Object* | Fired when a day on the scheduler is clicked | | `event-click` | *Object* | Fired when an event on the scheduler is clicke | | `event-mouse-over` | *Object* | Fired when a mouse over on event is detected |