Skip to main content

foundation-layout.foundationlayout.layoutrequiredregistrations

Home > @genesislcap/foundation-layout > FoundationLayout > layoutRequiredRegistrations

FoundationLayout.layoutRequiredRegistrations() method

Gets all of the required element registry function names for a set of config

Signature:

static layoutRequiredRegistrations(layout: SerialisedLayout): string[];

Parameters

Parameter

Type

Description

layout

SerialisedLayout

any version of SerialisedLayout object describing the layout

Returns:

string[]

string[] - an item for each registered element in the config. These must all be added before function

Exceptions

  • various errors if the layout parameter cannot be parsed

Remarks

You can use this with registeredItems to work out what items you need to register with registerItem() before loading the layout with loadLayout()