type_mate 1.0.0
type_mate: ^1.0.0 copied to clipboard
A Flutter plugin for system-wide writing assistance with overlay bubbles that provide spell checking, grammar fixing, and other writing tools.
Changelog #
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
1.0.0 - 2025-01-08 #
Added #
- Initial release of TypeMate plugin
- System-wide text input tracking using Android Accessibility Service
- Overlay bubble functionality with customizable appearance
- Permission management for overlay and accessibility services
- Real-time text field focus detection across all applications
- Writing assistance bubble with Check, Fix, and Close actions
- Foreground service for reliable background operation
- Stream-based event system for text field focus notifications
- Quick setup functionality for easy plugin initialization
- Comprehensive example app demonstrating all features
- Android support with API level 21+ compatibility
- Material Design 3 UI components in example app
- Event logging and statistics tracking
- Test overlay functionality for verification
- Proper notification system for foreground service
- Error handling and graceful degradation
Features #
- System-wide Detection: Monitors text input across all Android applications
- Overlay Bubbles: Floating assistance bubbles that appear when typing
- Permission Handling: Automatic permission request flows for overlay and accessibility
- Service Management: Start/stop overlay service with proper lifecycle management
- Event Streams: Real-time notifications for text field focus events
- Configuration: Customizable overlay appearance and behavior
- Statistics: Event counting and timing information
- Logging: Comprehensive event logging for debugging and monitoring
Platform Support #
- ✅ Android (API 21+)
- ❌ iOS (not supported due to platform limitations)
- ❌ Web (not applicable)
- ❌ Desktop (not supported)
Dependencies #
flutter
: SDK dependencyplugin_platform_interface
: ^2.1.7 for proper plugin architecture
Documentation #
- Comprehensive README with setup instructions
- API reference with all methods and properties
- Example app with interactive demonstrations
- Troubleshooting guide for common issues
- Android manifest configuration examples
Example App #
- Modern Material 3 design
- Real-time status monitoring
- Interactive permission management
- Event logging with timestamps
- Built-in testing capabilities
- Step-by-step usage instructions
- Statistics dashboard
Architecture #
- Plugin platform interface for extensibility
- Method channel communication with Android
- Accessibility service for system-wide monitoring
- Foreground service for overlay management
- Proper Android resource management
- Clean separation of concerns
Known Limitations #
- Android-only support (iOS restrictions prevent system-wide overlays)
- Requires manual permission grants for overlay and accessibility
- May impact battery life when running continuously
- Requires Android API level 21 or higher
[Unreleased] #
Planned Features #
- Enhanced writing assistance with spell check integration
- Grammar checking functionality
- Custom bubble themes and styling
- Writing suggestions and corrections
- Performance optimizations
- Additional accessibility features
- Extended configuration options
Version History #
- 1.0.0: Initial release with core functionality
- Future: Enhanced writing assistance features
Contributing #
Please read our contributing guidelines before submitting changes. All contributions should include:
- Updated changelog entry
- Appropriate tests
- Documentation updates
- Version bump if applicable
License #
This project is licensed under the MIT License - see the LICENSE file for details.