Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend "extend" #146

Open
imakewebthings opened this issue Nov 21, 2013 · 0 comments
Open

Extend "extend" #146

imakewebthings opened this issue Nov 21, 2013 · 0 comments
Milestone

Comments

@imakewebthings
Copy link
Owner

Currently extend takes a method name string and a function. This should be expanded to take one argument, an object. This object would have the following properties:

  • name: Required. A string to identify this extension. Core would warn or error on extension name conflicts.
  • methods: Optional. A hash containing new methods. The equivalent of using the current extend. Core will warn or error on method conflicts.
  • options: Optional. A hash of options to add to the deck options object. Extension options will live in their own namespace, but if there are multiple extensions with the same option the user can use an "all" option during init to pass those options to all extensions. If a user wants to disable an included extension, they can pass "false" to the namespace of that extension on init.
  • events: Optional. A hash of callbacks for deck events.
  • keys: Optional. A hash where keys are the keyboard keys (using something like keymaster and values are an object that says what method to call and a brief description of what that method does. The hope is that this will resolve key conflicts between extensions that we cannot deal with using the current each-extension-deals-with-its-own-key-binding approach. It also allows for API expansion to get a list of all the available key shortcuts. And this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant