Skip to content

Commit f2db679

Browse files
Merge pull request #6814 from syncfusion-content/984382-scheduler2
Updated the UG document for scheduler Component
2 parents ed839ce + fb7ddb2 commit f2db679

31 files changed

+425
-289
lines changed

blazor/scheduler/accessibility.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ documentation: ug
1111

1212
The [Blazor Scheduler](https://www.syncfusion.com/blazor-components/blazor-scheduler) component followed the accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
1313

14-
The accessibility compliance for the Blazor Scheduler component is outlined below.
14+
The accessibility compliance for the Blazor Scheduler component is detailed below.
1515

1616
| Accessibility Criteria | Compatibility |
1717
| -- | -- |
@@ -37,7 +37,7 @@ The accessibility compliance for the Blazor Scheduler component is outlined belo
3737

3838
<div><img src="https://cdn.syncfusion.com/content/images/landing-page/no.png" alt="No"> - The component does not meet the requirement.</div>
3939

40-
## WAI-ARIA attributes
40+
## WAI-ARIA Attributes
4141

4242
[WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/) (Accessibility Initiative – Accessible Rich Internet Applications) defines a way to increase the accessibility of web pages, dynamic content, and user interface components developed with Ajax, HTML, JavaScript, and related technologies. ARIA provides additional semantics to describe the role, state, and functionality of web components.
4343

@@ -52,9 +52,9 @@ The following ARIA attributes are used in the Scheduler:
5252
| aria-describedby | It indicates editor dialog content description to the user through assistive technologies. |
5353
| aria-disabled | Attribute is set to the appointment element to indicates the disabled state of the Scheduler. |
5454

55-
## Keyboard interaction
55+
## Keyboard Interaction
5656

57-
All the Scheduler actions can be controlled via keyboard keys and is availed by using `AllowKeyboardInteraction` property which is set to `true` by default. The applicable key combinations and its relative functionalities are listed below.
57+
All interactive actions within the Blazor Scheduler can be controlled via keyboard keys, supporting users who rely on assistive technologies or prefer keyboard-only navigation. This functionality is enabled by the `AllowKeyboardInteraction` property, which is set to `true` by default. The key combinations and their functionalities are outlined below.
5858

5959
| Windows | Mac | Actions |
6060
| ----- | ----- | ---- |
@@ -78,12 +78,12 @@ All the Scheduler actions can be controlled via keyboard keys and is availed by
7878
| <kbd>Shift</kbd> + <kbd>Alt</kbd> + <kbd>Y</kbd> | <kbd>⇧</kbd> + <kbd>⌥</kbd> + <kbd>Y</kbd> | To navigate to today date. |
7979
| <kbd>Shift</kbd> + <kbd>Alt</kbd> + <kbd>N</kbd> | <kbd>⇧</kbd> + <kbd>⌥</kbd> + <kbd>N</kbd> | To open editor window. |
8080

81-
## Ensuring accessibility
81+
## Ensuring Accessibility
8282

83-
The Blazor Scheduler component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) software tool during automated testing.
83+
The Blazor Scheduler component's adherence to accessibility standards is rigorously validated through automated testing using [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright).
8484

