mirror of
https://github.com/bec-project/bec_widgets.git
synced 2025-07-14 03:31:50 +02:00
docs: update docs for various widgets
This commit is contained in:
@ -4,7 +4,7 @@
|
||||
|
||||
````{tab} Overview
|
||||
|
||||
The `Device Browser` widget provides a user-friendly interface for browsing through all available devices in the current BEC session. As it supports drag functionality, users can easily drag and drop device into other widgets or applications.
|
||||
The [`Device Browser`](/api_reference/_autosummary/bec_widgets.cli.client.DeviceBrowser) widget provides a user-friendly interface for browsing through all available devices in the current BEC session. As it supports drag functionality, users can easily drag and drop device into other widgets or applications.
|
||||
|
||||
```{note}
|
||||
The `Device Browser` widget is currently under development. Other widgets may not support drag and drop functionality yet.
|
||||
@ -24,7 +24,10 @@ In this example, we demonstrate how to add a `DeviceBrowser` widget to a `BECDoc
|
||||
|
||||
```python
|
||||
# Add a new dock with a DeviceBrowser widget
|
||||
browser = gui.add_dock().add_widget("DeviceBrowser")
|
||||
dock_area = gui.new()
|
||||
browser = dock_area.new("device_browser").new(gui.available_widgets.DeviceBrowser)
|
||||
# You can also access the DeviceBrowser widget directly from the dock_area
|
||||
dock_area.device_browser.DeviceBrowser
|
||||
```
|
||||
|
||||
````
|
||||
|
Reference in New Issue
Block a user