Skip to content

Commit 5d1e991

Browse files
Merge pull request #6873 from syncfusion-content/984382-timeline
Updated the UG document for the Timeline Component
2 parents 176eb05 + 7934c32 commit 5d1e991

File tree

10 files changed

+124
-86
lines changed

10 files changed

+124
-86
lines changed

blazor/timeline/accessibility.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Accessibility in Blazor Timeline component
1111

12-
The Blazor Timeline 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.
12+
The Blazor Timeline component adheres to 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. It incorporates [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) commonly used for accessibility evaluation.
1313

1414
The accessibility compliance for the Blazor Timeline component is outlined below.
1515

@@ -37,7 +37,7 @@ The accessibility compliance for the Blazor Timeline component is outlined below
3737

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

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

4242
The following ARIA attributes are used in the Timeline component:
4343

@@ -46,12 +46,12 @@ The following ARIA attributes are used in the Timeline component:
4646
| `role=navigation` | Specified its purpose as a navigational element. |
4747
| `aria-label` | Provides an accessibile name for an element when a visible label is not present |
4848

49-
## Ensuring accessibility
49+
## Ensuring Accessibility
5050

51-
The Blazor Timeline component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with playwright tests.
51+
The accessibility levels of the Blazor Timeline component are verified through [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with Playwright tests.
5252

5353
The accessibility compliance of the Blazor Timeline component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/timeline) in a new window to evaluate the accessibility of the Blazor Timeline component with accessibility tools.
5454

55-
## See also
55+
## See Also
5656

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

blazor/timeline/align.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ documentation: ug
99

1010
# Alignment in Blazor Timeline component
1111

12-
You can display the Timeline content [`Before`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Before), [`After`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_After), [`Alternate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Alternate) and [`AlternateReverse`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_AlternateReverse) by using the [`Alignment`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_Alignment) property. The [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) will be displayed parallel to the content when configured in the [`TimelineItem`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html) directive.
12+
Control the display of timeline content using the [`Alignment`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_Alignment) property, with options such as [`Before`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Before), [`After`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_After), [`Alternate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Alternate), and [`AlternateReverse`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_AlternateReverse). The [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) is displayed parallel to the main content when configured within the [`TimelineItem`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html) directive.
1313

1414
## Before
1515

