keyboard 0.0.4

  • Readme
  • Changelog
  • Example
  • Installing
  • 65

Flutter Keyboard Plugin #

A Flutter plugin to detect keyboard events on Android. Useful for non-touchscreen devices.

Sponsor

pub package

Example #

The example app can show detected events in a ListView.

It's present in the usual example directory.

$ git clone https://github.com/devxpy/flutter-keyboard-plugin.git
$ cd flutter-keyboard-plugin/example
$ flutter run

Installation #

Since flutter plugins don't have access to the regular Activity events, you also, need to make a small change to the android/app/src/main/kotlin/.../MainActivity.kt file in your project.

Just replace FlutterActivity() by KeyboardPluginActivity().

Here's what it should look like:-

import android.os.Bundle
import com.pycampers.keyboard.KeyboardPluginActivity
import io.flutter.plugins.GeneratedPluginRegistrant

class MainActivity : KeyboardPluginActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        GeneratedPluginRegistrant.registerWith(this)
    }
}

Then just follow the regular plugin installation on dart pub.

0.0.1 #

  • TODO: Describe initial release.

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:keyboard/keyboard.dart';
import 'package:flutter/scheduler.dart';

void main() {
  Keyboard.init();
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final events = <String>["(Start pressing keys to see events)"],
      controller = ScrollController();

  @override
  void initState() {
    super.initState();
    Keyboard.onKeyDown = (code, event) {
      if (!mounted) return;
      setState(() {
        events.add("OnKeyDown: $code\n$event");
      });
      SchedulerBinding.instance.addPostFrameCallback((_) {
        controller.jumpTo(controller.position.maxScrollExtent);
      });
    };
  }

  @override
  void dispose() {
    Keyboard.onKeyDown = null;
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Keyboard Plugin'),
        ),
        body: ListView(
          shrinkWrap: true,
          controller: controller,
          children: events.map((it) {
            return ListTile(
              title: Card(
                child: Text(
                  it,
                  textAlign: TextAlign.center,
                ),
              ),
            );
          }).toList(),
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  keyboard: ^0.0.4

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:keyboard/keyboard.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
57
Health:
Code health derived from static analysis. [more]
75
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
71
Overall:
Weighted score of the above. [more]
65
Learn more about scoring.

We analyzed this package on Mar 31, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health suggestions

Fix lib/keyboard.dart. (-25 points)

Analysis of lib/keyboard.dart reported 281 hints, including:

line 13 col 3: Prefer using /// for doc comments.

line 19 col 3: Prefer using /// for doc comments.

line 23 col 3: Prefer using /// for doc comments.

line 26 col 3: Prefer using /// for doc comments.

line 29 col 3: Prefer using /// for doc comments.

Maintenance suggestions

The package description is too short. (-19 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test