keypress_listener 1.0.0

  • README.md
  • Installing
  • Versions
  • 53

keypress_listener

Helper to catch key combinations

Usage:

import 'package:key_listener/key_listener.dart';

class SomeElement extends HtmlElement {

  StreamSubscription<KeyboardEvent> _duplicateKeySub;

  //...

  @override
  void attached() {
    super.attached();
    
    _duplicateKeySub = KeyListener.listenKeyPressed(keys: 'ctrl+d cmd+d')
        .listen(keyListener_onDuplicateKey);
  }
  
  @override
  void detached() {
    _duplicateKeySub?.cancel();
    _duplicateKeySub = null;
    
    super.detached();
  }
  
  void keyListener_onDuplicateKey(KeyboardEvent e) {
    //skip events from text field (if you need)
    if (document.activeElement == document.body) {
      e.preventDefault();
      // TODO something
    }
  }
}

1. Depend on it

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


dependencies:
  keypress_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:keypress_listener/key_listener.dart';
        
Version Uploaded Documentation Archive
1.0.0 Oct 3, 2017 Go to the documentation of keypress_listener 1.0.0 Download keypress_listener 1.0.0 archive

Analysis

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

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

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

Platforms

Detected platforms: web

Platform components identified in package: html.

Suggestions

  • Maintain CHANGELOG.md.

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

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 error 3 hints.

    Strong-mode analysis of lib/src/KeyListener.dart failed with the following error:

    line: 106 col: 3
    Invalid override. The type of '_KeyCombo.==' ('(_KeyCombo) → bool') isn't a subtype of 'Object.==' ('(dynamic) → bool').

    Run dartfmt to format lib/key_listener.dart.

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • 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 keypress_listener.dart.