Skip to content

Commit 9964d06

Browse files
Merge pull request #6847 from syncfusion-content/874804-accessibility
Updated the Blazor common UG documentation
2 parents 76cce69 + 0cf1426 commit 9964d06

30 files changed

+381
-381
lines changed

blazor/appearance/figma.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
---
22
layout: post
3-
title: Introduction to the Figma UI Kit in Blazor - Syncfusion
4-
description: Check out and learn about the introduction to the Figma UI Kit in the Syncfusion Blazor and more details.
3+
title: Figma UI kits for Syncfusion Blazor - Syncfusion
4+
description: Learn about Syncfusion’s Figma UI kits for Blazor, available for Material 3, Fluent, Tailwind, and Bootstrap 5 themes, and how to export design tokens.
55
platform: Blazor
6-
component: Common
6+
control: Common
77
documentation: ug
88
---
99

10-
# Figma UI Kits for Syncfusion® Controls
10+
# Figma UI kits for Syncfusion® controls
1111

12-
Syncfusion<sup style="font-size:70%">&reg;</sup> offers [Figma UI kits](https://www.figma.com/@syncfusion) to facilitate effective collaboration between designers and developers. The Figma UI kits are available in four themes: [Material 3](https://www.figma.com/community/file/1385969023252455137/syncfusion-ui-kit-material-3-theme), [Fluent](https://www.figma.com/community/file/1385969120047188707/syncfusion-ui-kit-fluent-theme), [Tailwind](https://www.figma.com/community/file/1385969065626384098/syncfusion-ui-kit-tailwind-theme), and [Bootstrap 5](https://www.figma.com/community/file/1385968977953858272/syncfusion-ui-kit-bootstrap-5-theme). These kits match the themes used in Syncfusion<sup style="font-size:70%">&reg;</sup> controls.
12+
Syncfusion<sup style="font-size:70%">&reg;</sup> provides [Figma UI kits](https://www.figma.com/@syncfusion) to streamline collaboration between designers and developers. The kits match the themes used by Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components and are available for [Material 3](https://www.figma.com/community/file/1454123774600129202/syncfusion-ui-kit-material-3-theme), [Fluent](https://www.figma.com/community/file/1385969120047188707/syncfusion-ui-kit-fluent-theme), [Tailwind](https://www.figma.com/community/file/1385969065626384098/syncfusion-ui-kit-tailwind-theme), and [Bootstrap 5](https://www.figma.com/community/file/1385968977953858272/syncfusion-ui-kit-bootstrap-5-theme).
1313

14-
The kits contain reusable design controls with various possible states and variants, along with detailed figures, measurements, and icons, representing the Syncfusion<sup style="font-size:70%">&reg;</sup> controls.
14+
Each kit contains reusable design controls with states and variants, along with detailed figures, measurements, and icons that represent Syncfusion<sup style="font-size:70%">&reg;</sup> controls.
1515

16-
![Material 3](./images/material3.png)
16+
![Preview of the Material 3 Figma UI kit](./images/material3.png)
1717

1818
## Advantages of UI kits
1919

20-
The Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI kit offers the following key advantages:
21-
- The UI kit includes detailed information about Syncfusion<sup style="font-size:70%">&reg;</sup> controls, such as available control lists, their states, and variants. This facilitates a quick understanding of Syncfusion<sup style="font-size:70%">&reg;</sup> controls.
22-
- Design controls are developed using the [atomic design methodology](https://atomicdesign.bradfrost.com/chapter-2/), making customization straightforward and efficient.
23-
- Developers can seamlessly match Syncfusion<sup style="font-size:70%">&reg;</sup> controls with your design requirements, ensuring alignment and accuracy.
24-
- By using standardized controls and themes, the UI kit ensures consistency in your designs, maintaining a uniform look and feel across projects.
20+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI kits offer the following advantages:
21+
- Detailed information about controls, including lists, states, and variants, to quickly understand available options.
22+
- Design controls follow the [atomic design methodology](https://atomicdesign.bradfrost.com/chapter-2/), making customization straightforward.
23+
- Developers can match Syncfusion<sup style="font-size:70%">&reg;</sup> controls to design requirements for alignment and accuracy.
24+
- Standardized controls and themes maintain a consistent look and feel across projects.
2525

2626
## Downloading the UI kits
2727

28-
Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI kits are available in the [Figma community](https://www.figma.com/@syncfusion). You can download the Syncfusion<sup style="font-size:70%">&reg;</sup> theme-specific Figma UI kits from the following links:
28+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI kits are available in the [Figma community](https://www.figma.com/@syncfusion). Download the theme-specific kits from the following links:
2929

3030
- [Material 3](https://www.figma.com/community/file/1454123774600129202/syncfusion-ui-kit-material-3-theme)
3131
- [Fluent](https://www.figma.com/community/file/1385969120047188707/syncfusion-ui-kit-fluent-theme)
@@ -34,7 +34,7 @@ Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI kits are available in
3434

3535
## Structure of the UI kits
3636

37-
Syncfusion’s Figma UI kit is structured to offer a comprehensive and user-friendly layout, facilitating easy navigation and exploration of various controls. It includes the following pages:
37+
The Figma UI kits are structured for easy navigation and exploration of controls. They include the following pages:
3838

3939
- **Thumbnail**: This page serves as the cover page for the UI kit.
4040
- **Index**: Here, users can find a detailed list of all control names, making it simple to identify and locate specific controls within the UI kit.
@@ -45,57 +45,57 @@ Syncfusion’s Figma UI kit is structured to offer a comprehensive and user-frie
4545

4646
## Customizing the UI kits
4747

48-
The Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI kits are easily customizable to meet your specific needs, allowing you to create unique designs and adjust colors to match your brand guidelines. The [atomic design methodology](https://atomicdesign.bradfrost.com/chapter-2/) used in developing these controls, your customizations will be seamlessly reflected across multiple controls and their variants.
48+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI kits are customizable to meet specific needs, allowing unique designs and color adjustments to match brand guidelines. Because the controls are built using the [atomic design methodology](https://atomicdesign.bradfrost.com/chapter-2/), customizations will be seamlessly reflected across multiple controls and variants.
4949

5050
Here's how to customize the primary button color of the Material 3 theme within your layout:
5151

5252
1. Visit our [UI kits](#downloading-the-ui-kits) and choose your preferred theme, such as the Material 3 theme.
53-
2. Open the selected theme in the Figma web application by clicking the **Open in Figma** button.
54-
3. For the desktop application, click the **Import** button in the top-right corner of the page. Select the downloaded Syncfusion<sup style="font-size:70%">&reg;</sup> fig file you want to import and click the **Open** button.
53+
2. Open the selected theme in the Figma web application by clicking **Open in Figma**.
54+
3. For the desktop application, click **Import** in the top-right corner. Select the downloaded Syncfusion<sup style="font-size:70%">&reg;</sup> Figma file and click **Open**.
5555
4. Identify the button you wish to customize within your layout.
56-
5. On the right side of the Figma interface, find the color variable options listed. For example, the variable for a particular button color might be labeled as `$primary-bg-color`, derived from the primary color variable.
57-
6. To customize this primary button control color, click outside the button to see the **Local variables** option on the right side of the Figma interface. It contains the design token for the color variables. Click the **Local variables** option.
56+
5. On the right side of the Figma interface, locate the color variables. For example, a button color variable might be labeled `$primary-bg-color`, derived from the primary color variable.
57+
6. To customize the primary button color, click outside the button to reveal the **Local variables** panel. It contains the design tokens for color variables. Click **Local variables**.
5858
7. A popup will show the design token list. You can change the primary color using a color palette.
5959
8. Once you've selected the new color (e.g., pink) for the primary variable, the button's color pattern will be updated accordingly. You'll see the changes reflected in real-time within your design.
6060

61-
![Customization](./images/customize.png)
61+
![Customize a component primary color using local variables](./images/customize.png)
6262

6363
In addition to changing the button color, you can also customize other aspects like font, spacing, shadows, etc., of the UI controls:
6464

6565
Feel free to experiment with these customization options to create a design that perfectly matches your requirements.
6666

67-
## Downloading the customized styles
67+
## Download customized styles
6868

69-
Effortlessly download customized style changes as tokens and CSS variables using the `Syncfusion<sup style="font-size:70%">&reg;</sup> Design Tokens` plugin. This plugin bridges the gap between design and development by converting Figma design variables into Syncfusion<sup style="font-size:70%">&reg;</sup> tokens for direct use in your applications to ensure a smooth transition from design to implementation.
69+
Download customized style changes as tokens and CSS variables using the Syncfusion<sup style="font-size:70%">&reg;</sup> Design Tokens plugin. This plugin bridges the gap between design and development by converting Figma design variables into Syncfusion<sup style="font-size:70%">&reg;</sup> tokens for direct use in your applications to ensure a smooth transition from design to implementation.
7070

7171
### Exporting design tokens
7272

7373
Follow these steps to download the customized styles from the Figma UI Kit:
7474

7575
- First, open a [Syncfusion<sup style="font-size:70%">&reg;</sup> Figma UI Kit](https://www.figma.com/@syncfusion).
76-
- Navigate to the `Plugin & widgets` section in Figma and search for the `Syncfusion<sup style="font-size:70%">&reg;</sup> Design Tokens`.
77-
- Once found, run the plugin. A popup will appear with an `Export` button.
76+
- Navigate to the `Plugins and widgets` section in Figma and search for **Syncfusion<sup style="font-size:70%">&reg;</sup> Design Tokens**.
77+
- Run the plugin. A dialog appears with an `Export` button.
7878
- Click the `Export` button. This action will generate a zip file containing your design tokens.
7979
- Select a directory to save the exported files.
8080
- Extract the downloaded zip file to access its contents.
8181

8282
![export-design-tokens](./images/syncfusion-design-tokens.png)
8383

84-
### Utilizing design tokens
84+
### Use design tokens
8585

8686
The exported zip file includes the following files:
87-
- `css-variables.css`: The css-variables.css file contains CSS variables for both light and dark themes, directly derived from your Figma designs. You can easily import this file into your application alongside the component styles to reflect your custom designs.
88-
- `<theme-name>-tokens.json`: This file (e.g., material3-tokens.json) contains style variables and values in a JSON format compatible with [Theme Studio](./theme-studio). This file, prefixed with the corresponding theme name, can be [imported](./theme-studio#import-previously-changed-settings-into-the-theme-studio) into [Theme Studio](./theme-studio) for further customization. After processing in [Theme Studio](./theme-studio), you can [download](./theme-studio#download-the-customized-theme) the updated styles file and integrate it into your application, bringing your custom themes to life.
87+
- `css-variables.css`: Contains CSS variables for light and dark themes derived from the Figma design. Import this file alongside component styles to reflect custom designs.
88+
- `<theme-name>-tokens.json`: Contains style variables and values in a JSON format compatible with [Theme Studio](./theme-studio). This file, prefixed with the corresponding theme name, can be [imported](./theme-studio#import-previously-changed-settings-into-the-theme-studio) into [Theme Studio](./theme-studio) for further customization. After processing in [Theme Studio](./theme-studio), you can [download](./theme-studio#download-the-customized-theme) the updated styles file and integrate it into your application, bringing your custom themes to life.
8989

9090
This streamlined process ensures that your unique design vision, crafted in Figma, is accurately translated into your final application, maintaining consistency between design and implementation.
9191

92-
## Upgrading the UI kits
92+
## Upgrade the UI kits
9393

94-
To upgrade your UI kits, download the latest version from the provided links. Follow these guidelines for a seamless upgrade process:
94+
To upgrade the UI kits, download the latest versions from the links above. Follow these guidelines for a seamless upgrade:
9595

9696
- Keep track of updates or new versions of UI kits from Syncfusion.
9797
- Before upgrading, back up your ongoing projects to prevent data loss or compatibility issues.
98-
- Share your experience with Syncfusion<sup style="font-size:70%">&reg;</sup> regarding the upgraded UI kits, including any issues encountered or suggestions for improvement.
98+
- Share feedback regarding the upgraded UI kits, including any issues encountered or suggestions for improvement.
9999

100100
## See also
101101

blazor/appearance/icons.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
layout: post
3-
title: Icons Library in Blazor - Syncfusion
4-
description: Checkout and learn here all about how to use Icons in the Syncfusion Blazor Component and its type of icons.
3+
title: Blazor icons library - Syncfusion
4+
description: Learn how to use the Syncfusion Blazor icons with SfIcon and e-icons, set sizes and tooltips, customize appearance, and integrate third-party icon fonts.
55
platform: Blazor
6-
component: Common
6+
control: Common
77
documentation: ug
88
---
99

10-
# Blazor Icons Library
10+
# Blazor icons library
1111

12-
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor library provides the set of `base64` formatted font icons which are being used in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components. These icons can be utilized in the web applications using `SfIcon` component or `e-icons` class.
12+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor library provides a set of base64-formatted font icons used across Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components. Icons can be used via the `SfIcon` component or the `e-icons` CSS class.
1313

14-
Check out the video to quickly get started with the Blazor Icon component:
14+
Watch a quick-start video for the Blazor Icon component:
1515

1616
{% youtube
1717
"youtube:https://www.youtube.com/watch?v=H1nQCAHzKZ0"%}
@@ -20,7 +20,7 @@ Check out the video to quickly get started with the Blazor Icon component:
2020

2121
Syncfusion<sup style="font-size:70%">&reg;</sup> Icon component provides support to render predefined Syncfusion<sup style="font-size:70%">&reg;</sup> icons or custom font icons.
2222

23-
You can refer [Getting Started with Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor for Server-side in Visual Studio page](https://blazor.syncfusion.com/documentation/getting-started/blazor-server-side-visual-studio) for the introduction and configuring the common specifications.
23+
Refer to the [Getting started with Syncfusion Blazor Web App](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) guide for installation and common configuration.
2424

2525
The following code example shows the rendering of built-in Syncfusion<sup style="font-size:70%">&reg;</sup> icons from predefined [IconName](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.IconName.html) options using [Name](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.SfIcon.html#Syncfusion_Blazor_Buttons_SfIcon_Name) property by defining them in `SfIcon` tag.
2626

@@ -39,7 +39,7 @@ The following code example shows the rendering of built-in Syncfusion<sup style=
3939

4040
### Icon size
4141

42-
The font size of the icon can be changed using the [Size](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.SfIcon.html#Syncfusion_Blazor_Buttons_SfIcon_Size) property. The icon displays `Medium` size by default.
42+
The font size of the icon can be changed using the [Size](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.SfIcon.html#Syncfusion_Blazor_Buttons_SfIcon_Size) property. The default size is `Medium`.
4343

4444
* When IconSize set to Small, the font size will be `8px`.
4545
* When IconSize set to Medium, the font size will be `16px`.
@@ -95,7 +95,7 @@ N> The `Size` property is applicable only when defining the icon using `Name` pr
9595

9696
### Icon appearance customization
9797

98-
The [SfIcon](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.SfIcon.html) supports to customize color and size by overriding the `e-icons` class.
98+
The [SfIcon](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.SfIcon.html) supports customizing color and size by overriding the `e-icons` class.
9999

100100
The following example code demonstrates the custom font-size and color for icons.
101101

@@ -119,14 +119,16 @@ The following example code demonstrates the custom font-size and color for icons
119119

120120
![Blazor Icon Component Customization](./images/icons/custom-icon.png)
121121

122-
### Third party icons integration
122+
### Thirdparty icons integration
123123

124124
The [SfIcon](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.SfIcon.html) supports to render custom font icons using the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Buttons.SfIcon.html#Syncfusion_Blazor_Buttons_SfIcon_IconCss) property. To render custom font icons define the required font CSS that provides the required font name, font size, and content for the icon.
125125

126126
The following code explains how to render `open-iconic` icons using `IconCss` property.
127127

128128
Include the stylesheet reference in the `<head>` section of the **~/App.razor** file as shown below:
129129

130+
Example link tag:
131+
130132
```html
131133
<head>
132134
....
@@ -183,9 +185,9 @@ The following example shows how to integrate the icons with Syncfusion<sup style
183185
![Using Icons with Blazor Button Component](./images/icons/button-integration.png)
184186

185187

186-
## Using icons directly in HTML element
188+
## Use icons directly in an HTML element
187189

188-
The built-in Syncfusion<sup style="font-size:70%">&reg;</sup> icons can be rendered directly in the HTML element by defining `e-icons` class that contains the font-family and common property of font icons, and defining the [available icon's](#icons-list) class with `e-` prefix.
190+
Built-in Syncfusion<sup style="font-size:70%">&reg;</sup> icons can be rendered directly in an HTML element by adding the `e-icons` class (font family and common properties) and the [available icon](#icons-list) class with the `e-` prefix.
189191

190192
The following code example explains the direct rendering of Syncfusion<sup style="font-size:70%">&reg;</sup> `search` icon in the span element.
191193

-125 KB
Loading
-112 KB
Loading
-86 KB
Loading
-84.3 KB
Loading
-107 KB
Loading
-108 KB
Loading
-128 KB
Loading

0 commit comments

Comments
 (0)