Skip to content

Commit b3007fc

Browse files
yordan-mitevdimodi
andauthored
Update the ThemeBuilder Docs for the Initial Release (#1149)
* update themebuilder docs for the initial release * Update styling-and-themes/custom-theme.md * Update styling-and-themes/custom-theme.md * Update styling-and-themes/custom-theme.md * Apply suggestions from review Co-authored-by: Dimo Dimov <[email protected]>
1 parent e1e0431 commit b3007fc

File tree

6 files changed

+21
-86
lines changed

6 files changed

+21
-86
lines changed

accessibility/accessibility-swatch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Telerik UI for Blazor distributes the Default Ocean Blue theme swatch via severa
1919
In addition, it is also available in:
2020

2121
* [Themes CDN]({%slug themes-swatches%}#built-in-themes-and-swatches-list)
22-
* [Sass Themebuilder](https://themebuilder.telerik.com/blazor-ui) - for testing and [color customization]({%slug themes-custom%})
22+
* [ThemeBuilder](https://themebuilderapp.telerik.com)&mdash;for testing and [color customization]({%slug themes-custom%})
2323
* [kendo-themes repository](https://github.com/telerik/kendo-themes)
2424

2525
## See Also

knowledge-base/common-themebuilder-json-from-scss.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ res_type: kb
2424
## Description
2525
I have a custom theme `SCSS` (SASS) file with variables and values, which I created with the [SASS Theme Builder](https://themebuilder.telerik.com/blazor-ui). I want to import this `SCSS` file to the Theme Builder to make some changes, but the Theme Builder now requires a `JSON` file import.
2626

27+
> Starting with R3 2022, ThemeBuilder is accessible from a [new URL](https://themebuilderapp.telerik.com). This new ThemeBuilder version replaces the [previous ThemeBuilder](https://themebuilder.telerik.com/) and provides more free features and also a Pro tier. All your existing custom themes will continue to work in the new ThemeBuilder.
28+
2729
## Cause\Possible Cause(s)
2830
The Theme Builder used to accept an `SCSS` (SASS) file to import an existing custom theme. This caused [some issues](https://github.com/telerik/kendo-themes/issues/2043) and we decided to switch to `JSON` import instead.
2931

styling-and-themes/custom-theme.md

Lines changed: 14 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Custom Themes
33
page_title: Custom Themes
4-
description: Create a custom theme for the UI for Blazor components based on the built-in ones.
4+
description: Learn how to create a custom theme for you Blazor application and alter the default appearance of the UI for Blazor components.
55
slug: themes-custom
66
tags: telerik,blazor,theme,custom
77
published: True
@@ -11,15 +11,12 @@ position: 3
1111

1212
# Custom Themes
1313

14-
By customizing themes you can alter the default appearance of the Telerik components so they match the desired color scheme from your designers and fit with the rest of your site's coloring and style.
14+
By customizing themes, you can alter the default appearance of the Telerik components so they match the desired color scheme and the rest of your site's coloring and style.
1515

1616
This article contains the following sections:
1717

1818
* [What is the best way to customize the Telerik Blazor styles](#best-way-to-customize-the-telerik-blazor-css)
19-
* [Using the Sass Theme Builder](#using-the-sass-theme-builder)
20-
* [Create New Theme](#create-new-theme)
21-
* [Modifying Themes](#modifying-themes)
22-
* [Import Custom Theme](#import-custom-theme)
19+
* [Using the ThemeBuilder](#using-themebuilder)
2320
* [Use The Custom Theme In Your Project](#use-the-custom-theme-in-your-project)
2421
* [Manual Alternative](#manual-alternative)
2522
* [Using the Build Process of the Application](#using-the-build-process-of-the-application)
@@ -34,85 +31,20 @@ This article contains the following sections:
3431

3532
There are **three** ways to customize the appearance of the Telerik Blazor components. Each has pros and cons, and each is most suitable for specific scenarios and business requirements. Learn more about the [Blazor CSS theme customization alternatives]({%slug common-kb-theme-customization-options%}).
3633

37-
## Using the Sass Theme Builder
34+
## Using ThemeBuilder
3835

39-
The Progress [**Sass Theme Builder for Blazor**](https://themebuilder.telerik.com/blazor-ui) is an Angular web application that enables you to create new or customize existing themes.
36+
[ThemeBuilder](https://themebuilderapp.telerik.com) is a web application that enables you to create new themes and customize existing ones.
4037

41-
This article will walk you through the tool and will explain how to use the generated custom theme.
38+
The tool helps you achieve a unique appearance for your Blazor apps and delivers full control over the visual elements of the Telerik UI for Blazor components. After you create or customize your theme, you can download it and integrate it in your project.
4239

43-
>caption Figure 1: The home screen of the Sass Theme Builder
4440

45-
![Blazor Theme Builder home screen](images/theme-builder-overview.png)
41+
> Starting with R3 2022, ThemeBuilder is accessible from a [new URL](https://themebuilderapp.telerik.com). This new ThemeBuilder version replaces the [previous ThemeBuilder](https://themebuilder.telerik.com/) and provides more free features and also a Pro tier. All your existing custom themes will continue to work in the new ThemeBuilder.
4642
47-
### Create New Theme
43+
To learn more about using ThemeBuilder, visit the [ThemeBuilder documentation portal](https://docs.telerik.com/themebuilder) where you can learn how to:
4844

49-
To create a new theme:
50-
51-
1. On the initial Sass Theme Builder pane, select the **Start Theming** option.
52-
53-
1. Choose one of the existing themes to use as a base.
54-
55-
1. Select the components which you intend to style. You can also change the selection at a later stage.
56-
57-
>caption Figure 2: Selecting a base theme and components
58-
59-
![Select Blazor Theme Builder theme and components](images/theme-builder-select-base-theme.gif)
60-
61-
1. Follow the next options in this article to customize the theme
62-
63-
Complex Telerik UI for Blazor components, such as the Grid, rely on other components to deliver their full set of features. If you select the Grid, then all of its components dependencies styles (Button, AutoComplete, DropDownList, DatePicker, etc.) will also be included in the final bundle. The Theme Builder automatically updates the styling on all required components so that you do not need to customize each of them separately.
64-
65-
### Modifying Themes
66-
67-
The Sass Theme Builder supports the following options for customization:
68-
69-
* Color pickers which customize the main aspects of the components' coloring based on your deired color scheme.
70-
* For the Material theme, there are fewer options as per its guidelines - colors are derived from fewer variables.
71-
* Predefined color swatches - these are predefined color palettes that you can step on. They were chosen by our design team.
72-
* They match known Kendo themes such as BlueOpal, Silver, Office365.
73-
74-
The following list describes the Theme Builder UI:
75-
76-
1. Color Swatches pane - expand it to see the available predefined palettes.
77-
2. Base Theme name - the name of the theme you step onto.
78-
3. Color pickers and other controls for customizing the theme.
79-
4. Link to documentation.
80-
5. Download the theme when you are done tweaking, so you can reference it in your project.
81-
6. Selected Components list - you can select which components to include in the preview and the final CSS bundle.
82-
83-
The rest is the Preview pane where you can see the changes in real-time as you make them through the controls on the left.
84-
85-
>caption Figure 3: Theme Builder UI Explained
86-
87-
![Blazor Theme Builder UI explained](images/theme-builder-ui-explanations.png)
88-
89-
### Import Custom Theme
90-
91-
You can also upload a theme you have previously worked on:
92-
93-
1. On the initial Sass Theme Builder pane, select **Import Theme**.
94-
1. Upload the `theme-name.json` file, which is part of the ZIP that you have previously downloaded from the Theme Builder. If you don't have a JSON file, you can [create it from the SCSS file]({% slug common-kb-themebuilder-json-from-scss%}) or create the custom theme from scratch.
95-
1. The JSON file contains the list of SASS variables and their values. When it is uploaded, the selected components and styling customizations will load.
96-
1. Start [customizing your theme](#modifying-themes).
97-
98-
>caption Figure 4: Importing themes for customization
99-
100-
![Importing theme in the Blazor Theme Builder](images/theme-builder-import.png)
101-
102-
### Use The Custom Theme In Your Project
103-
104-
When you complete the modifications and the theme is ready to be used:
105-
106-
1. Download the theme as a ZIP archive by clicking the **Download** button.
107-
108-
1. Add the `THEME_NAME.css` file to the `wwwroot/css/` folder your application.
109-
1. Include the `THEME_NAME.css` file in the `<head>` tag of your `_Host.cshtml`/`index.html` document, for example:
110-
111-
`<link rel="stylesheet" href="css/THEME_NAME.css" />`
112-
113-
1. Keep the `scss` and `json` files for future reference, when you need to re-generate the theme or customize it further.
114-
115-
>Make sure that the above CSS file is the only Telerik Theme, which is referenced in the application.
45+
* [Create a custom theme](https://docs.telerik.com/themebuilder/get-started/first-steps-theme-builder)
46+
* [Import a JSON file with an existing theme](https://docs.telerik.com/themebuilder/web-app/importing-json)
47+
* [Use the theme in your Blazor app](https://docs.telerik.com/themebuilder/exported-package)
11648

11749
## Manual Alternative
11850

@@ -264,7 +196,7 @@ The following list describes the theme variables available for adjustment in the
264196

265197
## How to Use a Custom Theme I Have
266198

267-
You have your custom theme - either generated through the Telerik Theme Builder tool, or one that you built yourself, or something that your organization provides.
199+
You have your custom theme - either generated through the Telerik ThemeBuilder tool, or one that you built yourself, or something that your organization provides.
268200

269201
To use that, instead of one of the built-in themes, you need to:
270202

@@ -291,5 +223,6 @@ To contribute to the development of the Kendo UI Default Theme, refer to the [te
291223

292224
## See Also
293225

294-
* [Blazor Theme Builder](https://themebuilder.telerik.com/blazor-ui)
226+
* [Progress ThemeBuilder](https://themebuilderapp.telerik.com)
227+
* [Progress ThemeBuilder Documentation](https://docs.telerik.com/themebuilder)
295228
* [Kendo SASS Themes](https://docs.telerik.com/kendo-ui/styles-and-layout/sass-themes)

styling-and-themes/swatch-distribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ position: 2
1010

1111
# Swatch Distribution
1212

13-
Telerik UI for Blazor distributes the most commonly used swatches. While it is possiblle to get them from the [Themes CDN]({%slug themes-swatches%}#buit-in-themes-and-swatches-list), the [Sass Theme Builder]({%slug themes-custom%}#using-the-sass-theme-builder) or the [kendo-themes repository](https://github.com/telerik/kendo-themes), this article lists a couple other ways of distribution.
13+
Telerik UI for Blazor distributes the most commonly used swatches. While it is possiblle to get them from the [Themes CDN]({%slug themes-swatches%}#buit-in-themes-and-swatches-list), the [Sass Theme Builder]({%slug themes-custom%}#using-themebuilder) or the [kendo-themes repository](https://github.com/telerik/kendo-themes), this article lists a couple other ways of distribution.
1414

1515
>caption In this article:
1616

styling-and-themes/theme-swatches.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ Telerik UI for Blazor comes with three [built-in (base) themes]({%slug general-i
2121

2222
The theme swatches are different color variations of the base themes. While they use the same variables as the built-in theme they accompany, they have different color values to deliver a variety of shades for the Telerik components.
2323

24-
You can explore the swatches in our [live demos](https://demos.telerik.com/blazor-ui/grid/overview). The `Change Theme` dropdown provides a list of the most common swatches. To test how all the available swatches affect the appearance of the Telerik UI for Blazor components, you might check the [Sass Themebuilder](https://themebuilder.telerik.com/blazor-ui). It also provides option for [customizing the existing themes]({%slug themes-custom%}) if needed.
24+
You can explore the swatches in our [live demos](https://demos.telerik.com/blazor-ui/grid/overview). The `Change Theme` dropdown provides a list of the most common swatches. To test how all the available swatches affect the appearance of the Telerik UI for Blazor components, you might check the [ThemeBuilder](https://themebuilderapp.telerik.com). It also provides option for [customizing the existing themes]({%slug themes-custom%}) if needed.
2525

2626
In addition, Telerik UI for Blazor distributes some swatches via several other resources. Read more in the [Swatch Distribution]({%slug themes-swatch-distribution%}) article.
2727

2828
## Built-in themes and swatches list
2929

3030
Here is a complete list of the base themes, all available swatches and their CDN URLs in a dedicated Themes CDN.
3131

32-
* [Default](#default) - These are the mostly ported swatches from our [Sass Themebuilder](https://themebuilder.telerik.com/blazor-ui).
32+
* [Default](#default) - These are the mostly ported swatches from our [ThemeBuilder](https://themebuilderapp.telerik.com).
3333

3434
* [Bootstrap](#bootstrap) - Main swatch is the current "[Bootstrap]({%slug general-information/themes%}#bootstrap-notes)" theme, which is built on Bootstrap 5. As the other names suggest, Bootstrap 3 and Bootstrap 4 swatches are color swatches adapted to look like the respective versions.
3535

upgrade/breaking-changes/3-0-0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ We are making our API naming more consistent.
499499

500500
## Rendering and Themes
501501

502-
>important The [HTML rendering and CSS classes have been updated for multiple components](https://www.telerik.com/blogs/improvements-coming-telerik-kendo-ui-themes-2022), including Buttons, Textbox components, Dropdown components, Date/Time Pickers, Checkbox, Switch. [Recreate any custom themes]({%slug themes-custom%}) via [import]({%slug themes-custom%}#import-custom-theme) or [from scratch]({%slug themes-custom%}#using-the-sass-theme-builder).
502+
>important The [HTML rendering and CSS classes have been updated for multiple components](https://www.telerik.com/blogs/improvements-coming-telerik-kendo-ui-themes-2022), including Buttons, Textbox components, Dropdown components, Date/Time Pickers, Checkbox, Switch. [Recreate any custom themes]({%slug themes-custom%}) via [import]({%slug themes-custom%}#import-custom-theme) or [from scratch]({%slug themes-custom%}#using-themebuilder).
503503
504504
### CSS Classes for State
505505

0 commit comments

Comments
 (0)