ember-cli-deeplink-component

An Ember.js component for jumping to in-page content.

Usage no npm install needed!

<script type="module">
  import emberCliDeeplinkComponent from 'https://cdn.skypack.dev/ember-cli-deeplink-component';
</script>

README

ember-cli-deeplink-component

Code Climate Ember Observer Score Shields.io

Table of Contents

About

ember-cli-deeplink-component provides a {{deep-link}} component in both inline and block form. The component allows for linking to in-page content in much the same way you could on a non single page application site using a plain anchor tag.

Installation

cd /path/to/my-awesome-application
ember install ember-cli-deeplink-component

Properties

duration {number}

  • Duration of scroll event in milliseconds
    • Superseded by the speed property

href (req.) {string}

  • The target anchor name or id of the target element

mutable {boolean}

  • Whether scroll events can be interrupted by user interaction

speed {number}

  • Speed in pixels per second for scroll events

text {string}

  • Text content of the component
    • Superseded by content yielded via block syntax

Examples

Target an anchor using the inline syntax

{{deep-link href="waldo" text="Where is waldo?"}}

{{! the target anchor}}
<a name="waldo"></a>

Target an element by id using the block syntax

{{#deep-link href="waldo"}}
  Where is waldo?
{{/deep-link}}

{{! the target element}}
<div id="waldo">
  Here he is.
</div>

Contributing / Modifying

Clone the project and do what you want with it. If you do something neat and are feeling generous submit a PR against the feature branch (GitHub).

cd /path/to/projects
git clone git@github.com:zakmac/ember-cli-deeplink-component.git
For more information on using **ember-cli**, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).
For more information on **Ember.js**, visit [http://www.emberjs.com/](http://www.emberjs.com/).
Looking for more great Ember addons? Check out [http://www.emberobserver.com/](http://www.emberobserver.com/).
Check out the Ember.js IRC channel at `#emberjs` on **Freenode IRC** or join the [Ember Community Slack organization](https://ember-community-slackin.herokuapp.com/).