ctrl_alt_foo2 0.4.0

  • README.md
  • Installing
  • Versions
  • new45

Ctrl Alt Foo

Build Status

Make it easy to listen for keyboard shortcuts / accelator keys.

Usage

This is an early preview release and the syntax is not settled. Please add issues in the tracker if you have suggestions.

import 'package:ctrl_alt_foo2/keys.dart';

Keys.shortcuts({
  'Esc':          (){ _hideMenu(); _hideDialog(); },
  'Ctrl+N':       ()=> new NewProjectDialog(this).open(),
  'Ctrl+O, ⌘+O':  ()=> new OpenDialog(this).open(),
  'Ctrl+Shift+H': ()=> toggleCode()
});

There are also some helper methods for creating keyboard events:

import 'package:ctrl_alt_foo2/helpers.dart';

typeIn('TEXT'); // will generate a keyup

hitEnter();
hitEscape();

arrowUp(); // optionally supply the number of time to arrow up
arrowDown();

type('A'); // type a single character
typeCtrl('A'); // type Ctrl+A
typeCtrlShift('A'); // type Ctrl+Shift+A

LICENSE

This code is licensed under the MIT license. See LICENSE for more information.

Use this package as a library

1. Depend on it

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


dependencies:
  ctrl_alt_foo2: ^0.4.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:ctrl_alt_foo2/helpers.dart';
import 'package:ctrl_alt_foo2/key_event_x.dart';
import 'package:ctrl_alt_foo2/key_identifier.dart';
import 'package:ctrl_alt_foo2/keys.dart';
import 'package:ctrl_alt_foo2/shortcut.dart';
  
Version Uploaded Documentation Archive
0.4.0 Jul 5, 2018 Go to the documentation of ctrl_alt_foo2 0.4.0 Download ctrl_alt_foo2 0.4.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
14
Health:
Code health derived from static analysis. [more]
98
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
46
Overall:
Weighted score of the above. [more]
45
Learn more about scoring.

We analyzed this package on Jul 21, 2018, and provided a score, details, and suggestions below. Analysis was completed with status tool failures using:

  • Dart: 2.0.0-dev.69.0
  • pana: 0.11.7

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.0.0-dev.69.0.
 
 Because ctrl_alt_foo2 requires SDK version 2.0.0-dev.67.0, version solving failed.

Fix platform conflicts.

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.

Running dartdoc failed.

Make sure dartdoc runs without any issues.

Maintain CHANGELOG.md.

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

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.

Package is pre-v1 release.

While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction of the API.

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 ctrl_alt_foo2.dart.

Format lib/helpers.dart.

Run dartfmt to format lib/helpers.dart.

Format lib/key_event_x.dart.

Run dartfmt to format lib/key_event_x.dart.

Fix additional 3 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/key_identifier.dart (Run dartfmt to format lib/key_identifier.dart.)
  • lib/keys.dart (Run dartfmt to format lib/keys.dart.)
  • lib/shortcut.dart (Run dartfmt to format lib/shortcut.dart.)

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK 2.0.0-dev.67.0