Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetLayoutOptions

Hierarchy

Index

Properties

appSize

appSize: AppSize

The current app size which is used to determine which layout type to return.

Optional defaultToggleableVisible

defaultToggleableVisible: boolean | "toggleable" | "toggleable-mini"

This prop is used to be able to update the toggleable layouts to start visible/expanded instead of requiring the toggle button to be pressed.

If this is:

  • "toggleable" - the "toggleable-mini" variant will still require a button click to be visible
  • "toggleable-mini" - the "toggleable" variant will still require a button click to be visible
  • true - both toggleable variants will start visible
  • false | undefined - both toggleable variants will require a button click to be visible
remarks

@since 2.6.0

Optional desktopLayout

desktopLayout: SupportedWideLayout

The type of layout to use when your app is viewed on a desktop sized screen.

Optional landscapeTabletLayout

landscapeTabletLayout: SupportedWideLayout

The type of layout to use when your app is viewed on a landscape tablet sized screen.

Optional largeDesktopLayout

largeDesktopLayout: SupportedWideLayout

The type of layout to use when your app is viewed on a large desktop sized screen.

Note: Unlike all the other layout types, this one will automatically inherit the desktopLayout if it is omitted.

Optional phoneLayout

The type of layout to use when your app is viewed on a phone sized screen.

Optional tabletLayout

tabletLayout: SupportedTabletLayout

The type of layout to use when your app is viewed on a portrait tabled sized screen.

Generated using TypeDoc