Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
d44f8dd
docs(appbar): overview and docs structure
svdimitr Nov 14, 2023
3972cf1
docs(appbar): position article
svdimitr Nov 14, 2023
a0b7a55
docs(appbar): sections article
svdimitr Nov 14, 2023
975f14f
docs(appbar): separators article
svdimitr Nov 14, 2023
428ce1a
docs(appbar): use the correct snippet in the separators article
svdimitr Nov 14, 2023
3d6b7c0
docs(appbar): appearance article
svdimitr Nov 14, 2023
5674812
docs(appbar): add the component to the config file
svdimitr Nov 14, 2023
b85db7c
Update components/appbar/overview.md
svdimitr Nov 14, 2023
6cfa8e4
docs(appbar): remove the position step from overview
svdimitr Nov 14, 2023
87ea70a
Update components/appbar/overview.md
svdimitr Nov 14, 2023
1d28322
Update components/appbar/overview.md
svdimitr Nov 14, 2023
589c32e
Update components/appbar/overview.md
svdimitr Nov 14, 2023
2761ea3
Update components/appbar/overview.md
svdimitr Nov 14, 2023
469c206
Update components/appbar/appearance.md
svdimitr Nov 14, 2023
c65e5a9
Update components/appbar/position.md
svdimitr Nov 14, 2023
3a3f772
Update components/appbar/position.md
svdimitr Nov 14, 2023
5ef1a9f
docs(appbar): link the API from AppBar parameters
svdimitr Nov 14, 2023
4139dbd
Update components/appbar/sections.md
svdimitr Nov 14, 2023
e180546
Update components/appbar/sections.md
svdimitr Nov 14, 2023
ae43599
Update components/appbar/sections.md
svdimitr Nov 14, 2023
feb61d7
docs(appbar): beautify the snippet in the overview article
svdimitr Nov 14, 2023
252a840
docs(appbar): move the class, width, and height to style table
svdimitr Nov 14, 2023
ceca370
docs(appbar): fix the next steps
svdimitr Nov 14, 2023
dc9ba4c
Update components/appbar/separators.md
svdimitr Nov 14, 2023
3b54fa4
Update components/appbar/separators.md
svdimitr Nov 14, 2023
693fbfb
Update components/appbar/separators.md
svdimitr Nov 14, 2023
99ff2ff
docs(appbar): use singular in both columns
svdimitr Nov 14, 2023
59b4027
docs(appbar): improve positions article
svdimitr Nov 14, 2023
e954cd5
docs(appbar): imrpove Spacer docs
svdimitr Nov 14, 2023
94232d9
Update components/appbar/overview.md
svdimitr Nov 14, 2023
4b10b5d
Update components/appbar/overview.md
svdimitr Nov 14, 2023
8da108a
Update components/appbar/separators.md
svdimitr Nov 14, 2023
012ec13
Update components/appbar/separators.md
svdimitr Nov 14, 2023
c3416cd
Update components/appbar/separators.md
svdimitr Nov 14, 2023
959a512
Update components/appbar/separators.md
svdimitr Nov 14, 2023
771ea7c
Update components/appbar/overview.md
svdimitr Nov 14, 2023
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs(appbar): overview and docs structure
  • Loading branch information
svdimitr committed Nov 14, 2023
commit d44f8dd1c31e6d3bd2f733ac49a429b30e982d0f
51 changes: 51 additions & 0 deletions components/appbar/appearance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Appearance
page_title: ToolBar Appearance
description: Appearance settings of the ToolBar for Blazor.
slug: toolbar-appearance
tags: telerik,blazor,toolbar,appearance
published: True
position: 35
---

# Appearance Settings

This article outlines the available ToolBar parameters, which control its appearance.

## Size

You can increase or decrease the size of the ToolBar by setting the `Size` parameter to a member of the `Telerik.Blazor.ThemeConstants.ToolBar.Size` class:

