couchkeys 0.1.0

Customizable virtual keyboard designed for use with D-pads (like Android TV)

couchkeys

A customizable virtual keyboard package for Flutter applications, specifically designed for use with D-pad navigation on devices like smart TVs and set-top boxes.

Inspired by the YouTube app for Android TV.

Warning

This package is currently in an early development stage and is not considered stable. It may contain bugs, incomplete features, or undergo significant changes in future releases. Use it at your own risk in production environments.

Features

• Fully customizable keyboard layout
• Customizable key appearance and behavior
• Easy integration with Flutter TextFields

Getting started

Add this to your pubspec.yaml file:

dependencies:
  couchkeys: ^0.1.0

Then run:

flutter pub get

Usage

...
// Import the package
import 'package:couchkeys/couchkeys.dart';

...
class _MyHomePageState extends State<MyHomePage> {
    // Create a controller to use with both Couchkeys and TextField
    final controller = TextEditingController();

    @override
    Widget build(BuildContext context) {
        return Scaffold(
            ...
            body: Column(
                children: [
                    SizedBox(
                        width: 500,
                        // Create the Couchkeys widget
                        child: Couchkeys(
                            keyboardHeight: 200,
                            controller: controller,
                        )
                    ),
                    // Create TextField widget with a controller to display the value
                    TextField(controller: controller),
                ]
            )
        )
    }
}

Documentation

Detailed API documentation can be found on pub.dev.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or file an Issue on GitHub.

License

This project is MIT Licensed. See LICENSE file for details.