Skip to content

Conversation

@VijayakumarRSF4470
Copy link
Contributor

@VijayakumarRSF4470 VijayakumarRSF4470 commented Dec 12, 2025

Feature description

996709: Documentation for the Scheduler custom toolbar feature.

Analysis and design

Implemented dropdown in header bar using schedule custom toolbar.

Solution description

The provided header bar of the scheduler, that filters the resource data of the scheduler.

Output screenshots

blazor-scheduler-toolbar-template

Areas affected and ensured

  1. Ensured in Month view.
  2. By changing the owner values.

API Changes

List all API changes here (or just put None), example:

Added:

  • string ListView.GroupName { get; set; } //Bindable Property
  • int ListView.GroupId { get; set; } // Bindable Property
  • void ListView.Clear ();

Changed:

  • object ListView.SelectedItem => Cell ListView.SelectedItem

Behavioral Changes

Describe any non-bug related behavioral changes that may change how users app behaves when upgrading to this version of the codebase.

Test cases

Provide the unit testing written file details to understand the use cases considered in this implementation.
If there is no TDD (if it’s not possible to follow), provide the UI automation script location and the Excel file that contains the use cases considered in this implementation.
Provide the test cases Excel file alone if the feature cannot be automated in any case.

List out all the scenarios you have tested after include these changes. You can refer the predefined scenarios from below link.

https://syncfusion.atlassian.net/wiki/display/CHARTXAMARIN/Chart+Test+Plan

Testbed sample location

Provide the test bed sample location where code reviewers can review the new feature’s behaviors. This depends on the CI process that your team follows. It can be from NPMCI, HockeyApp, staging site, local server, etc.

Does it have any known issues?

No

Does it have memory leak?

No leaks

MR CheckList

  • Does it follow the design guidelines? It is mandatory that, we should not move the changes without reading this.
  • Did UI automation passed without errors? If it is customer issue, make sure it is included in the IR automation.
  • Properly working in Xamarin.Forms previewer.
  • Ensured in iOS, Android, UWP and macOS (if supported).
  • Have you added API comments if it is new API?
  • Does it need localization? If so, update resx file in GitHub.
  • Whether we have added new APIs? If so, whether it is as per the guidelines?
  • If changes are made in the Xamarin.Forms sample browser project file, whether it is included in the props file too? If not, your sample level changes will not reflect in the application published in the hockey app.
  • Have you ensured the changes in Android API 19 and iOS 9?

@VijayakumarRSF4470 VijayakumarRSF4470 added the documentation Improvements or additions to documentation label Dec 12, 2025
@SyncfusionBuild
Copy link
Contributor

CI Status: FAILURE ❌
Source Compilation: Not Started ❌
Failure Reason: Checkout Failed
Build Location: ES-996709-CutomToolbar

@SyncfusionBuild
Copy link
Contributor

CI Status: FAILURE ❌
Source Compilation: Not Started ❌
Failure Reason: Checkout Failed
Build Location: ES-996709-CutomToolbar

Copy link
Contributor

@ravikumar-venkatesan-m ravikumar-venkatesan-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address the review corrections.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Utilize the space to achieve a similar output as the EJ2 Scheduler custom toolbar sample.

image


The Scheduler with view options within the header bar popup will be rendered as shown in the following image.


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this unwanted line.

}
private void InitializeAppointments()
{
DataSource = new List<AppointmentData>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A single appointment for each resource will be enough. Totally 3 appointments.

};
}
private async void OnOwnerChange(ChangeEventArgs<int, OwnerData> args)
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Utilize the Query similar to EJ2. Don't include any unnecessary code.

image

<ScheduleToolBarToday />
</ScheduleToolBar>
<ScheduleViews>
<ScheduleView Option="View.Week"></ScheduleView>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The month view alone will be enough, no other views required.


## Customizing header bar using template

Apart from the default date navigation and view options available on the header bar, you can add custom items into the Scheduler header bar by making use of the `ScheduleToolBar` child component along with `ScheduleToolBarCustom` for custom toolbar items. The Scheduler provides built-in toolbar components such as `ScheduleToolBarPrevious`, `ScheduleToolBarNext`, `ScheduleToolBarDateRange`, `ScheduleToolBarToday`, and `ScheduleToolBarViews` to display the default navigation and view options. For custom items, you can use the `ScheduleToolBarCustom` component to add any custom content or controls. In this example, the default items such as Previous, Next, Date Range Text, and Today have been used along with a dropdown list control as a custom toolbar item to filter appointments by owner.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include all the support items in the description. Can check the sample description from the following sample. Also, include the supported types of the Custom toolbar item.

https://gitea.syncfusion.com/essential-studio/ej2-blazor-samples/src/branch/release/32.1.1/Common/Pages/Schedule/Scheduler/HeaderBar.razor#L25

image


The Scheduler with custom toolbar items alongside the default navigation and view options in the header bar will be rendered as shown in the following image.

![Hide Header Bar in Blazor Scheduler](images/blazor-scheduler-toolbar-template.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provide a proper output image name. Don't use the previous topic image name "Hide Header Bar in Blazor Scheduler".

<SfSchedule TValue="AppointmentData"
@ref="ScheduleObj"
Width="100%"
Height="650px"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set the height to 550px.

@ref="ScheduleObj"
Width="100%"
Height="650px"
@bind-SelectedDate="@CurrentDate">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SelectedDate is not required.

}
```

The Scheduler with custom toolbar items alongside the default navigation and view options in the header bar will be rendered as shown in the following image.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the image description based on the sample because we didn't include the ScheduleToolBarViews option in the sample.

@ravikumar-venkatesan-m
Copy link
Contributor

@VijayakumarRSF4470 ,
Address the review corrections, update the PR template with proper details, and clear the CI failure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants