Metadata-Version: 2.4
Name: CTkLoadingPopup
Version: 1.0.0
Summary: A modern loading popup widget for Python CustomTkinter
Author: limafresh
Maintainer: limafresh
License-Expression: CC0-1.0
Project-URL: Homepage, https://github.com/limafresh/CTkLoadingPopup
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: customtkinter
Dynamic: license-file

# CTkLoadingPopup

![Static Badge](https://img.shields.io/badge/Scaling-friendly-blue?style=for-the-badge)

A modern loading popup widget for Python CustomTkinter.

![screenshot](https://raw.githubusercontent.com/limafresh/CTkLoadingPopup/main/screenshot.png)

```python
import customtkinter
from CTkLoadingPopup import CTkLoadingPopup

app = customtkinter.CTk()
app.geometry("400x400")
CTkLoadingPopup(app)
app.mainloop()
```

## Usage

### Using pip

```
pip install git+https://github.com/limafresh/CTkLoadingPopup.git
```

### Without installation

Simply download the `CTkLoadingPopup` folder and place it in your script directory.

## Arguments

| **Parameter** | **Description** |
|-|-|
| **parent** | root or toplevel, required |
| text | popup text |
| progress | *float*, from 0.0 to 1.0 |
| start_angle | initial angle of the spinner |
| indeterminate_speed | speed of the spinning in the indeterminate mode |
| spinner_size | size of the spinner |
| spinner_width | width of the spinner outline |
| corner_radius | corner radius of popup |
| border_width | border width of popup |
| border_color | border color of popup |
| font | font of popup text |
| bg_color | popup background color |
| text_color | text color |
| spinner_color | spinner color |
| progress_color | spinner progress color |
| mode | `"indeterminate"` (by default) or `"determinate"` |
| padx | set horizontal padding |
| pady | set vertical padding |
| cancel_button | add a "Cancel" button that closes the popup |
| cancel_button_text | text of cancel button |
| cancel_button_text_color | text color of cancel button |
| cancel_button_hover_color | hover color of cancel button |
| cancel_button_state | cancel button state (see CTkButton documentation) |
| compound | `"left"` (by default), `"right"`, `"top"` |
| close_command | command that is executed before closing |

## Methods

- **.configure(*args)**: change some popup options
- **.close()**
- **.stop(value)**: `True` or `False`
- **.get()**: returns progress value (in determinate mode) or None (in indeterminate mode)
