robotframework-dialogsplus 0.1.1__tar.gz → 0.2.1__tar.gz

robotframework_dialogsplus-0.2.1/CLAUDE.md

@@ -0,0 +1,45 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project
+
+`robotframework-dialogsplus` — a Robot Framework library providing modern, styled GUI dialogs (built on `customtkinter`) as a drop-in enhancement to Robot Framework's built-in `Dialogs` library. It only works with a real desktop (GUI dialogs require an interactive display), so it cannot run in headless CI/CD environments.
+
+## Commands
+
+Package management is via `uv` (see `uv.lock`).
+
+```bash
+uv sync                      # install dependencies into .venv
+uv run robot atests/         # run the acceptance tests (opens real GUI dialogs — requires manual interaction)
+uv run robot atests/testing.robot -t "Get Confirmation Returns Boolean"   # run a single test case by name
+uv run robotidy src atests   # format Robot Framework files (robotframework-tidy, a dev dependency)
+uv run ruff check .          # lint Python source
+uv build                     # build the wheel/sdist (hatchling backend)
+```
+
+There is no Python unit test suite — correctness is verified only through the `.robot` acceptance tests in `atests/`, which pop up real dialog windows and require a human (or scripted UI automation) to click through them. They cannot run in headless/CI environments.
+
+Keyword documentation (`docs/DialogsPlus.html`) is generated from the library's docstrings via Robot Framework's Libdoc, e.g.:
+
+```bash
+uv run python -m robot.libdoc src/DialogsPlus/dialogsplus.py docs/DialogsPlus.html
+```
+
+## Architecture
+
+The library follows a three-layer structure, all under `src/DialogsPlus/`:
+
+1. **`dialogsplus.py`** — the Robot Framework library class (`DialogsPlus`, `ROBOT_LIBRARY_SCOPE = 'SUITE'`). Each public method is decorated `@keyword` and becomes a Robot Framework keyword (e.g. `get_value_from_user_input` → `Get Value From User Input`). This layer only handles keyword argument parsing/validation, dynamic size calculations (e.g. dialog height/width scaled by number of fields/options in `get_multi_value` and `select_options_with_checkboxes`), and delegates the actual dialog logic to `widgets/wrappers.py`. The class constructor optionally loads a `DialogConfig` from a YAML file (`Library DialogsPlus config=path/to/config.yaml`).
+
+2. **`widgets/wrappers.py`** — one static-method "runner" class per keyword (e.g. `GetValueFromUserDialog`, `MultiValueInput`, `ChooseFromFileDialog`). Each wrapper instantiates the corresponding dialog class from `widgets/styling.py`, calls `.show()`, logs via `robot.api.logger`, and translates the raw dialog result dict into the keyword's return value (e.g. mapping a `status` of `"yes"/"no"/"cancel"` to `True/False/None`). `ExecuteManualStepDialog` also raises `robot.errors.ExecutionFailed` when the user fails a manual step, prompting for a failure reason via a nested `InputDialog`.
+
+3. **`widgets/styling.py`** — the actual `customtkinter`-based dialog implementations (`InputDialog`, `ManualStepDialog`, `CountdownDialog`, `ConfirmationDialog`, `MultiValueInputDialog`, `FileDialog`, `FolderDialog`, `CheckboxConfirmationDialog`, `MultiCheckboxDialog`, `PauseDialog`). Each subclasses `BaseDialog` from `widgets/base.py` and implements `build_ui(app)`, populating `self.result` and calling `app.quit()` on submit/cancel.
+
+Supporting modules:
+
+- **`widgets/base.py`** — `BaseDialogRunner` creates/centers/tears down the `ctk.CTk()` app window (sets appearance mode/theme once globally on first use, sets the window icon from `widgets/assets/robot.ico`, and runs `app.mainloop()`), and `BaseDialog` provides the styled widget factory methods (`create_button`, `create_label`, `create_entry`, `create_frame`, `create_progress_bar`, `create_checkbox`) that all dialogs use, plus the generic `show()` → `build_ui()` → return `self.result` flow.
+- **`utils/config.py`** — `DialogConfig` holds all visual/layout settings (theme, fonts, colors, sizes, spacing) with defaults, and `DialogConfig.from_yaml(path)` loads overrides from a user-supplied YAML config file (see `atests/config.yaml` for the shape).
+
+When adding a new keyword: add a `@keyword`-decorated method to `dialogsplus.py`, a runner class (or static method) in `wrappers.py`, and a new `BaseDialog` subclass in `styling.py` — following the existing pattern rather than putting UI logic directly in `dialogsplus.py`.

