Skip to content

SEO-198658-Flutter-Calendar-Search-Console-Keyword-Tracking- #1156

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 6 commits into
base: hotfix/hotfix-v28.2.3
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 23 additions & 21 deletions Flutter/calendar/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
layout: post
title: Getting started with Flutter Event Calendar widget | Syncfusion
title: Getting started with Flutter Calendar widget | Syncfusion
description: Learn here about getting started with Syncfusion Event Calendar (SfCalendar) widget, its elements, and more.
platform: flutter
control: SfCalendar
documentation: ug
---

# Getting started with Flutter Event Calendar (SfCalendar)
This section explains the steps required to add the calendar widget and populate appointments to the calendar widget. This section covers only basic features needed to get started with Syncfusion<sup>&reg;</sup> calendar widget.
# Getting started with Flutter Calendar widget (SfCalendar)
This section explains the steps required to add the calendar widget and populate appointments to the calendar widget. This section covers only basic features needed to get started with Syncfusion calendar widget.

To get start quickly with our [Flutter event calendar widget](https://www.syncfusion.com/flutter-widgets/flutter-calendar), you can check on this video.

Expand All @@ -22,7 +22,7 @@ Create a simple project using the instructions given in the [Getting Started wit

**Add dependency**

Add the Syncfusion<sup>&reg;</sup> Flutter calendar dependency to your pubspec.yaml file.
Add the Syncfusion Flutter calendar dependency to your pubspec.yaml file.

{% highlight dart %}

Expand All @@ -32,7 +32,7 @@ syncfusion_flutter_calendar: ^xx.x.xx

{% endhighlight %}

N> Here **xx.x.xx** denotes the current version of [Syncfusion<sup>&reg;</sup> Flutter Calendar](https://pub.dev/packages/syncfusion_flutter_calendar/versions) package.
N> Here **xx.x.xx** denotes the current version of [Syncfusion Flutter Calendar](https://pub.dev/packages/syncfusion_flutter_calendar/versions) package.

**Get packages**

Expand Down Expand Up @@ -74,7 +74,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Calendar view](images/getting-started/dayview.png)
![Day view in Flutter Calendar.](images/getting-started/flutter-calendar-dayview.png){:width="316" height="550" loading="lazy"}

## Change different calendar views

Expand All @@ -94,7 +94,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Calendar view](images/getting-started/monthview.png)
![Month view in Flutter Calendar.](images/getting-started/flutter-calendar-monthview.png){:width="443" height="550" loading="lazy"}

## Add data source

Expand Down Expand Up @@ -171,7 +171,7 @@ class Meeting {
{% endhighlight %}
{% endtabs %}

![AddData source](images/getting-started/datasource.png)
![Data source in Flutter Calendar.](images/getting-started/flutter-calendar-datasource.png){:width="452" height="550" loading="lazy"}

## Change first day of week

Expand All @@ -192,7 +192,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Change first day of week](images/getting-started/firstday-week.png)
![Change first day of week in Flutter Calendar.](images/getting-started/flutter-calendar-firstday-week.png){:width="452" height="550" loading="lazy"}

## Initial selected date

Expand All @@ -218,7 +218,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Initial selected date](images/getting-started/initial-selected-date.png)
![Initial selected date in Flutter Calendar.](images/getting-started/flutter-calendar-initial-selected-date.png){:width="452" height="550" loading="lazy"}

## Initial display date

Expand All @@ -244,7 +244,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Initial display date](images/getting-started/initial-display-date.png)
![Initial display date in Flutter Calendar.](images/getting-started/flutter-calendar-initial-display-date.png){:width="452" height="550" loading="lazy"}

## Selection decoration

Expand Down Expand Up @@ -275,7 +275,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Selection decoration](images/getting-started/selection-decoration.png)
![Selection decoration in Flutter Calendar.](images/getting-started/flutter-calendar-selection-decoration.png){:width="452" height="550" loading="lazy"}

## Today highlight color

Expand All @@ -301,7 +301,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Today highlight color](images/getting-started/today-highlight-color.png)
![Today highlight color in Flutter Calendar.](images/getting-started/flutter-calendar-today-highlight-color.png){:width="452" height="550" loading="lazy"}

## Cell border color

Expand All @@ -327,7 +327,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Cell border color](images/getting-started/cell-border-color.png)
![Cell border color in Flutter Calendar.](images/getting-started/flutter-calendar-cell-border-color.png){:width="452" height="550" loading="lazy"}

## Background color

Expand All @@ -353,7 +353,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Background color](images/getting-started/calendar-background-color.png)
![Background color in Flutter Calendar.](images/getting-started/flutter-calendar-background-color.png){:width="452" height="550" loading="lazy"}

## Navigation arrow
Using the [showNavigationArrow](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/showNavigationArrow.html) property of the `SfCalendar`, you can navigate to the next or previous views of the calendar without swiping.
Expand All @@ -374,7 +374,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Show Navigation Arrow](images/getting-started/show-navigation-arrow.jpg)
![Show Navigation Arrow in Flutter Calendar.](images/getting-started/flutter-calendar-show-navigation-arrow.jpg){:width="340" height="504" loading="lazy"}


>**NOTE**
Expand Down Expand Up @@ -404,7 +404,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![Cell end padding](images/getting-started/cell-end-padding.png)
![Cell end padding in Flutter Calendar.](images/getting-started/flutter-calendar-cell-end-padding.png){:width="418" height="550" loading="lazy"}

## Current time indicator

Expand All @@ -426,7 +426,7 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![showCurrentTimeIndicator](images/getting-started/current-time-indicator.png)
![show Current Time Indicator in Flutter Calendar.](images/getting-started/flutter-calendar-current-time-indicator.png){:width="452" height="550" loading="lazy"}

## Week number

Expand All @@ -450,7 +450,7 @@ Display the Week number of the year in all views except schedule view of the `Sf
{% endhighlight %}
{% endtabs %}

![Week Number in Flutter Calendar](images\getting-started\flutter-calendar-week-number.png)
![Week Number in Flutter Calendar.](images\getting-started\flutter-calendar-week-number.png){:width="816" height="465" loading="lazy"}

## Week number appearance

Expand Down Expand Up @@ -478,7 +478,7 @@ Customize the Week number text style of the calendar by using the [WeekNumberSty
{% endhighlight %}
{% endtabs %}

![Week Number Appearance in Flutter Calendar](images\getting-started\flutter-calendar-week-number-appearance.png)
![Week Number Appearance in Flutter Calendar.](images\getting-started\flutter-calendar-week-number-appearance.png){:width="297" height="550" loading="lazy"}

Get the complete "getting started" sample from [here](https://github.com/SyncfusionExamples/flutter-calendar).

Expand All @@ -497,4 +497,6 @@ Get the complete "getting started" sample from [here](https://github.com/Syncfus
* [How to customize the current day color in the Flutter event calendar (SfCalendar)](https://support.syncfusion.com/kb/article/10814/how-to-customize-the-current-day-color-in-the-flutter-calendar)
* [How to show a particular week in a day view of Flutter event calendar(SfCalendar)](https://support.syncfusion.com/kb/article/10774/how-to-show-a-particular-week-in-a-day-view-of-flutter-calendar)
* [How to customize the selection using decoration in the Flutter event calendar (SfCalendar)](https://support.syncfusion.com/kb/article/10641/how-to-customize-the-selection-using-decoration-in-the-flutter-calendar)
* [How to format the view header day and date in the Flutter event calendar (SfCalendar)](https://support.syncfusion.com/kb/article/10764/how-to-format-the-view-header-day-and-date-in-the-flutter-calendar)
* [How to format the view header day and date in the Flutter event calendar (SfCalendar)](https://support.syncfusion.com/kb/article/10764/how-to-format-the-view-header-day-and-date-in-the-flutter-calendar)

N> You can also explore our [Flutter Calendar example](https://flutter.syncfusion.com/#/event-calendar/getting-started) that shows you how to render and configure the Calendar.