Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tzellman/ember-events-modifier
https://github.com/tzellman/ember-events-modifier
ember ember-addon hacktoberfest
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/tzellman/ember-events-modifier
- Owner: tzellman
- License: mit
- Created: 2021-04-22T14:26:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T11:13:54.000Z (28 days ago)
- Last Synced: 2024-10-09T12:46:50.560Z (28 days ago)
- Topics: ember, ember-addon, hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 2.75 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-events-modifier
[![NPM][npm-badge-img]][npm-badge-link]
[![Build Status][build-status-img]][build-status-link]
[![Ember Observer Score][ember-observer-badge]][ember-observer-url]
[![Ember Version][ember-version]][ember-version-url]
[![Download count][npm-downloads-img]][npm-badge-link]
[![Code Climate][climate-badge]][climate-badge-url]
[![Test Coverage][coverage-badge]][coverage-badge-url]
## Installation
```
ember install ember-events-modifier
```
## Demo
[Demo](https://tzellman.github.io/ember-events-modifier/)
## Usage
The addon provides an `events` service which can be used to facilitate events throughout your application. You can use
the service directly, without using the `modifiers`, described below.
```javascript
import Controller from "@ember/controller";
import { action } from "@ember/object";
import { inject as service } from "@ember/service";
export default class MyController extends Controller {
@service events;
@action clickedBook(book) {
this.events.trigger(`book:active:${book.id}`, book);
}
}
```
### on-event
The `on-event` modifier allows you to register a handler for specific events.
Your action handler will be passed arguments that are provided when the action is triggered.
Note that the handler is automatically registered and removed on insertion/removal, respectively.
```handlebars
...
```
You can also handle multiple events with one declaration:
```handlebars
...
```
### trigger-event
The `trigger-event` modifier allows you to trigger an event when the element is inserted.
```handlebars
{{#if this.showDetails}}
...
{{/if}}
```
## Compatibility
- Ember.js v3.28 or above
- Ember CLI v3.28 or above
- Node.js v14 or above
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## License
This project is licensed under the [MIT License](LICENSE.md).
[npm-badge-img]: https://badge.fury.io/js/ember-events-modifier.svg
[npm-badge-link]: http://badge.fury.io/js/ember-events-modifier
[build-status-img]: https://github.com/tzellman/ember-events-modifier/workflows/Build/badge.svg?branch=master&event=push
[build-status-link]: https://github.com/tzellman/ember-events-modifier/actions?query=workflow%3A%22Build%22
[npm-downloads-img]: https://img.shields.io/npm/dt/ember-events-modifier.svg
[ember-observer-badge]: http://emberobserver.com/badges/ember-events-modifier.svg
[ember-observer-url]: http://emberobserver.com/addons/ember-events-modifier
[ember-version]: https://img.shields.io/badge/Ember-3.12%2B-brightgreen.svg
[ember-version-url]: https://blog.emberjs.com/2019/08/16/ember-3-12-released.html
[coverage-badge]: https://codeclimate.com/github/tzellman/ember-events-modifier/badges/coverage.svg
[coverage-badge-url]: https://codeclimate.com/github/tzellman/ember-events-modifier/test_coverage
[climate-badge]: https://codeclimate.com/github/tzellman/ember-events-modifier/badges/gpa.svg
[climate-badge-url]: https://codeclimate.com/github/tzellman/ember-events-modifier