FSXABaseLayout.adoc

FSXABaseLayout

1. Introduction

2. Usage

3. Properties

4. Methods

Introduction

The FSXABaseLayout is there to have a basic component to be able to implement further layout components. It provides different attributes and methods, which should simplify the development significantly. These are described in this chapter. This component inherits all the attributes and methods of the FSXABaseComponent.

Usage

To use this base component a new class has to be created which extends the FSXABaseLayout.

@Component
class LayoutComponent extends FSXABaseLayout {}

If you want to have type support for you data attribute you can provide an interface and pass it as a generic like the Data interface in the example.

@Component
class LayoutComponent extends FSXABaseLayout<Data> {}

If you want additionally type support for your meta attribute, you can pass a second interface.

@Component
class LayoutComponent extends FSXABaseLayout<Data, Meta> {}

Note: If you only want type support for your meta attribute and not the data you have to pass an empty interface {} as the data generic.

Properties

data - Object

Returns all available data of the page.

meta - Object

Returns all available meta information of the page.

pageId - string

Returns the pageId of the displayed page.

Methods

renderContentByName

renderContentByName(name: string)

The prerendered sections are injected as slots into the component. You can access the slots directly through this.$scopedSlots.contentName or by calling this method and passing in the name of the content section.

renderContentByName(name: string, options?: { showAddSectionButtonInPreview?: boolean })

The optional option-property showAddSectionButtonInPreview renders an "Add Content" button at the bottom of a slot as a feature of TPP Snap. So it is only visible in the FirstSpirit ContentCreator.