Skip to content

Commit

Permalink
doc(readme): Hint on removal of event map property
Browse files Browse the repository at this point in the history
  • Loading branch information
agfeo-rw committed Aug 6, 2024
1 parent ff3671c commit 0d8b22b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ You can include images in calendar events. The property `icon` takes a String of

To control the width of the image you can use the property `wide`, which is a bool.

# Breaking Change

> From v0.4.0 on the events map was removed from the properties. You may need to switch to the `eventsList` property in your app now.
## 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 @@ -35,7 +39,7 @@ Embed the 'Calendar' widget in a column. Below the calendar (as the second widge

```
dependencies:
flutter_neat_and_clean_calendar: ^0.3.0+12
flutter_neat_and_clean_calendar: ^0.4.1
```

### Install
Expand Down Expand Up @@ -379,7 +383,7 @@ If the contents of this list change in your app, you have to re-render the calen
**This parameter replaces the former parameter `Map<DateTime, List<NeatCleanCalendarEvent>>? events`**.
The `events`parameter was supported in versions under v0.4.0 of that widget. It is **deprecated** now. So use the `eventList` now in your app.
The `events`parameter was supported in versions under v0.4.0 of that widget. It is **removed** now. So use the `eventList` now in your app.
## Sample event data
Expand Down

0 comments on commit 0d8b22b

Please sign in to comment.