From 4e5520aee2115d2fc0cebb3865433478a5ec8253 Mon Sep 17 00:00:00 2001 From: wyzula-jan Date: Tue, 27 Aug 2024 18:40:06 +0200 Subject: [PATCH] docs(buttons): added missing buttons docs --- docs/user/widgets/buttons/buttons.md | 21 ++++++++++++++++++++- docs/user/widgets/widgets.md | 2 +- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/docs/user/widgets/buttons/buttons.md b/docs/user/widgets/buttons/buttons.md index 2209dfdc..02ebd155 100644 --- a/docs/user/widgets/buttons/buttons.md +++ b/docs/user/widgets/buttons/buttons.md @@ -1,6 +1,6 @@ (user.widgets.buttons)= -# Service Buttons +# Buttons `````{tab} Overview @@ -34,6 +34,25 @@ The `Dark Mode Button` is a toggle control that allows users to switch between l **Key Features:** - **Theme Switching**: Enables users to switch between light and dark themes with a single click. - **Configurable from BECDesigner**: The defaults for the dark mode can be set in the BECDesigner, allowing users to customize the startup appearance of the GUI. + + +## Color Button + +The `Color Button` is a user interface element that provides a dialog to select colors. This button, adapted from `pyqtgraph`, is a simple yet powerful tool to integrate color selection functionality into the BEC GUIs. + +**Key Features:** +- **Color Selection**: Opens a dialog for selecting colors, returning the selected color in both RGBA and HEX formats. + +## Colormap Selector + +The `Colormap Selector` is a specialized combobox that allows users to select a colormap. It includes a preview of the colormap, making it easier for users to choose the appropriate one for their needs. + +**Key Features:** +- **Colormap Selection**: Provides a dropdown to select from all available colormaps in `pyqtgraph`. +- **Visual Preview**: Displays a small preview of the colormap next to its name, enhancing usability. + + + ````` ````{tab} Examples diff --git a/docs/user/widgets/widgets.md b/docs/user/widgets/widgets.md index 2532b612..ce46b49d 100644 --- a/docs/user/widgets/widgets.md +++ b/docs/user/widgets/widgets.md @@ -135,7 +135,7 @@ Various utility widgets to enhance user experience. ````{grid} 3 :gutter: 2 -```{grid-item-card} Service Buttons +```{grid-item-card} Buttons :link: user.widgets.buttons :link-type: ref :img-top: /assets/widget_screenshots/buttons.png