16-
In [`Before`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Before) alignment, for [`horizontal`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineOrientation.html#Syncfusion_Blazor_Layouts_TimelineOrientation_Horizontal) orientation the item content is placed at the top and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) at the bottom whereas in [`vertical`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineOrientation.html#Syncfusion_Blazor_Layouts_TimelineOrientation_Vertical), the content to the left and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) to the right.
16+
In [`Before`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Before) alignment, for [`horizontal`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineOrientation.html#Syncfusion_Blazor_Layouts_TimelineOrientation_Horizontal) orientation the item content is placed at the top and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) at the bottom. In [`vertical`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineOrientation.html#Syncfusion_Blazor_Layouts_TimelineOrientation_Vertical) orientation, content is placed to the left and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) to the right.
1717

1818
```cshtml
1919
@@ -50,11 +50,13 @@ In [`Before`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.Ti
5050
5151
```
5252

53+
{% previewsample "https://blazorplayground.syncfusion.com/embed/hNrSMXMNhTCgiUvW?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
54+
5355
![Blazor Timeline Component with Before Alignment](./images/Blazor-align-before.png)
5456

5557
## After
5658

57-
In [`After`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_After) alignment, for [`horizontal`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineOrientation.html#Syncfusion_Blazor_Layouts_TimelineOrientation_Horizontal) orientation the item content is placed at the bottom and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) at the top whereas in `vertical`, the content to the right and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) to the left.
59+
In [`After`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_After) alignment, for [`horizontal`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineOrientation.html#Syncfusion_Blazor_Layouts_TimelineOrientation_Horizontal) orientation, item content is placed at the bottom and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) at the top. In `vertical` orientation, content is placed to the right and [`oppositeContent`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineItem.html#Syncfusion_Blazor_Layouts_TimelineItem_OppositeContent) to the left.
5860

5961
```cshtml
6062
@@ -91,11 +93,13 @@ In [`After`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.Tim
9193
9294
```
9395

96+
{% previewsample "https://blazorplayground.syncfusion.com/embed/LDBysNCtBpLrvjno?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
97+
9498
![Blazor Timeline Component with After Alignment](./images/Blazor-align-after.png)
9599

96100
## Alternate
97101

98-
In [`Alternate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Alternate) alignment, the item content are arranged alternatively regardless of the Timeline orientation.
102+
In [`Alternate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_Alternate) alignment, item content is arranged alternatively, regardless of the Timeline orientation.
99103

100104
```cshtml
101105
@@ -132,9 +136,11 @@ In [`Alternate`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts
132136
133137
```
134138

139+
{% previewsample "https://blazorplayground.syncfusion.com/embed/VZVIiDiDLprmoLpT?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
140+
135141
![Blazor Timeline Component with Alternate Alignment](./images/Blazor-align-alternate.png)
136142

137-
## Alternate reverse
143+
## Alternate Reverse
138144

139145
In [`AlternateReverse`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.TimelineAlignment.html#Syncfusion_Blazor_Layouts_TimelineAlignment_AlternateReverse) alignment, the item content are arranged in reverse alternate regardless of the Timeline orientation.
140146

@@ -173,4 +179,6 @@ In [`AlternateReverse`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.
173179
174180
```
175181

182+
{% previewsample "https://blazorplayground.syncfusion.com/embed/rNreWNWXhzAhJPqo?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
183+
176184
![Blazor Timeline Component with Alternate Reverse Alignment](./images/Blazor-align-alternatereverse.png)

blazor/timeline/customization.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ control: Timeline
77
documentation: ug
88
---
99

10-
# Customization in Blazor Timeline component
10+
# Customization in Blazor Timeline Component
1111

12-
You can customize the Timeline items dot size, connectors, dot borders, dot outer space and more to personalize its appearance. This section explains the different ways for styling the items.
12+
Customize the Timeline item's dot size, connectors, dot borders, and dot outer space to personalize its appearance. This section details various methods for styling the items.
1313

14-
## Connector styling
14+
## Connector Styling
1515

16-
### Common styling
16+
### Common Styling
1717

18-
You can define the styles applicable to the all the Timeline item connectors.
18+
Define styles applicable to all Timeline item connectors. The CSS selector `.e-timeline-item.e-connector::after` targets the pseudo-element representing the connector line for each item.
1919

2020
```cshtml
2121
@@ -59,11 +59,13 @@ You can define the styles applicable to the all the Timeline item connectors.
5959
6060
```
6161

62+
{% previewsample "https://blazorplayground.syncfusion.com/embed/VZrSsXCtVJSVQymc?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
63+
6264
![Blazor Timeline Component with Common Customized Connector](./images/Blazor-connector-common.png)
6365

64-
### Individual styling
66+
### Individual Styling
6567

66-
You can also apply unique styles to individual connectors, to differentiate specific items within the Timeline.
68+
Apply unique styles to individual connectors to differentiate specific items within the Timeline.
6769

6870
```cshtml
6971
@@ -111,13 +113,15 @@ You can also apply unique styles to individual connectors, to differentiate spec
111113
112114
```
113115

116+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BjVIijCXVzSGcbwr?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
117+
114118
![Blazor Timeline Component with Individual Customized Connector](./images/Blazor-connector-individual.png)
115119

116-
## Dot styling
120+
## Dot Styling
117121

118-
### Dot color
122+
### Dot Color
119123

120-
You can modify the color of the dots to highlight the specific Timeline items.
124+
Modify the color of the dots to highlight specific Timeline items. The `.e-dot` class targets the circular indicator for each item.
121125

122126
```cshtml
123127
@@ -173,11 +177,13 @@ You can modify the color of the dots to highlight the specific Timeline items.
173177
174178
```
175179

180+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BZBosDWNVzniYHpT?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
181+
176182
![Blazor Timeline Component with Customized Dot color](./images/Blazor-custom-dot-color.png)
177183

178-
### Dot size
184+
### Dot Size
179185

180-
You can adjust the size of the dot to make it larger or smaller by using the `--dot-size` variable.
186+
Adjust the dot size using the `--dot-size` CSS variable, making it larger or smaller. This variable primarily controls the dimensions of the `e-dot` element.
181187

182188
```cshtml
183189
@@ -237,11 +243,13 @@ You can adjust the size of the dot to make it larger or smaller by using the `--
237243
238244
```
239245

246+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BNhoMDCZhJdwIyCf?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
247+
240248
![Blazor Timeline Component with Customized Dot size](./images/Blazor-custom-dot-size.png)
241249

242-
### Dot shadow
250+
### Dot Shadow
243251

244-
You can add shadow effects to the Timeline dots to make it feel visually engaging by using the `--dot-outer-space` & `--dot-border` variables.
252+
Add shadow effects to Timeline dots for visual engagement using the `--dot-outer-space` and `--dot-border` CSS variables. These variables define the spacing and border around the dot, contributing to the shadow effect.
245253

246254
```cshtml
247255
@@ -292,11 +300,13 @@ You can add shadow effects to the Timeline dots to make it feel visually engagin
292300
293301
```
294302

303+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BDrIsDWZVzchTIyz?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
304+
295305
![Blazor Timeline Component with Customized Dot shadow](./images/Blazor-custom-dot-shadow.png)
296306

297-
### Dot variant
307+
### Dot Variant
298308

299-
You can achieve the desired dot variant by customizing the border, outline and background colors of the Timeline dots.
309+
Achieve desired dot variants by customizing the border, outline, and background colors of Timeline dots. This example demonstrates using pseudo-elements with `content` for visual differentiation, combined with styling of `--dot-size`, `--dot-radius`, and background/outline colors.
300310

301311
```cshtml
302312
@@ -368,11 +378,13 @@ You can achieve the desired dot variant by customizing the border, outline and b
368378
369379
```
370380

381+
{% previewsample "https://blazorplayground.syncfusion.com/embed/rDBIMjWjrJQutWVB?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
382+
371383
![Blazor Timeline Component with Customized Dot variant](./images/Blazor-custom-dot-variant.png)
372384

373-
### Dot outline
385+
### Dot Outline
374386

375-
By adding the `e-outline` class to the Timeline [`CssClass`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_CssClass) property it enables the dots to have an outline state.
387+
Adding the `e-outline` class to the Timeline's [`CssClass`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_CssClass) property enables dots to have a distinct outline style, visually emphasizing each item.
376388

377389
```cshtml
378390
@@ -416,4 +428,6 @@ By adding the `e-outline` class to the Timeline [`CssClass`](https://help.syncfu
416428
417429
```
418430

431+
{% previewsample "https://blazorplayground.syncfusion.com/embed/VjryCZitBflzyNaY?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
432+
419433
![Blazor Timeline Component with Customized Dot outline](./images/Blazor-custom-dot-outline.png)

blazor/timeline/events.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ documentation: ug
99

1010
# Events in Blazor Timeline component
1111

12-
This section describes the Timeline events that will be triggered when an appropriate actions are performed. The following events are available in the TImeline component.
12+
This section describes the Blazor Timeline events, which are triggered when appropriate actions are performed. The following events are available in the Timeline component.
1313

1414
## Created
1515

16-
The Timeline component triggers the [Created](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_Created) event when the component rendering is completed.
16+
The Timeline component triggers the [Created](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_Created) event when its rendering is completed.
1717

1818
```cshtml
1919
@@ -54,7 +54,7 @@ The Timeline component triggers the [Created](https://help.syncfusion.com/cr/bla
5454

5555
## ItemRendered
5656

57-
The Timeline component triggers the [ItemRendered](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_ItemRendered) event after rendering each item.
57+
The Timeline component triggers the [ItemRendered](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Layouts.SfTimeline.html#Syncfusion_Blazor_Layouts_SfTimeline_ItemRendered) event after each item is rendered.
5858

5959
```cshtml
6060

0 commit comments

Comments
 (0)