Skip to content

AppBar documentation #1749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 36 commits into from
Nov 14, 2023
Merged

AppBar documentation #1749

merged 36 commits into from
Nov 14, 2023

Conversation

svdimitr
Copy link
Contributor

No description provided.

@svdimitr svdimitr requested a review from a team November 14, 2023 12:16
@svdimitr svdimitr self-assigned this Nov 14, 2023
@svdimitr svdimitr requested a review from a team as a code owner November 14, 2023 12:16
@dimodi dimodi self-requested a review November 14, 2023 12:19

| 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?


private List<string> ThemeColors { get; set; } = new List<string>()
{
"base",
Copy link
Contributor

Choose a reason for hiding this comment

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

Better use the static constants, as we want to encourage customers to do the same.

Copy link
Contributor

@yordan-mitev yordan-mitev left a comment

Choose a reason for hiding this comment

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

Don't use placeholder meta descriptions. Use descriptions that describe the article content in some detail and that are around 150 symbols long.

---
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.


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.

---
title: Appearance
page_title: AppBar Appearance
description: Appearance settings of the AppBar 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.

Use detailed descriptions with a length of around 150 symbols. This is more like a placeholder.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is not, do you have a suggestion for a better description? The feature itself is rather small

| Parameter | Type and Default Value | Description |
| ----------- | ----------- | ----------- |
| `Class` | `string` | The CSS class that will be rendered on the main wrapping element of the AppBar spacer. You could use that class to cascade styles. |
| `Size` | `string` | The width of the spacer. If you add an `AppBarSpacer` tag without Size the spacer will take all available space between the [Sections]({%slug appbar-sections%}). |
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
| `Size` | `string` | The width of the spacer. If you add an `AppBarSpacer` tag without Size the spacer will take all available space between the [Sections]({%slug appbar-sections%}). |
| `Size` | `string` | The width of the spacer. If you add an `AppBarSpacer` tag without Size, the spacer will take all available space between the [Sections]({%slug appbar-sections%}). |

@svdimitr svdimitr merged commit 775f7e4 into master Nov 14, 2023
@github-actions github-actions bot deleted the appbar-docs branch November 14, 2023 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants