/ember-tether

Tether an element to another element in the DOM

Primary LanguageJavaScriptMIT LicenseMIT

Ember Tether Build Status Ember Observer Score

This ember-cli addon provides a component that allows for 'tethering' a block to a target somewhere else on the page. The target may be an element, an element selector, or an Ember view. Importantly, the component retains typical context for Ember action handling and data binding.

Live Demo

View a live demo here: http://yapplabs.github.io/ember-tether/

Example Usage

Given the following DOM:

<body class="ember-application">
  <!-- Target must be in the same element as your ember app -->
  <!-- otherwise events/bindings on the tethered content will not work -->
  <div id='a-nice-person'>
    Nice person
  </div>
  <div class="ember-view">
    <!-- rest of your Ember app's DOM... -->
  </div>
</body>

and a template like this:

{{#ember-tether
    target='#a-nice-person'
    targetAttachment='top right'
    attachment='top left'
}}
  A puppy
{{/ember-tether}}

Then "A puppy" would be rendered alongside the a-nice-person div.

If the ember-tether component is destroyed, its far-off content is destroyed too. For example, given:

{{#if isShowing}}
  {{#ember-tether
      target='#a-nice-person'
      targetAttachment='top right'
      attachment='top left'
  }}
    A puppy
  {{/ember-tether}}
{{/if}}

If isShowing starts off true and becomes false, then the "A puppy" text will be removed from the page.

Similarly, if you use ember-tether in a route's template, it will render its content next to the target element when the route is entered and remove it when the route is exited.

Using ember-tether in Your Own Addon

ember-tether depends on Hubspot Tether, which is imported as a bower dependency. When using ember-tether directly in an Ember app, everything will work out of the box with no configuration necessary.

However, addons nested in other addons do not have access to app.import in their included hook and are therefore unable to import their own dependencies. This is not a problem unique to ember-tether.

The bad news is that this makes it more difficult to use ember-tether in an addon you may be developing. The good news is that ember-tether provides an importBowerDependencies hook for just this purpose.

So... when using ember-tether nested within your addon, use the following code in the addon's included hook:

included: function(app){
  this._super.included.apply(this, app);
  var emberTetherAddon = this.addons.filter(function(addon) {
    return addon.name == 'ember-tether';
  })[0];
  emberTetherAddon.importBowerDependencies(app);
},

Development Setup

Installation

  • git clone this repository
  • npm install
  • bower install

Running Tests

  • ember try:testall
  • ember test
  • ember test --server

Running the dummy app

For more information on using ember-cli, visit http://www.ember-cli.com/.

Credits

  • Hubspot Tether, the underlying library that implement the actual tethering behavior
  • ember-wormhole, whose pattern for element content manipulation inspired the approach in ember-tether
  • Tetherball, for providing countless hours of entertainment over the past century