Skip to content

[4.1] docs(window,dialog): Document ThemeColor parameter #1325

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.

Sign up for GitHub

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
dimodi merged 1 commit into from
Mar 9, 2023
Merged

[4.1] docs(window,dialog): Document ThemeColor parameter #1325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions components/dialog/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,16 @@ The Blazor Dialog provides various parameters to configure the component. Also c

| Parameter | Type and Default Value | Description |
| --- | --- | --- |
| `ButtonsLayout` | `DialogButtonsLayout` enum <br /> (`Stretch`) | Defines the layout of the actions button in the footer. See more in the [Action Buttons article]({%slug dialog-action-buttons%})). |
| `Class` | `string` | Renders a custom CSS class to the `<div class="k-window k-dialog">` element. |
| `ButtonsLayout` | `DialogButtonsLayout` enum <br /> (`Stretch`) | The layout of the actions button in the footer. See more in the [Action Buttons article]({%slug dialog-action-buttons%})). |
| `Class` | `string` | A custom CSS class to the `<div class="k-window k-dialog">` element. |
| `CloseOnOverlayClick` | `bool` | Defines if clicking on the modal overlay should close the Dialog. |
| `FocusedElementSelector` | `string` | Defines the CSS selector of the initially focused item on open. By default, it is the first focusable item in the dialog. |
| `Height` | `string` | Sets the height of the Dialog in any [supported CSS unit]({%slug common-features/dimensions%}). |
| `FocusedElementSelector` | `string` | The CSS selector of the initially focused item on open. By default, it is the first focusable item in the Dialog. |
| `Height` | `string` | The height of the Dialog in any [supported CSS unit]({%slug common-features/dimensions%}). |
| `ShowCloseButton` | `bool` <br /> (`true`) | Defines if the component will render a Close button in the titlebar. See more in the [Header article]({%slug dialog-header%}). |
| `Title` | `string` | Sets the Dialog title. |
| `ThemeColor` | `string` | A predefined color scheme for the Dialog, especially the titlebar. Use the available members of the static class [`ThemeConstants.Dialog.ThemeColor`](/blazor-ui/api/Telerik.Blazor.ThemeConstants.Dialog.ThemeColor). |
| `Title` | `string` | The Dialog title. |
| `Visible` | `bool` | Defines the Dialog visibility. |
| `Width` | `string` | Sets the width of the Dialog in any [supported CSS unit]({%slug common-features/dimensions%}). |
| `Width` | `string` | The width of the Dialog in any [supported CSS unit]({%slug common-features/dimensions%}). |


## Dialog Reference and Methods
Expand Down
5 changes: 3 additions & 2 deletions components/window/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,9 @@ The following table lists the Window parameters, which are not discussed elsewhe

| Parameter | Type and Default&nbsp;Value | Description |
| --- | --- | --- |
| `Class` | `string` | Renders a custom CSS class to the `<div class="k-window">` element. Use it to [override theme styles]({%slug themes-override%}). Here is a [custom Window styling example]({%slug window-kb-custom-css-styling%}). |
| `Size` | `string` | Sets a predefined Window **width**. Use the string members of the static class `ThemeConstants.Window.Size` - `Small`, `Medium`, and `Large`. They translate to widths of `300px`, `800px` and `1200px`, respectively. If set, the `Width` parameter will take precedence over `Size`. |
| `Class` | `string` | The custom CSS class of the `<div class="k-window">` element. Use it to [override theme styles]({%slug themes-override%}). Here is a [custom Window styling example]({%slug window-kb-custom-css-styling%}). |
| `Size` | `string` | A predefined Window **width**. Use the string members of the static class `ThemeConstants.Window.Size` - `Small`, `Medium`, and `Large`. They translate to widths of `300px`, `800px` and `1200px`, respectively. If set, the `Width` parameter will take precedence over `Size`. |
| `ThemeColor` | `string` | A predefined color scheme for the Window, especially the titlebar. Use the available members of the static class [`ThemeConstants.Window.ThemeColor`](/blazor-ui/api/Telerik.Blazor.ThemeConstants.Window.ThemeColor). |
| `Visible` | `bool` | Defines if the Window is rendered and visible on the page. |


Expand Down