Skip to content

echobind/ember-links-with-follower

Repository files navigation

ember-links-with-follower

Greenkeeper badge

CircleCI npm version Code Climate Dependency Status Ember Observer Score

Features

Provides a component that renders a set of links with a follower line underneath. The follower will animate to the position of the active link, and grow or shrink in size if needed. If no active links are found, the follower will hide.

This pattern is commonly used for navigation:

twitter

(from Twitter app)

linkedin

(from LinkedIn app)

Animation of the follower is done through CSS transition and transform using translate3d. The transitions duration will be set to 0 on window resize to avoid issues with animating while resizing.

Since Links with Follower hooks in to the Router's willTransition event, you can use link-to or transitionTo and the follower will still update properly.

Installation

ember install ember-links-with-follower

Usage

Render links with default behavior (links passed in the block are expected to be li's):

{{#links-with-follower class="my-nav"}}
  {{#link-to 'Home' tagName='li'}}Home{{/link-to}}
  {{#link-to 'Stuff' tagName='li'}}Stuff{{/link-to}}
{{/links-with-follower}}

Render custom tags, change the active selector, and animate slowly:

{{#links-with-follower
  containerTagName="section"
  linkTagName="div"
  activeSelector="selected"
  followerAnimationDuration=1000}}

  {{#link-to "Home" tagName="div"}}Home{{/link-to}}
  {{#link-to "Stuff" tagName="div"}}Stuff{{/link-to}}

{{/links-with-follower}}

Customize the follower with css:

.my-nav .link-follower {
  border-color: tomato;
  border-size: 3px;
}

How does this work?

A listener is added to the router's willTransition event. On willTransition, we look for an active link in the links provided to the component via block format.

An active link is defined by the activeSelector property, which defaults to 'li.active:not(li.ember-transitioning-out), li.ember-transitioning-in'. This allows us to eagerly transition the follower before the route has fully transitioned.

Helpful Links

Legal

Echobind LLC (c) 2016 @echobind Licensed under the MIT license

About

Render a set of links with a "follower" line underneath. The follower moves to the active link, matching size and position on the page.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published