85-
The accessibility compliance of the Scheduler component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/schedule) in a new window to evaluate the accessibility of the Scheduler component with accessibility tools.
85+
The accessibility compliance of the Scheduler component can be evaluated by opening the [sample](https://blazor.syncfusion.com/accessibility/schedule) in a new window and using various accessibility testing tools.
8686

87-
## See also
87+
## See Also
8888

8989
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](https://blazor.syncfusion.com/documentation/common/accessibility)

blazor/scheduler/appointment-customization.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
22
layout: post
3-
title: Appointment customization in Blazor Scheduler Component | Syncfusion
3+
title: Appointment Customization in Blazor Scheduler Component | Syncfusion
44
description: Checkout and learn here all about appointment customization in Syncfusion Blazor Scheduler component.
55
platform: Blazor
66
control: Scheduler
77
documentation: ug
88
---
99

10-
# Appointment customization
10+
# Appointment Customization in Blazor Scheduler Component
1111

1212
The look and feel of the Scheduler events can be customized using any one of the following ways.
1313

1414
* [Using event template](#using-template)
1515
* [Using EventRendered event](#using-eventrendered-event)
1616
* [Using CssClass property](#using-cssclass)
1717

18-
## Using template
18+
## Using Template
1919

20-
Any kind of text, images and links can be added to customize the look of the events. The user can format and change the default appearance of the events by making use of the [Template](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html#Syncfusion_Blazor_Schedule_ScheduleEventSettings_1_Template) option available within the `ScheduleEventSettings` tag helper.
20+
An event template provides full control over the rendering of each appointment's content. Text, images, links, and even other Blazor components can be dynamically added to customize the look of events. This is achieved using the [`Template`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html#Syncfusion_Blazor_Schedule_ScheduleEventSettings_1_Template) option available within the `ScheduleEventSettings` property.
2121

22-
To get start quickly on customizing events using template, you can check on this video:
22+
To get started quickly customizing events using a template, refer to this video:
2323

2424
{% youtube
2525
"youtube:https://www.youtube.com/watch?v=8kBXcBjL12A"%}
@@ -68,11 +68,15 @@ The following code example customizes the appointment.
6868
}
6969
```
7070

71+
{% previewsample "https://blazorplayground.syncfusion.com/embed/hZLICjtdhIoxxqEi?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
72+
73+
![Template in Blazor Scheduler](./images/template.png)
74+
7175
N> All the built-in fields that are mapped to the appropriate field properties within the `ScheduleEventSettings`, as well as custom mapped fields from the Scheduler dataSource can be accessed within the template code.
7276

73-
## Using EventRendered event
77+
## Using EventRendered Event
7478

75-
The [EventRendered](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_EventRendered) event triggers before the appointment renders on the Scheduler. Therefore, this event can be utilized to customize the look of events based on any specific criteria, before rendering them on the scheduler.
79+
The [EventRendered](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_EventRendered) event triggers just before each appointment is rendered on the Scheduler. This event is highly versatile and can be used to dynamically customize the visual appearance of events based on specific criteria or conditions.
7680

7781
In the following code example, the custom class has been added to events using [CssClasses](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.EventRenderedArgs-1.html#Syncfusion_Blazor_Schedule_EventRenderedArgs_1_CssClasses) to apply color to the events.
7882

@@ -122,8 +126,11 @@ In the following code example, the custom class has been added to events using [
122126
}
123127
</style>
124128
```
129+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BtrosjDHBybiXDhd?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
125130

126-
Also, we can customize the events by adding or modifying its element attribute using [Attributes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.EventRenderedArgs-1.html#Syncfusion_Blazor_Schedule_EventRenderedArgs_1_Attributes). In the following code example, event attributes have been modified through the `Attributes` to apply color to the events.
131+
![Blazor Scheduler](./images/eventrendered.png)
132+
133+
Events can also be customized by adding or modifying its element attribute using [Attributes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.EventRenderedArgs-1.html#Syncfusion_Blazor_Schedule_EventRenderedArgs_1_Attributes). In the following code example, event attributes have been modified through the `Attributes` to apply color to the events.
127134

128135
```cshtml
129136
@using Syncfusion.Blazor.Schedule
@@ -166,8 +173,11 @@ Also, we can customize the events by adding or modifying its element attribute u
166173
}
167174
}
168175
```
176+
{% previewsample "https://blazorplayground.syncfusion.com/embed/LNVSWtNxVnDNNdNI?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
177+
178+
![Blazor Scheduler](./images/backgroundcolor.png)
169179

170-
## Using CssClass
180+
## Using CssClass
171181

172182
The customization of events can also be achieved using the built-in field [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.SfSchedule-1.html#Syncfusion_Blazor_Schedule_SfSchedule_1_CssClass) in which you can pass the class name to be applied to specific appointments. In the following example, the background of appointments has been changed.
173183

@@ -220,6 +230,9 @@ The customization of events can also be achieved using the built-in field [CssCl
220230
}
221231
</style>
222232
```
233+
{% previewsample "https://blazorplayground.syncfusion.com/embed/LZLoWXtxBdWIIoLL?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
234+
235+
![Blazor Scheduler](./images/eventrendered.png)
223236

224237
Also, the customization of events can be achieved using [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.SfSchedule-1.html#Syncfusion_Blazor_Schedule_SfSchedule_1_CssClass) property of the Scheduler. In the following example, the background of appointments has been changed using the CssClass.
225238

@@ -268,4 +281,8 @@ Also, the customization of events can be achieved using [CssClass](https://help.
268281
</style>
269282
```
270283

284+
{% previewsample "https://blazorplayground.syncfusion.com/embed/hjBSWNDnVdhFnoie?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
285+
286+
![Blazor Scheduler](./images/eventrendered.png)
287+
271288
N> The events can't be customized using the styles that are `height`, `width`, `top`, `left`, `right`, and `display`.

0 commit comments

Comments
 (0)