Button 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

Introduction

Syntax

tml`<Button text="Button text"/>`
tml`<Button>Button text</>`

The Button component creates a <button> with text. The if the text attribute is present it contains the string to be displayed. Otherwise the children are used for the button text.

The btnId attribute contains an ID string that's used to record user button presses. The event is recorded using ID button-${btnId}.

Attributes

• Standard properties
  The Button component accepts the standard attributes.
• Standard <button> properties
  The Button component accepts the standard <button> attributes.
• text (optional)
  A String to be displayed inside the button.
• btnId (optional)
  A String used to identify the button to record button presses.

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

If a text attribute is present all children are ignored. If a text attribute is not present, then the children are used as the button text.

DOM element properties

• The Button Component will render a <button>.
• The DOM node's data-btnId property will be set to the value of the btnId attribut, if present.