# API Documentation - EzQt Widgets

## Overview

This directory contains the complete API documentation for all widgets in the EzQt library. The documentation is organized in a modular way to facilitate navigation and usage.

## Documentation Structure

### 📋 Main Documentation
- **[WIDGETS_DOCUMENTATION.md](WIDGETS_DOCUMENTATION.md)** - Complete documentation of all widgets
  - Overview of all modules
  - Detailed documentation of each widget
  - Parameters, properties, signals and examples
  - Usage guide and best practices

### 🎨 Style Guide
- **[STYLE_GUIDE.md](STYLE_GUIDE.md)** - Style guide and best practices
  - Code conventions and standards
  - Usage best practices
  - QSS styles customization with links to widget documentation
  - Accessibility principles

## Quick Navigation

### 🎛️ Widgets by Module

#### Buttons (`ezqt_widgets.button`)
- **DateButton** : Date picker button with integrated calendar
- **IconButton** : Button with icon support and optional text
- **LoaderButton** : Button with integrated loading animation

#### Inputs (`ezqt_widgets.input`)
- **AutoCompleteInput** : Text field with autocompletion
- **PasswordInput** : Password field with strength indicator
- **SearchInput** : Search field with history
- **TabReplaceTextEdit** : Text editor with tab replacement

#### Labels (`ezqt_widgets.label`)
- **ClickableTagLabel** : Clickable tag with toggle state
- **FramedLabel** : Framed label for advanced styling
- **HoverLabel** : Label with hover icon
- **IndicatorLabel** : Status indicator with colored LED

#### Misc (`ezqt_widgets.misc`)
- **CircularTimer** : Animated circular timer
- **DraggableList** : List with draggable elements
- **OptionSelector** : Option selector with animation
- **ToggleIcon** : Toggleable icon open/closed
- **ToggleSwitch** : Modern toggle switch with animation

## Usage

### 🔍 How to Navigate
1. **Start with** `WIDGETS_DOCUMENTATION.md` for a complete overview
2. **Use** the table of contents to access widgets directly
3. **Consult** `STYLE_GUIDE.md` for best practices and conventions

### 📚 Recommended Reading Order
- **Beginners** : Overview → Specific widget → Examples
- **Experienced users** : Specific widget → Integration → Custom styles
- **Developers** : Complete documentation → Advanced examples → Style guide

## Useful Links

### 📖 General Documentation
- **[../README.md](../README.md)** - Main documentation guide

### 🧪 Tests and Examples
- **[../tests/](../tests/)** - Test documentation
- **[../examples/](../examples/)** - Complete usage examples

### 🔗 External Resources
- **Source code** : `../../ezqt_widgets/` - Widget implementation
- **Tests** : `../../tests/` - Unit and integration tests

---

**EzQt Widgets API Documentation** - Complete and consolidated guide for using specialized widgets. 