Module: alfresco/navigation/Link

alfresco/navigation/Link

The purpose of the Link widget is to provide a re-usable accessible link that is compatible with the publication/subscription model used by the Alfresco widgets. It is important that a "title" attribute is set that provides context to the link (e.g. "Delete 'Document 1'" rather than just "Delete", etc.)
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/Link.css"}]
Source:

label :string

This is the label that will appear as the link.
Type:
  • string
Source:

publishPayload :object

This is the object that will be published on the publish topic when the link is clicked.
Type:
  • object
Default Value:
  • null
Source:

publishTopic :string

This is the topic that will be published on when the link is clicked (either by mouse or keyboard).
Type:
  • string
Source:

templateString :string

The HTML template to use for the widget.
Type:
  • string
Source:

title :string

This will appear as the hover title for the link. It is especially important for accessibility that this is given a meaningful value, e.g. some kind of context as to the purpose of the link.
Type:
  • string
Source:

Methods

onClick(evt)

This is called whenever the user actions the link either with the mouse or with the keyboard. It publishes the publish payload on the publish topic
Parameters:
Name Type Description
evt object The click event
Source:

postMixInProperties()

Ensures that labels and titles are set and issues warnings if any data is not set as expected.
Source: