Class LinkComponent
publicimport LinkComponent from '@ember/routing/link-component'; |
LinkComponent
renders an element whose click
event triggers a
transition of the application's instance of Router
to
a supplied route by name.
LinkComponent
components are invoked with {{#link-to}}. Properties
of this class can be overridden with reopen
to customize application-wide
behavior.
actions public
Inherited from Ember.ActionHandler packages/ember-runtime/lib/mixins/action_handler.js:22
The collection of functions, keyed by name, available on this
ActionHandler
as action targets.
These functions will be invoked when a matching {{action}}
is triggered
from within a template and the application's current route is this route.
Actions can also be invoked from other parts of your application
via ActionHandler#send
.
The actions
hash will inherit action handlers from
the actions
hash defined on extended parent classes
or mixins rather than just replace the entire hash, e.g.:
banner.js | |
1 2 3 4 5 6 7 8 9 |
import Mixin from '@ember/mixin'; export default Mixin.create({ actions: { displayBanner(msg) { // ... } } }); |
app/routes/welcome.js | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
import Route from '@ember/routing/route'; import CanDisplayBanner from '../mixins/can-display-banner'; export default Route.extend(CanDisplayBanner, { actions: { playMusic() { // ... } } }); // `WelcomeRoute`, when active, will be able to respond // to both actions, since the actions hash is merged rather // then replaced when extending mixins / parent classes. this.send('displayBanner'); this.send('playMusic'); |
Within a Controller, Route or Component's action handler,
the value of the this
context is the Controller, Route or
Component object:
app/routes/song.js | |
1 2 3 4 5 6 7 8 9 10 11 |
import Route from '@ember/routing/route'; export default Route.extend({ actions: { myAction() { this.controllerFor("song"); this.transitionTo("other.route"); ... } } }); |
It is also possible to call this._super(...arguments)
from within an
action handler if it overrides a handler defined on a parent
class or mixin:
Take for example the following routes:
route.js | |
1 2 3 4 5 6 7 8 9 |
import Mixin from '@ember/mixin'; export default Ember.Mixin.create({ actions: { debugRouteInformation() { console.debug("It's a-me, console.debug!"); } } }); |
debug.js | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
import Route from '@ember/routing/route'; import DebugRoute from '../mixins/debug-route'; export default Route.extend(DebugRoute, { actions: { debugRouteInformation() { // also call the debugRouteInformation of mixed in DebugRoute this._super(...arguments); // show additional annoyance window.alert(...); } } }); |
Bubbling
By default, an action will stop bubbling once a handler defined
on the actions
hash handles it. To continue bubbling the action,
you must return true
from the handler:
app/router.js | |
1 2 3 4 5 |
Router.map(function() { this.route("album", function() { this.route("song"); }); }); |
app/routes/album.js | |
1 2 3 4 5 6 7 8 |
import Route from '@ember/routing/route'; export default Route.extend({ actions: { startPlaying: function() { } } }); |
song.js | |
1 2 3 4 5 6 7 8 9 10 11 12 13 |
import Route from '@ember/routing/route'; export default Route.extend({ actions: { startPlaying() { // ... if (actionShouldAlsoBeTriggeredOnParentRoute) { return true; } } } }); |
activeClass public
Defined in packages/ember-glimmer/lib/components/link-to.js:404
The CSS class to apply to LinkComponent
's element when its active
property is true
.
ariaRole public
Inherited from Component packages/ember-glimmer/lib/component.js:681
The WAI-ARIA role of the control represented by this view. For example, a button may have a role of type 'button', or a pane may have a role of type 'alertdialog'. This property is used by assistive software to help visually challenged users navigate rich web applications.
The full list of valid WAI-ARIA roles is available at: http://www.w3.org/TR/wai-aria/roles#roles_categorization
attributeBindings public
Defined in packages/ember-glimmer/lib/components/link-to.js:449
By default the {{link-to}}
component will bind to the href
and
title
attributes. It's discouraged that you override these defaults,
however you can push onto the array if needed.
classNameBindings public
Defined in packages/ember-glimmer/lib/components/link-to.js:461
By default the {{link-to}}
component will bind to the active
, loading
,
and disabled
classes. It is discouraged to override these directly.
classNames public
Inherited from Ember.ClassNamesSupport packages/ember-views/lib/mixins/class_names_support.js:25
Standard CSS class names to apply to the view's outer element. This property automatically inherits any class names defined by the view's superclasses as well.
currentWhen public
Defined in packages/ember-glimmer/lib/components/link-to.js:359
Used to determine when this LinkComponent
is active.
element public
Inherited from Ember.ViewMixin packages/ember-views/lib/mixins/view_support.js:147
Returns the current DOM element for the view.
elementId public
Inherited from Component packages/ember-glimmer/lib/component.js:887
The HTML id
of the component's element in the DOM. You can provide this
value yourself but it must be unique (just as in HTML):
If not manually set a default value will be provided by the framework.
Once rendered an element's elementId
is considered immutable and you
should never change it. If you need to compute a dynamic value for the
elementId
, you should do this when the component or element is being
instantiated:
1 2 3 4 5 6 7 8 |
export default Component.extend({ init() { this._super(...arguments); var index = this.get('index'); this.set('elementId', `component-id${index}`); } }); |
isVisible public
Inherited from Component packages/ember-glimmer/lib/component.js:916
If false
, the view will appear hidden in DOM.
layout public
Inherited from Component packages/ember-glimmer/lib/component.js:858
Layout can be used to wrap content in a component.
positionalParams public
Inherited from Component packages/ember-glimmer/lib/component.js:696
Available since v1.13.0
Enables components to take a list of parameters as arguments.
For example, a component that takes two parameters with the names
name
and age
:
component.js | |
1 2 3 4 5 6 7 8 9 |
import Component from '@ember/component'; let MyComponent = Component.extend(); MyComponent.reopenClass({ positionalParams: ['name', 'age'] }); export default MyComponent; |
It can then be invoked like this:
The parameters can be referred to just like named parameters:
Using a string instead of an array allows for an arbitrary number of parameters:
component.js | |
1 2 3 4 5 6 7 8 9 |
import Component from '@ember/component'; let MyComponent = Component.extend(); MyComponent.reopenClass({ positionalParams: 'names' }); export default MyComponent; |
It can then be invoked like this:
The parameters can then be referred to by enumerating over the list:
rel public
Defined in packages/ember-glimmer/lib/components/link-to.js:376
Sets the rel
attribute of the LinkComponent
's HTML element.
replace public
Defined in packages/ember-glimmer/lib/components/link-to.js:438
Determines whether the LinkComponent
will trigger routing via
the replaceWith
routing strategy.
tabindex public
Defined in packages/ember-glimmer/lib/components/link-to.js:385
Sets the tabindex
attribute of the LinkComponent
's HTML element.
tagName public
Inherited from Ember.ViewMixin packages/ember-views/lib/mixins/view_support.js:373
Tag name for the view's outer element. The tag name is only used when an
element is first created. If you change the tagName
for an element, you
must destroy and recreate the view element.
By default, the render buffer will use a <div>
tag for views.
target public
Defined in packages/ember-glimmer/lib/components/link-to.js:394
Available since v1.8.0
Sets the target
attribute of the LinkComponent
's HTML element.
title public
Defined in packages/ember-glimmer/lib/components/link-to.js:367
Sets the title
attribute of the LinkComponent
's HTML element.