key_listener 1.0.0

  • README.md
  • Installing
  • Versions
  • 31

Build Status Key Listener

A library for transforming a stream of character code units into Key presses.

Quickstart

You can bind an input stream such as stdin to start listening for key presses.

new KeyListener(stdin).onKey(Key.A).listen((String keyName) {
    print('key $keyName was pressed');
});

Groups of keys can be monitored on a single stream.

new KeyListener(stdin).onKeySet([Key.A, Key.B]).listen((String keyName) {
    print('key $keyName was pressed');
});

// Or use one of the common key sets.
new KeyListener(stdin).onKeySet(KeySet.alphanumeric).listen((String keyName) {
    print('key $keyName was pressed');
});

If a key is missing from this library, its character codes will be emitted on KeyListener.onUnknownKey whenever the key is pressed.

Call KeyListener.deactivate when finished to close the input stream subscription.

Use this package as a library

1. Depend on it

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


dependencies:
  key_listener: "^1.0.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


      import 'package:key_listener/key_listener.dart';
  
Version Uploaded Documentation Archive
1.0.0 Oct 30, 2016 Go to the documentation of key_listener 1.0.0 Download key_listener 1.0.0 archive

Analysis

We analyzed this package on Jun 22, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
89 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
20 / 100
Overall score:
Weighted score of the above. [more]
31
Learn more about scoring.

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Error(s) in lib/key_listener.dart: Target of URI doesn't exist: 'package:collection/collection.dart'.

Suggestions

  • Fix platform conflicts.

    Error(s) prevent platform classification:

    Error(s) in lib/key_listener.dart: Target of URI doesn't exist: 'package:collection/collection.dart'.

  • Running dartdoc failed.

    Make sure dartdoc runs without any issues.

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 3 errors.

    Make sure that the imported libraries are not in conflict. Error(s) in lib/key_listener.dart: Target of URI doesn't exist: 'package:collection/collection.dart'.

  • Package is getting outdated.

    The package was released 85 weeks ago.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use key_listener.dart.

Dependencies

Package Constraint Resolved Available
Dev dependencies
dart_style
mockito
test