Skip to main content
Version: 2023.1

foundation-layout.foundationlayout.layoutrequiredregistrations

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

FoundationLayout.layoutRequiredRegistrations() method​

Gets all of the required registration function names for a set of config

Signature:

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

Parameters​

ParameterTypeDescription
layoutSerialisedLayoutany 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()