| Class members | Manual declarations |
|---------------|--------|
| `Small` |`sm`|
| `Medium`<br /> default value |`md`|
| `Large` |`lg`|

>caption The built-in sizes

````CSHTML
@{
var fields = typeof(Telerik.Blazor.ThemeConstants.ToolBar.Size)
.GetFields(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Static
| System.Reflection.BindingFlags.FlattenHierarchy)
.Where(field => field.IsLiteral && !field.IsInitOnly).ToList();

foreach (var field in fields)
{
string size = field.GetValue(null).ToString();

<div style="float:left; margin: 20px;">
<TelerikToolBar Size="@size">
<ToolBarButton Icon="@SvgIcon.Cut">Cut</ToolBarButton>
<ToolBarButton Icon="@SvgIcon.Copy">Copy</ToolBarButton>
<ToolBarButton Icon="@SvgIcon.Clipboard">Paste</ToolBarButton>
</TelerikToolBar>
</div>
}
}
````

## See Also

* [Live Demo: ToolBar Appearance](https://demos.telerik.com/blazor-ui/toolbar/appearance)
132 changes: 132 additions & 0 deletions components/appbar/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
title: Overview
page_title: AppBar Overview
description: Overview of the AppBar component for Blazor.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is probably a placeholder that must be replaced with a more detailed description.

slug: appbar-overview
tags: telerik,blazor,appbar,navbar
published: True
position: 0
---

# Blazor AppBar Overview

The <a href = "https://www.telerik.com/blazor-ui/appbar" target="_blank">Blazor AppBar component</a> helps you build navigation bars for your application seemingly. This article explains the available features.

## Creating Blazor AppBar

1. Add the `<TelerikAppBar>` tag to a Razor file.
1. Use the `<AppBarSection>` child tag to add content to the AppBar component.
(optional) Use [content dividers](#content-dividers) to add visual distinction between the sections in the AppBar.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
(optional) Use [content dividers](#content-dividers) to add visual distinction between the sections in the AppBar.
1. (optional) Use [content dividers](#content-dividers) to add visual distinction between the sections in the AppBar.
1. (optional) Set the [position](#positioning) of the AppBar.

>caption Basic configuration of the Telerik AppBar

````CSHTML
<TelerikAppBar>
<AppBarSection>
<span>Our Logo</span>
</AppBarSection>

<AppBarSpacer Size="25%"></AppBarSpacer>

<AppBarSection>
<span>Our Products</span>
</AppBarSection>

<AppBarSpacer Size="50px"></AppBarSpacer>

<AppBarSection>
<span>Our Mission</span>
</AppBarSection>

<AppBarSpacer Size="5vw"></AppBarSpacer>

<AppBarSection>
<span>Contact Us</span>
</AppBarSection>

<AppBarSpacer></AppBarSpacer>

<AppBarSection>
<TelerikSvgIcon Icon="@SvgIcon.User"></TelerikSvgIcon>
</AppBarSection>

<AppBarSeparator></AppBarSeparator>

<AppBarSection>
<TelerikSvgIcon Icon="@SvgIcon.Logout"></TelerikSvgIcon>
</AppBarSection>
</TelerikAppBar>
````

## AppBar Sections

Use the AppBar Sections to render arbitrary HTML content to match the UI and UX needs of your application. [Read more about the Blazor AppBar sections]({%slug appbar-section%}).

## Content Dividers

The AppBar features separators and spacers that can visually divide the component items. [Read more about the Blazor AppBar separators and spacers.]({%slug appbar-separators%}).

## Positioning

You can control the position of the AppBar and how the component behaves according to the flow of the page. [Read more about the Blazor AppBar positioning.]({%slug appbar-position%}).

## AppBar Parameters

The Blazor AppBar provides parameters to configure the component:

@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

| Parameter | Type | Description |
| ----------- | ----------- | ----------- |
| `Class` | `string` | The CSS class to be rendered on the main wrapping element of the AppBar component, which is `<div class="k-appbar">`. Use for [styling customizations]({%slug themes-override%}). |
| `Height` | `string` | The height of the AppBar. |
| `Position` | `AppBarPosition` <br /> (`None`) | The position of the AppBar on the page. [Read more about AppBar positioning.]({%slug appbar-position%}) |
| `PositionMode` | `AppBarPosition` <br /> (`Static`) | Sets how the AppBar is positioned according to the flow of the document. [Read more about AppBar positioning.]({%slug appbar-position%}) |
| `Width` | `string` | The width of the AppBar |

### Styling and Appearance

The following parameters enable you to customize the appearance of the Blazor AppBar:

| Parameter | Type | Description |
| --- | --- | --- |
| `ThemeColor` | `Telerik.Blazor.ThemeConstants.AppBar.ThemeColor` | Adjust the color of the AppBar |

You can find more information for customizing the AppBar appearance in the [Appearance article]({%slug appbar-appearance%}).

## AppBar Reference and Methods

To execute AppBar methods, obtain reference to the component instance via `@ref`.

| Method | Description |
|---------|-------------|
| `Refresh` | Use the method to programmatically re-render the AppBar. |
Copy link
Contributor

Choose a reason for hiding this comment

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

When will this be necessary?


<div class="skip-repl"></div>

````CSHTML
<TelerikButton OnClick="@RefreshAppBar">Refresh AppBar</TelerikButton>

<TelerikAppBar @ref="AppBarRef" />

@code {
private TelerikAppBar AppBarRef { get; set; }

private void RefreshAppBar()
{
AppBarRef.Refresh();
}
}
````

## Next Steps

* [Explore the AppBar Sections]({%slug appbar-sections%})
* [Use the AppBar Content]({%slug appbar-separators%})
* [Customize the AppBar positioning options]({%slug appbar-position%})

## See Also

* [Live AppBar Demos](https://demos.telerik.com/blazor-ui/appbar/overview)
* [AppBar API Reference](/blazor-ui/api/Telerik.Blazor.Components.TelerikAppBar)
51 changes: 51 additions & 0 deletions components/appbar/position.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Appearance
page_title: ToolBar Appearance
description: Appearance settings of the ToolBar for Blazor.
slug: toolbar-appearance
tags: telerik,blazor,toolbar,appearance
published: True
position: 35
---

# Appearance Settings

This article outlines the available ToolBar parameters, which control its appearance.

## Size

You can increase or decrease the size of the ToolBar by setting the `Size` parameter to a member of the `Telerik.Blazor.ThemeConstants.ToolBar.Size` class:

| Class members | Manual declarations |
|---------------|--------|
| `Small` |`sm`|
| `Medium`<br /> default value |`md`|
| `Large` |`lg`|

>caption The built-in sizes

````CSHTML
@{
var fields = typeof(Telerik.Blazor.ThemeConstants.ToolBar.Size)
.GetFields(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Static
| System.Reflection.BindingFlags.FlattenHierarchy)
.Where(field => field.IsLiteral && !field.IsInitOnly).ToList();

foreach (var field in fields)
{
string size = field.GetValue(null).ToString();

<div style="float:left; margin: 20px;">
<TelerikToolBar Size="@size">
<ToolBarButton Icon="@SvgIcon.Cut">Cut</ToolBarButton>
<ToolBarButton Icon="@SvgIcon.Copy">Copy</ToolBarButton>
<ToolBarButton Icon="@SvgIcon.Clipboard">Paste</ToolBarButton>
</TelerikToolBar>
</div>
}
}
````

## See Also
Copy link
Contributor

@dimodi dimodi Nov 14, 2023

Choose a reason for hiding this comment

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

Add the most logical next step(s) before See Also. It's good for SEO too.


* [Live Demo: ToolBar Appearance](https://demos.telerik.com/blazor-ui/toolbar/appearance)
Loading