Skip to content

Commit a4ae068

Browse files
authored
Document minor enhancements (#2280)
* docs(Pager): add showinfo parameter in parameter section * docs(Card): add height parameter to parameters section * docs(Carousel): add themecolor parameter to parameters section * chore: apply suggestions
1 parent 8d335a8 commit a4ae068

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

components/card/overview.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,12 @@ The Card provides various parameters that allow you to configure the component:
6262

6363
| Parameter | Type | Description |
6464
| ----------- | ----------- | -------|
65-
| `Width` | `string` | defines width of the component.
66-
| `Class` | `string` | the CSS class that will be rendered on the main wrapping element of the Card.
67-
| `Orientation` | `CardOrientation` | defines the orientation of the card. Takes a member of the `Telerik.Blazor.CardOrientation` enum (`Horizontal` or `Vertical`). Read more in the [Card Orientation article]({%slug card-orientation%}).
68-
| `ThemeColor` | `string` | defines the appearance of the component. We support predefined theme colors such as primary, secondary, tertiary, success, info, warning, error, dark, light, and inverse (members of the `Telerik.Blazor.ThemeConstants.Card` class). Test changing the Card theme colors in our [live demo](https://demos.telerik.com/blazor-ui/card/appearance).
69-
| `ChildContent` | `RenderFragment` | defines the child content of the component. All possible building blocks can be directly used as a `ChildContent` of the Card.
65+
| `Class` | `string` | The CSS class that will be rendered on the main wrapping element of the Card.
66+
| `ChildContent` | `RenderFragment` | Defines the child content of the component. All possible [Card Building Blocks]({%slug card-building-blocks%}) can be directly used as a `ChildContent` of the Card.
67+
| `Height` | `string` | Defines the height of the component.
68+
| `Orientation` | `CardOrientation` | Defines the orientation of the card. Takes a member of the `Telerik.Blazor.CardOrientation` enum (`Horizontal` or `Vertical`). Read more in the [Card Orientation article]({%slug card-orientation%}).
69+
| `ThemeColor` | `string` | Defines the appearance of the component. We support predefined theme colors such as primary, secondary, tertiary, success, info, warning, error, dark, light, and inverse (members of the `Telerik.Blazor.ThemeConstants.Card` class). Test changing the Card theme colors in our [live demo](https://demos.telerik.com/blazor-ui/card/appearance).
70+
| `Width` | `string` | Defines the width of the component.
7071

7172

7273
>tip To make multiple Cards occupy the same **height** automatically, use the predefined [Deck or Group layouts]({%slug card-layouts%}). If the Cards should wrap to multiple rows, use the custom [Tile layout](https://demos.telerik.com/blazor-ui/card/data-cards). It is also possible to set a specific height to Cards with a CSS rule.

components/carousel/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ The following table lists Carousel parameters. Check the [Carousel API Reference
8282
| `Width` | `string` | The Carousel width. See [Dimensions]({%slug common-features/dimensions%}) for more details. The Carousel renders in a `<div>`, so it expands horizontally to 100% by default.|
8383
| `Height` | `string` | The Carousel height. By default and by design, the component has no height and does not expand, based on its content. *In other words, the Carousel will be zero pixels high, if height is not applied.*|
8484
| `Class` | `string` | The CSS class that will be rendered on the main wrapping element of the component. Use it to apply custom styles or [override the theme]({%slug themes-override%}).
85+
| `ThemeColor` | `string` <br /> (`"light"`) | Sets predefined colors to the Carousel component. Use the members of the static class `ThemeConstants.Carousel.ThemeColor` to set valid values. |
8586

8687
## Carousel Reference and Methods
8788

components/pager/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ The Blazor Pager provides various parameters that allow you to configure the com
8787
| `PageSize` | `int` | The number of items to display on a page. Supports two-way binding. |
8888
| `PageSizes` | `List<int?>` | Allows users to change the page size via a DropDownList. The attribute configures the DropDownList options. A `null` item in the `PageSizes` `List` will render an "All" option. By default, the Pager DropDownList is not displayed. You can also set `PageSizes` to `null` programmatically to remove the DropDownList at any time. |
8989
| `InputType` | `PagerInputType` enum <br /> (`Buttons`) | Determines if the pager will show numeric buttons to go to a specific page, or a textbox to type the page index. The arrow buttons are always visible. The `PagerInputType` enum accepts values `Buttons` (default) or `Input`. When `Input` is used, the page index will change when the textbox is blurred, or when the user hits Enter. This is to avoid unintentional data requests. |
90+
| `ShowInfo` | `bool` <br /> (`true`) | Defines whether the information about the current page and the total number of records is present. |
9091
| `Total` | `int` | Represents the total count of items in the pager. |
9192

9293
### Styling and Appearance

0 commit comments

Comments
 (0)