OverlayPage Component Reference

Related documents

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

Table of Contents

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

Introduction

Syntax

tml`
	<OverlayPage>
		...
	</OverlayPage>
`

Overlay pages are a type of popup page that may not completely cover other pages. Unobscured pages beneath the overlay page remain visible. The Nav page does not provide standard navigation elements for overlay pages. Instead, the page must provide a means for the user to dismiss it. The built-in dialog page is an example of an overlay page.

The OverlayPage component displays a Page component with an overlayPage CSS class. It is intended for use when the controller Page is presented as an overlay.

Attributes

The OverlayPage component accepts the same attributes as the Page component. The OverlayPage component adds overlayPage to the className.

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

All template children are included as the Page component children.

DOM element properties

• The OverlayPage Component will render a <Page> with the page children as its children.
• The <Page> will have a CSS class name with the string overlayPage.