0
0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 19:21:50 +02:00

docs: added website docs

This commit is contained in:
2024-06-07 13:42:44 +02:00
parent 64abd67b9b
commit cf6e5a40fc
2 changed files with 22 additions and 0 deletions

View File

@ -0,0 +1,21 @@
(user.widgets.website)=
# [Website Widget](/api_reference/_autosummary/bec_widgets.cli.client.WebsiteWidget)
**Purpose:**
The Website Widget is a widget that allows you to display a website within the BEC GUI. The widget can be used to display any website.
**Key Features:**
- set the URL of the website to display.
- reload the website.
- navigate back and forward in the website history.
**Code example:**
The following code snipped demonstrates how to create a `WebsiteWidget` using BEC Widgets within BEC.
```python
# adds a new dock with a website widget
web = gui.add_dock().add_widget("Website")
# set the URL of the website to display
web.set_url("https://bec.readthedocs.io/en/latest/")
```

View File

@ -10,6 +10,7 @@ hidden: false
bec_figure/
spiral_progress_bar/
website/
```