Ref Component Reference

Related documents

• Component Overview
• Component Reference
• Built-in Components
• Template Markup Language (TML) Reference

Table of Contents

• Introduction
• Attributes
• Instance methods
  • Inherited methods
• Children
• DOM element properties
• Styling

Introduction

Syntax

tml`<Ref ref=pageId.referenceId />`

The Ref component creates a link to content on another page.
The ref attribute is a string of the form pageId.referenceId.
The Ref component's children are the text of the link.
When the link is clicked, the page specified by pageId is opened as a popup page with the referenceId passed to the page's open() method.

Attributes

• Standard properties
  The Ref component accepts the standard attributes.
• ref (required)
  A reference to another page in the form of pageId.referenceId.
  The referenceId is interpreted by the page.
  For example, the Help page topic for the Settings page would be specified by help.set.

Instance methods

These methods are intended to be used by parent components to dynamically change the properties of the rendered components without re-rendering.

Inherited methods

• Component methods

Children

The Ref component's children form the link text.

DOM element properties

• The Ref component will render a <span>.
• The <span> will have a CSS class name with the string navRef.

Styling

• The Ref component's <span> will have a blue font color with an underline.