From 0d8b22b191374ae90b689de0b455c1d9e746ddc7 Mon Sep 17 00:00:00 2001 From: Ralf Weinbrecher Date: Tue, 6 Aug 2024 15:46:32 +0200 Subject: [PATCH] doc(readme): Hint on removal of event map property --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b249574..a60e8e4 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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>? 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