{robotframework_dialogsplus-0.1.1 → robotframework_dialogsplus-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: robotframework-dialogsplus
-Version: 0.1.1
+Version: 0.2.1
 Summary: A drop-in enhancement for Robot Framework's Dialogs library with modern UI and extended user interaction keywords.
 Author-email: Alpha-Centauri-00 <Alpha@Centauri.c0m>
 License-Expression: MIT
@@ -31,12 +31,18 @@ A drop-in enhancement for Robot Framework's Dialogs library with modern UI and e
 - Supports dynamic sizing based on input fields or options
 
 ---
+## Installation
 
-## 📚 Keyword Documentation
+```bach
+pip install robotframework-dialogsplus
+```
 
-👉 View DialogsPlus Keyword [Docs](https://alpha-centauri-00.github.io/DialogsPlus/DialogsPlus.html)
 
+## 📚 Keyword Documentation
 
+👉 View DialogsPlus Keyword [Docs](https://alpha-centauri-00.github.io/DialogsPlus/DialogsPlus.html)
 
+👉 More Example of [HowTo](https://github.com/Alpha-Centauri-00/DialogsPlus/blob/main/docs/HowTo.md)
+                           
 
 Pull requests are welcome! More info coming soon.

{robotframework_dialogsplus-0.1.1 → robotframework_dialogsplus-0.2.1}/README.md

@@ -19,12 +19,18 @@ A drop-in enhancement for Robot Framework's Dialogs library with modern UI and e
 - Supports dynamic sizing based on input fields or options
 
 ---
+## Installation
 
-## 📚 Keyword Documentation
+```bach
+pip install robotframework-dialogsplus
+```
 
-👉 View DialogsPlus Keyword [Docs](https://alpha-centauri-00.github.io/DialogsPlus/DialogsPlus.html)
 
+## 📚 Keyword Documentation
 
+👉 View DialogsPlus Keyword [Docs](https://alpha-centauri-00.github.io/DialogsPlus/DialogsPlus.html)
 
+👉 More Example of [HowTo](https://github.com/Alpha-Centauri-00/DialogsPlus/blob/main/docs/HowTo.md)
+                           
 
 Pull requests are welcome! More info coming soon.

robotframework_dialogsplus-0.2.1/atests/testing.robot

@@ -0,0 +1,215 @@
+*** Settings ***
+Library           DialogsPlus    #config=D:/robotframework-dialogsplus/atests/config.yaml
+Library           OperatingSystem
+
+# Suite Setup       Set Log Level    level=TRACE
+# Test Setup        Log Test Case Name
+
+
+*** Keywords ***
+Log Test Case Name
+    [Tags]    robot:flatten
+    Log    <p style="background-color: #06bdb1; font-weight: bold; display: inline-block; padding: 4px;">*** Running Test: ${TEST NAME} ***</p>    html=${True}
+
+log Hello
+    Log     Hello    level=WARN
+
+*** Variables ***
+
+@{fields_val}     username    password    email    phone
+@{fields}         username    password
+&{default_val}    username=admin    password=P@55    phone=1234567
+&{default}        username=user1    password=P@55
+
+*** Test Cases ***
+
+Get Value From User Default
+    ${result}    Get Value From User Input   
+    ...    prompt=Enter your name:    
+    ...    default=Robot framework
+    
+    Should Be Equal    ${result}    Robot framework
+
+Run Manual Steps Executes
+    VAR    @{steps}        
+    ...    Open the app    
+    ...    Click Start button    
+    ...    Verify status
+
+    Run Manual Steps    ${steps}
+    Log    Manual steps executed successfully
+
+Run Manual Steps Executes With Plain Args
+    Run Manual Steps    
+    ...                open github    
+    ...                add username    
+    ...                add password    
+    ...                press login
+
+    Log    Manual steps executed successfully
+
+Count Down Runs
+    Count Down    3
+    Log    Countdown executed for 3 seconds
+
+Get Confirmation Returns Boolean
+    ${result}    Get Confirmation    Are you sure?
+    Should Be True    isinstance(${result}, bool)
+
+Get Multi Value
+    ${result}    Get Multi Value    ${fields}    default=${default}
+    Should Be Equal    ${result}[username]    user1
+
+
+Get Multi Value Multiple Fields
+    ${result}    Get Multi Value    ${fields_val}    default=${default_val}
+    Should Be Equal    ${result}[password]    P@55
+    Should Be Equal    ${result}[phone]       1234567
+
+Choose Single XML File
+    ${XML_FILETYPES}    Evaluate    [("xml files", "*.xml")]
+    ${result}=    Choose File    
+    ...    message=Select Single XML File    
+    ...    filetypes=${XML_FILETYPES}
+    
+    Should Contain    ${result}    .xml
+
+Choose Multiple HTML Files
+    ${HTML_FILETYPES}    Evaluate    [("HTML", "*.html")]
+    ${result}=    Choose File    
+    ...    message=Select Multiple HTML Files    
+    ...    filetypes=${HTML_FILETYPES}   multiple=True
+
+    Should Contain    ${result}[0]    .html
+
+Choose Folder Test
+    ${result}=    Choose Folder    message=Select Any Directory
+    Directory Should Exist    ${result}
+
+Single Ceckbox Test
+    ${r}    Confirm With Checkbox    
+    ...    message=Do you accept the terms?    
+    ...    checkbox_text=I accept, no matter what!
+
+    Should Be True    ${r}
+
+Select Many Checkbox Test
+    ${r}    Select Options With Checkboxes    
+    ...    message=Select as much as you want   
+    ...    options=${fields_val}
+
+    Should Not Be True    ${r}[username]
+    Should Not Be True    ${r}[password]
+    Should Not Be True    ${r}[email]
+    Should Not Be True    ${r}[phone]
+
+Select Many Checkbox With Defaults Test
+    @{Contacts}    Create List        Email    SMS    Phone    Slack    Discord
+    @{Selected_Defaults}    Create List    Email    SMS
+    ${selected}=    Select Options With Checkboxes
+    ...    message=Choose your preferences
+    ...    options=${Contacts}
+    ...    defaults=@{Selected_Defaults}         # Default Selected!
+    
+    Should Be True        ${selected}[Email]
+    Should Be True        ${selected}[SMS]
+    Should Not Be True    ${selected}[Phone]
+    Should Not Be True    ${selected}[Slack]
+    Should Not Be True    ${selected}[Discord]
+
+Pause The Test
+    Pause Test Execution    message=Check If System Is Running!
+
+Pause The Test With Command
+    Pause Test Execution    message=Check If System Is Running!    command=log Hello
+
+Pause The Test With Command That Opens A Dialog
+    @{args}    Create List    2
+    Pause Test Execution
+    ...    message=Check If System Is Running!
+    ...    command=Count Down
+    ...    command_args=${args}
+
+Pause The Test With Command That Fails
+    TRY
+        Pause Test Execution    message=Click Run, then Continue    command=Not Exist Keyword
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+
+Create Dialog With Text Box And Checkbox
+    Create Dialog    title=Login Form
+    Add Text Box    name=username    label=Username    default=admin
+    Add Checkbox    name=remember_me    label=Remember Me
+    Add Button    text=OK
+    Add Button    text=Cancel
+    ${result}    Show Dialog
+    Log    Button clicked: ${result}[button]
+    Log    Username: ${result}[username]
+    Log    Remember me: ${result}[remember_me]
+
+
+Create Dialog With Side Command Button
+    Create Dialog    title=Diagnostics
+    Add Label    text=Run diagnostics before continuing if you like.
+    Add Button    text=Run Diagnostics    command=log Hello    closes_dialog=False
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Be Equal    ${result}[button]    OK
+
+Add Text Box Fails Without Create Dialog First
+    TRY
+        Add Text Box    name=orphan
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+
+Create Dialog Fails Without A Closing Button
+    Create Dialog    title=No Closing Button
+    Add Label    text=This has no OK/Cancel button
+    TRY
+        Show Dialog
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+
+Create Dialog With Masked Text Box
+    Create Dialog    title=Login Form
+    Add Text Box    name=username    label=Username    default=admin
+    Add Text Box    name=password    label=Password    mask=True
+    Add Button    text=OK
+    ${result}    Show Dialog
+
+Create Dialog With Radio Group
+    Create Dialog    title=Test Result
+    Add Radio Group    name=verdict    label=Verdict    options=Pass|Fail|Blocked    default=Pass
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Contain    ${{['Pass', 'Fail', 'Blocked']}}    ${result}[verdict]
+    Log    Verdict selected: ${result}[verdict]
+
+Add Radio Group Fail and Pass
+    Create Dialog    title=Verdict
+    Add Radio Group    name=verdict    options=Pass|Fail    default=Pass
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Be Equal    ${result}[verdict]    Pass
+
+Create Dialog With Dropdown
+    Create Dialog    title=Browser Selection
+    Add Dropdown    name=browser    label=Browser    options=Chrome|Firefox|Edge    default=Firefox
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Log    Browser selected: ${result}[browser]
+
+Add Dropdown Fails With Bad Default
+    Create Dialog    title=Bad Dropdown Default
+    TRY
+        Add Dropdown    name=browser    options=Chrome|Firefox    default=Safari
+    EXCEPT    AS    ${error}
+        Log    Caught expected failure: ${error}
+    END
+    Add Dropdown    name=browser    options=Chrome|Firefox    default=Chrome
+    Add Button    text=OK
+    ${result}    Show Dialog
+    Should Be Equal    ${result}[browser]    Chrome

{robotframework_dialogsplus-0.1.1 → robotframework_dialogsplus-0.2.1}/docs/DialogsPlus.html

@@ -8,7 +8,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="Generator" content>
 <script type="text/javascript">
-libdoc = {"specversion": 3, "name": "DialogsPlus", "doc": "<p>DialogsPlus is a modern, customizable drop-in enhancement for Robot Framework\u2019s Dialogs library, built on top of customtkinter.</p>\n<p>This library extends standard dialog capabilities with stylish and user-friendly GUI dialogs, supporting customization of colors, fonts, and sizes via an external config.yaml file.</p>\n<p>Features:</p>\n<ul>\n<li>Easy-to-use dialogs for interactive test runs.</li>\n<li>Full GUI interface using customtkinter.</li>\n<li>Customizable appearance (colors, fonts, sizes, etc.) through config.yaml.</li>\n<li>Dynamic sizing based on user input or options.</li>\n<li>Drop-in replacement for Robot Framework\u2019s standard Dialogs library.</li>\n</ul>\n<p>Note:</p>\n<ul>\n<li>Not supported in headless environments (e.g., CI/CD pipelines like Jenkins or GitHub Actions).</li>\n</ul>\n<p>DialogsPlus is ideal for enhancing user interactions in Robot Framework tests with modern UI elements and extended keyword support.</p>", "version": "", "generated": "2025-10-19T13:09:15+00:00", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 21, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "config", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "config: str | None = None"}], "returnType": null, "doc": "<p>Initialize DialogsPlus library with optional YAML config file.</p>", "shortdoc": "Initialize DialogsPlus library with optional YAML config file.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 40}], "keywords": [{"name": "Choose File", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = "}, {"name": "filetypes", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "tuple", "typedoc": "tuple", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filetypes: List[tuple] | None = None"}, {"name": "multiple", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "multiple: bool = False"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Opens file picker dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Instruction text</li>\n<li>filetypes: List of (description, pattern) tuples, e.g. [(\"Text files\", \"*.txt\")]</li>\n<li>multiple: Allow selecting multiple files</li>\n</ul>\n<p>Returns file path string, list of paths if multiple=True, or None if cancelled.</p>", "shortdoc": "Opens file picker dialog.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 111}, {"name": "Choose Folder", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Opens folder picker dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Instruction text</li>\n</ul>\n<p>Returns folder path string or None if cancelled.</p>", "shortdoc": "Opens folder picker dialog.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 124}, {"name": "Confirm With Checkbox", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}, {"name": "checkbox_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "I agree", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "checkbox_text: str = I agree"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Shows confirmation dialog with checkbox.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Prompt text</li>\n<li>checkbox_text: Label for checkbox</li>\n</ul>\n<p>Returns True if checkbox was checked, False otherwise.</p>", "shortdoc": "Shows confirmation dialog with checkbox.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 135}, {"name": "Count Down", "args": [{"name": "seconds", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "seconds: int | str"}], "returnType": null, "doc": "<p>Shows countdown timer dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>seconds: Duration in seconds</li>\n</ul>\n<p>Dialog closes automatically when timer reaches zero.</p>", "shortdoc": "Shows countdown timer dialog.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 71}, {"name": "Get Confirmation", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Shows Yes/No/Cancel confirmation dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Question or prompt text</li>\n</ul>\n<p>Returns True for Yes, False for No, None for Cancel.</p>", "shortdoc": "Shows Yes/No/Cancel confirmation dialog.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 82}, {"name": "Get Multi Value", "args": [{"name": "fields", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "fields: str | List[str]"}, {"name": "default", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: Dict[str, str] | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Prompts user for multiple input values in one dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>fields: List of field names or single field</li>\n<li>default: Dictionary of default values per field</li>\n</ul>\n<p>Returns dictionary with field names as keys and user inputs as values, or None if cancelled.</p>", "shortdoc": "Prompts user for multiple input values in one dialog.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 93}, {"name": "Get Value From User Input", "args": [{"name": "prompt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Enter value:", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt: str = Enter value:"}, {"name": "default", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: str = "}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Prompts user for text input via dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>prompt: Text displayed above input field</li>\n<li>default: Pre-filled value</li>\n</ul>\n<p>Returns string input or None if cancelled.</p>", "shortdoc": "Prompts user for text input via dialog.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 48}, {"name": "Pause Test Execution", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Test execution paused", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = Test execution paused"}], "returnType": null, "doc": "<p>Pauses test execution until user clicks Continue.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Text displayed in dialog</li>\n</ul>\n<p>Test resumes when user clicks Continue button.</p>", "shortdoc": "Pauses test execution until user clicks Continue.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 175}, {"name": "Run Manual Steps", "args": [{"name": "steps", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "steps: str | List[str]"}], "returnType": null, "doc": "<p>Displays manual test steps with Pass/Fail buttons.</p>\n<p>Arguments:</p>\n<ul>\n<li>steps: Single step string or list of step strings</li>\n</ul>\n<p>Raises ExecutionFailed if user clicks Fail button.</p>", "shortdoc": "Displays manual test steps with Pass/Fail buttons.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 60}, {"name": "Select Options With Checkboxes", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}, {"name": "options", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "options: str | List[str]"}, {"name": "defaults", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "defaults: List[str] | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": false}, "doc": "<p>Shows multiple checkboxes for selection.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Instruction text</li>\n<li>options: List of options or pipe-separated string</li>\n<li>defaults: List of pre-selected option names</li>\n</ul>\n<p>Returns dictionary with option names as keys and True/False as values.</p>", "shortdoc": "Shows multiple checkboxes for selection.", "tags": [], "source": "D:\\robotframework-dialogsplus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 147}], "typedocs": [{"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["Choose File", "Confirm With Checkbox", "Get Confirmation", "Select Options With Checkboxes"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["Get Multi Value", "Select Options With Checkboxes"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["Count Down"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["Choose File", "Get Multi Value", "Run Manual Steps", "Select Options With Checkboxes"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__", "Choose File", "Choose Folder", "Get Confirmation", "Get Multi Value", "Get Value From User Input", "Select Options With Checkboxes"], "accepts": ["string"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Choose File", "Choose Folder", "Confirm With Checkbox", "Count Down", "Get Confirmation", "Get Multi Value", "Get Value From User Input", "Pause Test Execution", "Run Manual Steps", "Select Options With Checkboxes"], "accepts": ["Any"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["Choose File"], "accepts": ["string", "Sequence"]}]}
+libdoc = {"specversion": 3, "name": "DialogsPlus", "doc": "<p>DialogsPlus is a modern, customizable drop-in enhancement for Robot Framework\u2019s Dialogs library, built on top of customtkinter.</p>\n<p>This library extends standard dialog capabilities with stylish and user-friendly GUI dialogs, supporting customization of colors, fonts, and sizes via an external config.yaml file.</p>\n<p>Features:</p>\n<ul>\n<li>Easy-to-use dialogs for interactive test runs.</li>\n<li>Full GUI interface using customtkinter.</li>\n<li>Customizable appearance (colors, fonts, sizes, etc.) through config.yaml.</li>\n<li>Dynamic sizing based on user input or options.</li>\n<li>Drop-in replacement for Robot Framework\u2019s standard Dialogs library.</li>\n</ul>\n<p>Note:</p>\n<ul>\n<li>Not supported in headless environments (e.g., CI/CD pipelines like Jenkins or GitHub Actions).</li>\n</ul>\n<p>DialogsPlus is ideal for enhancing user interactions in Robot Framework tests with modern UI elements and extended keyword support.</p>", "version": "", "generated": "2026-08-23T15:45:04+00:00", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 24, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "config", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "config: str | None = None"}], "returnType": null, "doc": "<p>Initialize DialogsPlus library with optional YAML config file.</p>", "shortdoc": "Initialize DialogsPlus library with optional YAML config file.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 43}], "keywords": [{"name": "Add Button", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "command", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "command: str | None = None"}, {"name": "command_args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "command_args: List[str] | None = None"}, {"name": "closes_dialog", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "closes_dialog: bool = True"}], "returnType": null, "doc": "<p>Adds a button to the dialog being built with Create Dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>text: Button label, and the value recorded under result['button'] if it closes the dialog</li>\n<li>command: Optional keyword name to run when clicked, via Robot Framework's Run Keyword - must be a keyword already available in the running suite</li>\n<li>command_args: Optional list of arguments passed to that keyword</li>\n<li>closes_dialog: If True (default), clicking this button runs its command (if any), collects the current field values, and closes the dialog. If False, the button only runs its command and the dialog stays open - e.g. for a \"Run Diagnostics\" action next to OK/Cancel.</li>\n</ul>\n<p>Raises ExecutionFailed if called before Create Dialog.</p>", "shortdoc": "Adds a button to the dialog being built with Create Dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 334}, {"name": "Add Checkbox", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "label", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label: str | None = None"}, {"name": "default", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: bool = False"}], "returnType": null, "doc": "<p>Adds a checkbox to the dialog being built with Create Dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>name: Key used for this field's True/False value in Show Dialog's result</li>\n<li>label: Text shown next to the checkbox (defaults to name)</li>\n<li>default: Whether the checkbox starts checked</li>\n</ul>\n<p>Raises ExecutionFailed if called before Create Dialog, or if name was already used.</p>", "shortdoc": "Adds a checkbox to the dialog being built with Create Dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 258}, {"name": "Add Dropdown", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "options", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "options: str | List[str]"}, {"name": "label", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label: str | None = None"}, {"name": "default", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: str | None = None"}], "returnType": null, "doc": "<p>Adds a dropdown (single choice) to the dialog being built with Create Dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>name: Key used for this field's selected value in Show Dialog's result</li>\n<li>options: List of choices, or a pipe-separated string (e.g. 'Chrome|Firefox|Edge')</li>\n<li>label: Text shown next to the dropdown (defaults to name)</li>\n<li>default: Which option starts selected (defaults to the first option)</li>\n</ul>\n<p>Raises ExecutionFailed if called before Create Dialog, if name was already used, if options is empty, or if default isn't one of the options.</p>", "shortdoc": "Adds a dropdown (single choice) to the dialog being built with Create Dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 297}, {"name": "Add Label", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}], "returnType": null, "doc": "<p>Adds a plain text line to the dialog being built with Create Dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>text: Text to display</li>\n</ul>\n<p>Purely visual - not included in Show Dialog's result. Raises ExecutionFailed if called before Create Dialog.</p>", "shortdoc": "Adds a plain text line to the dialog being built with Create Dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 321}, {"name": "Add Radio Group", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "options", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "options: str | List[str]"}, {"name": "label", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label: str | None = None"}, {"name": "default", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: str | None = None"}], "returnType": null, "doc": "<p>Adds a group of mutually-exclusive radio buttons to the dialog being built with Create Dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>name: Key used for this field's selected value in Show Dialog's result</li>\n<li>options: List of choices, or a pipe-separated string (e.g. 'Pass|Fail|Blocked')</li>\n<li>label: Text shown above the group (defaults to name)</li>\n<li>default: Which option starts selected (defaults to the first option)</li>\n</ul>\n<p>Raises ExecutionFailed if called before Create Dialog, if name was already used, if options is empty, or if default isn't one of the options.</p>", "shortdoc": "Adds a group of mutually-exclusive radio buttons to the dialog being built with Create Dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 273}, {"name": "Add Text Box", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "label", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label: str | None = None"}, {"name": "default", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: str = "}, {"name": "mask", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mask: bool = False"}], "returnType": null, "doc": "<p>Adds a text input field to the dialog being built with Create Dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>name: Key used for this field's value in Show Dialog's result</li>\n<li>label: Text shown next to the field (defaults to name)</li>\n<li>default: Pre-filled value</li>\n<li>mask: If True, displays entered text as asterisks (for passwords/secrets)</li>\n</ul>\n<p>Raises ExecutionFailed if called before Create Dialog, or if name was already used.</p>", "shortdoc": "Adds a text input field to the dialog being built with Create Dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 242}, {"name": "Choose File", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = "}, {"name": "filetypes", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "tuple", "typedoc": "tuple", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filetypes: List[tuple] | None = None"}, {"name": "multiple", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "multiple: bool = False"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Opens file picker dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Instruction text</li>\n<li>filetypes: List of (description, pattern) tuples, e.g. [(\"Text files\", \"*.txt\")]</li>\n<li>multiple: Allow selecting multiple files</li>\n</ul>\n<p>Returns file path string, list of paths if multiple=True, or None if cancelled.</p>", "shortdoc": "Opens file picker dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 138}, {"name": "Choose Folder", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Opens folder picker dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Instruction text</li>\n</ul>\n<p>Returns folder path string or None if cancelled.</p>", "shortdoc": "Opens folder picker dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 151}, {"name": "Confirm With Checkbox", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}, {"name": "checkbox_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "I agree", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "checkbox_text: str = I agree"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Shows confirmation dialog with checkbox.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Prompt text</li>\n<li>checkbox_text: Label for checkbox</li>\n</ul>\n<p>Returns True if checkbox was checked, False otherwise.</p>", "shortdoc": "Shows confirmation dialog with checkbox.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 162}, {"name": "Count Down", "args": [{"name": "seconds", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "seconds: int | str"}], "returnType": null, "doc": "<p>Shows countdown timer dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>seconds: Duration in seconds</li>\n</ul>\n<p>Dialog closes automatically when timer reaches zero.</p>", "shortdoc": "Shows countdown timer dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 98}, {"name": "Create Dialog", "args": [{"name": "title", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Custom Dialog", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "title: str = Custom Dialog"}], "returnType": null, "doc": "<p>Starts building a custom dialog with your own combination of elements.</p>\n<p>Arguments:</p>\n<ul>\n<li>title: Window title for the dialog</li>\n</ul>\n<p>Add elements with Add Text Box / Add Checkbox / Add Radio Group / Add Dropdown / Add Label / Add Button, then call Show Dialog to display it and get the results.</p>\n<p>Raises ExecutionFailed if a dialog is already being built (Show Dialog wasn't called yet for a previous Create Dialog).</p>", "shortdoc": "Starts building a custom dialog with your own combination of elements.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 225}, {"name": "Get Confirmation", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Shows Yes/No/Cancel confirmation dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Question or prompt text</li>\n</ul>\n<p>Returns True for Yes, False for No, None for Cancel.</p>", "shortdoc": "Shows Yes/No/Cancel confirmation dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 109}, {"name": "Get Multi Value", "args": [{"name": "fields", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "fields: str | List[str]"}, {"name": "default", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: Dict[str, str] | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Prompts user for multiple input values in one dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>fields: List of field names or single field</li>\n<li>default: Dictionary of default values per field</li>\n</ul>\n<p>Returns dictionary with field names as keys and user inputs as values, or None if cancelled.</p>", "shortdoc": "Prompts user for multiple input values in one dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 120}, {"name": "Get Value From User Input", "args": [{"name": "prompt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Enter value:", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt: str = Enter value:"}, {"name": "default", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default: str = "}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Prompts user for text input via dialog.</p>\n<p>Arguments:</p>\n<ul>\n<li>prompt: Text displayed above input field</li>\n<li>default: Pre-filled value</li>\n</ul>\n<p>Returns string input or None if cancelled.</p>", "shortdoc": "Prompts user for text input via dialog.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 70}, {"name": "Pause Test Execution", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Test execution paused", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = Test execution paused"}, {"name": "command", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "command: str | None = None"}, {"name": "command_args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "command_args: List[str] | None = None"}], "returnType": null, "doc": "<p>Pauses test execution until user clicks Continue.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Text displayed in dialog</li>\n<li>command: Optional keyword name. When given, an extra \"Run\" button is shown next to Continue that runs it via Robot Framework's Run Keyword, so it must be a keyword already available in the running suite (user keyword, resource file, or imported library) - can be clicked any number of times while paused.</li>\n<li>command_args: Optional list of arguments passed to that keyword</li>\n</ul>\n<p>Test resumes when user clicks Continue button.</p>\n<p>Raises ExecutionFailed if the most recent \"Run\" click failed (e.g. the keyword doesn't exist or raised an error).</p>", "shortdoc": "Pauses test execution until user clicks Continue.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 202}, {"name": "Run Manual Steps", "args": [{"name": "steps", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*steps"}], "returnType": null, "doc": "<p>Displays manual test steps with Pass/Fail buttons.</p>\n<p>Arguments:</p>\n<ul>\n<li>steps: One step per argument (e.g. <span class=\"name\">open github    add username    add password</span>), or a single list/string variable (e.g. <span class=\"name\">${steps}</span>)</li>\n</ul>\n<p>Raises ExecutionFailed if user clicks Fail button.</p>", "shortdoc": "Displays manual test steps with Pass/Fail buttons.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 82}, {"name": "Select Options With Checkboxes", "args": [{"name": "message", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message: str"}, {"name": "options", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "options: str | List[str]"}, {"name": "defaults", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "defaults: List[str] | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": false}, "doc": "<p>Shows multiple checkboxes for selection.</p>\n<p>Arguments:</p>\n<ul>\n<li>message: Instruction text</li>\n<li>options: List of options or pipe-separated string</li>\n<li>defaults: List of pre-selected option names</li>\n</ul>\n<p>Returns dictionary with option names as keys and True/False as values.</p>", "shortdoc": "Shows multiple checkboxes for selection.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 174}, {"name": "Show Dialog", "args": [], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "doc": "<p>Displays the dialog built with Create Dialog/Add ... keywords and returns the results.</p>\n<p>Returns a dictionary with one entry per named field (from Add Text Box/Add Checkbox), plus 'button' set to the text of whichever closing button was clicked.</p>\n<p>Raises ExecutionFailed if no dialog is in progress, if no closing button (Add Button with closes_dialog=True, the default) was added, or if the button that closed the dialog had a command that failed.</p>", "shortdoc": "Displays the dialog built with Create Dialog/Add ... keywords and returns the results.", "tags": [], "source": "C:\\Users\\xlmn\\Documents\\testing\\DialogsPlus\\src\\DialogsPlus\\dialogsplus.py", "lineno": 360}], "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Show Dialog"], "accepts": ["Any"]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["Add Button", "Add Checkbox", "Add Text Box", "Choose File", "Confirm With Checkbox", "Get Confirmation", "Select Options With Checkboxes"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["Get Multi Value", "Select Options With Checkboxes", "Show Dialog"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["Count Down"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["Add Button", "Add Dropdown", "Add Radio Group", "Choose File", "Get Multi Value", "Pause Test Execution", "Select Options With Checkboxes"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__", "Add Button", "Add Checkbox", "Add Dropdown", "Add Radio Group", "Add Text Box", "Choose File", "Choose Folder", "Get Confirmation", "Get Multi Value", "Get Value From User Input", "Pause Test Execution", "Select Options With Checkboxes"], "accepts": ["string"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Add Button", "Add Checkbox", "Add Dropdown", "Add Label", "Add Radio Group", "Add Text Box", "Choose File", "Choose Folder", "Confirm With Checkbox", "Count Down", "Create Dialog", "Get Confirmation", "Get Multi Value", "Get Value From User Input", "Pause Test Execution", "Select Options With Checkboxes", "Show Dialog"], "accepts": ["Any"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["Choose File"], "accepts": ["string", "Sequence"]}]}
 </script>
     <link rel="icon" type="image/x-icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKcAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAqAAAAAAAAAAAAAAAAAAAALIAAAD/AAAA4AAAANwAAADcAAAA3AAAANwAAADcAAAA3AAAANwAAADcAAAA4AAAAP8AAACxAAAAAAAAAKYAAAD/AAAAuwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC/AAAA/wAAAKkAAAD6AAAAzAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN8AAAD/AAAA+gAAAMMAAAAAAAAAAgAAAGsAAABrAAAAawAAAGsAAABrAAAAawAAAGsAAABrAAAADAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAIsAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAANEAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAAAAAAAAMgAAADIAAAAyAAAAMgAAADIAAAAyAAAAMgAAADIAAAAFAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAADwAAAB8AAAAAAAAAGAAAABcAAAAAAAAAH8AAABKAAAAAAAAAAAAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAADCAAAA/wAAACkAAADqAAAA4QAAAAAAAAD7AAAA/wAAALAAAAAGAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAIwAAAP4AAAD/AAAA/wAAAGAAAAAAAAAAAAAAAMkAAAD/AAAAigAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAAAAAAAIAAAAcAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAEgAAAAAAAAAAAAAA2gAAAP8AAAD7AAAAywAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN4AAAD/AAAAqwAAAP8AAACvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALIAAAD/AAAAsgAAAAAAAAC5AAAA/wAAAMoAAADAAAAAwAAAAMAAAADAAAAAwAAAAMAAAADAAAAAwAAAAMkAAAD/AAAAvAAAAAAAAAAAAAAAAAAAAKwAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAArQAAAAAAAAAAwAMAAIABAAAf+AAAP/wAAD/8AAAgBAAAP/wAAD/8AAA//AAAJIwAADHEAAA//AAAP/wAAB/4AACAAQAAwAMAAA==">
   </head>

robotframework_dialogsplus-0.2.1/docs/HowTo.md

@@ -0,0 +1,150 @@
+# 📘 DialogsPlus Documentation
+
+DialogsPlus is an extended UI/dialog library for Robot Framework, designed to interactively collect user inputs, confirmations, file/folder selections, and control test execution flow with dialogs.
+
+This document describes the available keywords and provides usage examples.
+
+# 🔧 Configuration
+Before using the library, you can specify an optional YAML config:
+
+```bach
+*** Settings ***
+Library    DialogsPlus    #config=path/to/config.yaml
+```
+Optional config file allows customization of:
+
+- Theme colors
+
+- Font sizes
+
+- Window dimensions
+
+- Padding
+```yaml
+title: "Custom Dialog"
+width: 400
+height: 200
+theme: "green"
+appearance_mode: "light"
+button_fg_color: "#aaa"
+etc...
+```
+
+## 🧩 Keywords Overview
+
+🧾 `Get Value From User Input`
+Prompts the user for a single line of text input.
+
+```r
+${result}          Get Value From User Input    prompt=Enter your name:    default=Robot framework
+Should Be Equal    ${result}    Robot framework
+```
+
+📝 `Run Manual Steps`
+Displays manual test steps with Pass/Fail buttons.
+
+```r
+${steps}    Create List    
+...         01 Open the app    
+...         02 Click Start button    
+...         03 Verify status
+
+Run Manual Steps    ${steps}
+# Or One Test Step as normal text:
+Run Manual Steps    Open Google
+```
+⏳ `Count Down`
+Shows a countdown timer dialog that automatically closes.
+```r
+Count Down    5
+```
+❓ `Get Confirmation` Displays a Yes / No / Cancel dialog.
+```r
+${result}    Get Confirmation    Are you sure?
+Should Be True    ${result}
+```
+🧮 `Get Multi Value` Prompts for multiple input fields in a single dialog.
+```r
+*** Test Cases ***
+Get Value Test
+    ${result}    Get Multi Value    username
+    Should Be Equal    ${result}[username]    user1
+
+    # Or another approach, with more fields!
+
+*** Variables ***
+@{fields_val}     username    password    email    phone
+&{default_val}    username=admin    password=P@55    phone=1234567
+
+*** Test Cases ***
+Get Multi Value Multiple Fields
+    ${result}    Get Multi Value    ${fields_val}    default=${default_val}
+    Should Be Equal    ${result}[password]    P@55
+    Should Be Equal    ${result}[phone]       1234567
+```
+📄 `Choose File` Opens a native file picker dialog and Returns file **PATH** as a string.
+```r
+Choose Single XML File
+    ${XML_FILETYPES}    Evaluate    [("xml files", "*.xml")]    # [("Text files", "*.txt")]
+    ${result}=    Choose File    
+    ...           message=Select Single XML File    
+    ...           filetypes=${XML_FILETYPES}
+
+    # Or another approach, with many files path and return as a list[str]!
+
+Choose Multiple HTML Files
+    ${HTML_FILETYPES}    Evaluate    [("HTML", "*.html")]
+    ${result}=    Choose File    
+    ...           message=Select Multiple HTML Files    
+    ...           filetypes=${HTML_FILETYPES}   multiple=True
+    Should Contain    ${result}[0]    .html
+```
+📁 `Choose Folder` Opens a folder selection dialog.
+```r
+${dir}    Choose Folder    message=Select output directory
+Directory Should Exist    ${dir}
+```
+✅ `Confirm With Checkbox` Prompts the user to confirm an action with a checkbox.
+```r
+Select Single CheckBox
+    ${confirmed}    Confirm With Checkbox    
+        ...         message=Accept terms?    
+        ...         checkbox_text=I accept
+    Should Be True    ${confirmed}  
+
+    # Or with many checkboxes
+
+*** Variables ***
+@{fields_val}     username    password    email    phone
+
+*** Test Cases ***
+Select Many Checkbox Test
+    ${r}    Select Options With Checkboxes    
+    ...    message=Select as much as you want   
+    ...    options=${fields_val}
+
+    Should Not Be True    ${r}[username]
+    Should Not Be True    ${r}[password]
+    Should Not Be True    ${r}[email]
+    Should Not Be True    ${r}[phone]
+
+    # Another example with default checkboxes checked!
+
+Select Many Checkbox With Defaults Test
+    @{Contacts}    Create List        Email    SMS    Phone    Slack    Discord
+    @{Selected_Defaults}    Create List    Email    SMS
+    ${selected}=    Select Options With Checkboxes
+    ...    message=Choose your preferences
+    ...    options=${Contacts}
+    ...    defaults=@{Selected_Defaults}         # Default Selected!
+    
+    Should Be True        ${selected}[Email]
+    Should Be True        ${selected}[SMS]
+    Should Not Be True    ${selected}[Phone]
+    Should Not Be True    ${selected}[Slack]
+    Should Not Be True    ${selected}[Discord]
+```
+⏸️ `Pause Test Execution` Pauses the test run and waits for the user to click "Continue".
+```r
+Pause Test Execution    message=Manually verify system state
+```