Skip to content

Commit

Permalink
doc: README improved
Browse files Browse the repository at this point in the history
  • Loading branch information
rwbr committed Jan 26, 2022
1 parent 15acbc8 commit b6142c8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ The package is highly customizable.
![Screenshot](https://github.com/rwbr/flutter_neat_and_clean_calendar/blob/main/img/screen2.png)
![Screenshot](https://github.com/rwbr/flutter_neat_and_clean_calendar/blob/main/img/screen3.png)

The calendar view shows a list of events for the selected date. This list view supports **three different types of events:**

* Single day event (starts and ends at certain time on a single day)
* All-day events (Span over a full day with no specific start and end time, property `isAllDay`)
* Multi-day events (Start at a specific time on one day and end at a specific time on another day, property `isMultiDay`)

![Event types](https://github.com/rwbr/flutter_neat_and_clean_calendar/blob/main/img/different-events.png)

The property `isAllDay` has a higher priority than 'isMultiDay'. This means, that when you set `isAllDay` to `true` for an event, it will show up in the events list als all-day event without start and end times, no matter if `isMultiDay` was also set to `true`.

## Usage

Embed the 'Calendar' widget in a column. Below the calendar (as the second widget in the Column) place a 'ListView.builder' widget for rendereing the list of events.
Expand All @@ -21,7 +31,7 @@ Embed the 'Calendar' widget in a column. Below the calendar (as the second widge

```
dependencies:
flutter_neat_and_clean_calendar: ^0.2.0+8
flutter_neat_and_clean_calendar: ^0.3.0+12
```

### Install
Expand Down Expand Up @@ -185,6 +195,8 @@ final List<NeatCleanCalendarEvent> _eventList = [
];
```

**CAUTION**: from v0.3.0 on the preferred way to set the calendar events is to provide a list (property `eventsList`). You can still use a map (property `events`) to do this, but this functionality is **DEPRECATED** and will get **removed from v0.4.0 on**.

## Examples

### Basic widget with customized colors
Expand Down
Binary file added img/different-events.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b6142c8

Please sign in to comment.