base on Highly customizable, feature-packed calendar widget for Flutter # TableCalendar [![Pub Package](https://img.shields.io/pub/v/table_calendar.svg?style=flat-square)](https://pub.dartlang.org/packages/table_calendar) [![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-52bdeb.svg?longCache=true&style=flat-square)](https://github.com/Solido/awesome-flutter) Highly customizable, feature-packed calendar widget for Flutter. | ![Image](https://raw.githubusercontent.com/aleksanderwozniak/table_calendar/assets/table_calendar_styles.gif) | ![Image](https://raw.githubusercontent.com/aleksanderwozniak/table_calendar/assets/table_calendar_builders.gif) | | :------------: | :------------: | | **TableCalendar** with custom styles | **TableCalendar** with custom builders | ## Features * Extensive, yet easy to use API * Preconfigured UI with customizable styling * Custom selective builders for unlimited UI design * Locale support * Range selection support * Multiple selection support * Dynamic events and holidays * Vertical autosizing - fit the content, or fill the viewport * Multiple calendar formats (month, two weeks, week) * Horizontal swipe boundaries (first day, last day) ## Usage Make sure to check out [examples](https://github.com/aleksanderwozniak/table_calendar/tree/master/example/lib/pages) and [API docs](https://pub.dev/documentation/table_calendar/latest/) for more details. ### Installation Add the following line to `pubspec.yaml`: ```yaml dependencies: table_calendar: ^3.2.0 ``` ### Basic setup *The complete example is available [here](https://github.com/aleksanderwozniak/table_calendar/blob/master/example/lib/pages/basics_example.dart).* **TableCalendar** requires you to provide `firstDay`, `lastDay` and `focusedDay`: * `firstDay` is the first available day for the calendar. Users will not be able to access days before it. * `lastDay` is the last available day for the calendar. Users will not be able to access days after it. * `focusedDay` is the currently targeted day. Use this property to determine which month should be currently visible. ```dart TableCalendar( firstDay: DateTime.utc(2010, 10, 16), lastDay: DateTime.utc(2030, 3, 14), focusedDay: DateTime.now(), ); ``` #### Adding interactivity You will surely notice that previously set up calendar widget isn't quite interactive - you can only swipe it horizontally, to change the currently visible month. While it may be sufficient in certain situations, you can easily bring it to life by specifying a couple of callbacks. Adding the following code to the calendar widget will allow it to respond to user's taps, marking the tapped day as selected: ```dart selectedDayPredicate: (day) { return isSameDay(_selectedDay, day); }, onDaySelected: (selectedDay, focusedDay) { setState(() { _selectedDay = selectedDay; _focusedDay = focusedDay; // update `_focusedDay` here as well }); }, ``` In order to dynamically update visible calendar format, add those lines to the widget: ```dart calendarFormat: _calendarFormat, onFormatChanged: (format) { setState(() { _calendarFormat = format; }); }, ``` Those two changes will make the calendar interactive and responsive to user's input. #### Updating focusedDay Setting `focusedDay` to a static value means that whenever **TableCalendar** widget rebuilds, it will use that specific `focusedDay`. You can quickly test it by using hot reload: set `focusedDay` to `DateTime.now()`, swipe to next month and trigger a hot reload - the calendar will "reset" to its initial state. To prevent this from happening, you should store and update `focusedDay` whenever any callback exposes it. Add this one callback to complete the basic setup: ```dart onPageChanged: (focusedDay) { _focusedDay = focusedDay; }, ``` It is worth noting that you don't need to call `setState()` inside `onPageChanged()` callback. You should just update the stored value, so that if the widget gets rebuilt later on, it will use the proper `focusedDay`. *The complete example is available [here](https://github.com/aleksanderwozniak/table_calendar/blob/master/example/lib/pages/basics_example.dart). You can find other examples [here](https://github.com/aleksanderwozniak/table_calendar/tree/master/example/lib/pages).* ### Events *The complete example is available [here](https://github.com/aleksanderwozniak/table_calendar/blob/master/example/lib/pages/events_example.dart).* You can supply custom events to **TableCalendar** widget. To do so, use `eventLoader` property - you will be given a `DateTime` object, to which you need to assign a list of events. ```dart eventLoader: (day) { return _getEventsForDay(day); }, ``` `_getEventsForDay()` can be of any implementation. For example, a `Map<DateTime, List<T>>` can be used: ```dart List<Event> _getEventsForDay(DateTime day) { return events[day] ?? []; } ``` One thing worth remembering is that `DateTime` objects consist of both date and time parts. In many cases this time part is redundant for calendar related aspects. If you decide to use a `Map`, I suggest making it a `LinkedHashMap` - this will allow you to override equality comparison for two `DateTime` objects, comparing them just by their date parts: ```dart final events = LinkedHashMap( equals: isSameDay, hashCode: getHashCode, )..addAll(eventSource); ``` #### Cyclic events `eventLoader` allows you to easily add events that repeat in a pattern. For example, this will add an event to every Monday: ```dart eventLoader: (day) { if (day.weekday == DateTime.monday) { return [Event('Cyclic event')]; } return []; }, ``` #### Events selected on tap Often times having a sublist of events that are selected by tapping on a day is desired. You can achieve that by using the same method you provided to `eventLoader` inside of `onDaySelected` callback: ```dart void _onDaySelected(DateTime selectedDay, DateTime focusedDay) { if (!isSameDay(_selectedDay, selectedDay)) { setState(() { _focusedDay = focusedDay; _selectedDay = selectedDay; _selectedEvents = _getEventsForDay(selectedDay); }); } } ``` *The complete example is available [here](https://github.com/aleksanderwozniak/table_calendar/blob/master/example/lib/pages/events_example.dart).* ### Custom UI with CalendarBuilders To customize the UI with your own widgets, use [CalendarBuilders](https://pub.dev/documentation/table_calendar/latest/table_calendar/CalendarBuilders-class.html). Each builder can be used to selectively override the UI, allowing you to implement highly specific designs with minimal hassle. You can return `null` from any builder to use the default style. For example, the following snippet will override only the Sunday's day of the week label (Sun), leaving other dow labels unchanged: ```dart calendarBuilders: CalendarBuilders( dowBuilder: (context, day) { if (day.weekday == DateTime.sunday) { final text = DateFormat.E().format(day); return Center( child: Text( text, style: TextStyle(color: Colors.red), ), ); } }, ), ``` ### Locale To display the calendar in desired language, use `locale` property. If you don't specify it, a default locale will be used. #### Initialization Before you can use a locale, you might need to initialize date formatting. A simple way of doing it is as follows: * First of all, add [intl](https://pub.dev/packages/intl) package to your pubspec.yaml file * Then make modifications to your `main()`: ```dart import 'package:intl/date_symbol_data_local.dart'; void main() { initializeDateFormatting().then((_) => runApp(MyApp())); } ``` After those two steps your app should be ready to use **TableCalendar** with different languages. #### Specifying a language To specify a language, simply pass it as a String code to `locale` property. For example, this will make **TableCalendar** use Polish language: ```dart TableCalendar( locale: 'pl_PL', ), ``` | ![Image](https://raw.githubusercontent.com/aleksanderwozniak/table_calendar/assets/en_US.png) | ![Image](https://raw.githubusercontent.com/aleksanderwozniak/table_calendar/assets/pl_PL.png) | ![Image](https://raw.githubusercontent.com/aleksanderwozniak/table_calendar/assets/fr_FR.png) | ![Image](https://raw.githubusercontent.com/aleksanderwozniak/table_calendar/assets/zh_CN.png) | | :------------: | :------------: | :------------: | :------------: | | `'en_US'` | `'pl_PL'` | `'fr_FR'` | `'zh_CN'` | Note, that if you want to change the language of `FormatButton`'s text, you have to do this yourself. Use `availableCalendarFormats` property and pass the translated Strings there. Use i18n method of your choice. You can also hide the button altogether by setting `formatButtonVisible` to false. ", Assign "at most 3 tags" to the expected json: {"id":"9816","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"