From 7f7bdbdb8c40861bd47d1265f81fd2ce88d58270 Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Fri, 10 Feb 2023 16:20:43 +0200 Subject: [PATCH] docs(window,dialog): Document ThemeColor parameter --- components/dialog/overview.md | 13 +++++++------ components/window/overview.md | 5 +++-- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/components/dialog/overview.md b/components/dialog/overview.md index b7f11a7636..6d41690257 100644 --- a/components/dialog/overview.md +++ b/components/dialog/overview.md @@ -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
(`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 `
` element. | +| `ButtonsLayout` | `DialogButtonsLayout` enum
(`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 `
` 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`
(`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 diff --git a/components/window/overview.md b/components/window/overview.md index a1d634a1bc..44edd6ff20 100644 --- a/components/window/overview.md +++ b/components/window/overview.md @@ -74,8 +74,9 @@ The following table lists the Window parameters, which are not discussed elsewhe | Parameter | Type and Default Value | Description | | --- | --- | --- | -| `Class` | `string` | Renders a custom CSS class to the `
` 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 `
` 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. |