HoopsLayout

class ui.layout.HoopsLayout()

Provides a slot-based page layout container for HOOPS web components.

Constructors

ui.layout.HoopsLayout.constructor()
HoopsLayout(): HoopsLayout

Returns: HoopsLayout

Properties

ui.layout.HoopsLayout.slotsShown
slotsShown: Record
ui.layout.HoopsLayout.floatingPanels

optional

floatingPanels: boolean

Methods

ui.layout.HoopsLayout.hideSlot()
hideSlot(name: HoopsLayoutSlotName): void

Hides the specified slot in the Hoops layout.

Parameters

name: HoopsLayoutSlotName

The name of the slot to hide.

Returns: void

ui.layout.HoopsLayout.isSlotVisible()
isSlotVisible(slotName: HoopsLayoutSlotName): boolean

Determines whether a specific slot is visible.

Parameters

slotName: HoopsLayoutSlotName

The name of the slot to check visibility for.

Returns: boolean

  • Returns true if the slot is visible, false otherwise.
ui.layout.HoopsLayout.setSlotVisibility()
setSlotVisibility(slotName: HoopsLayoutSlotName, shown: boolean): void

Mutates the visibility state of a slot.

Parameters

slotName: HoopsLayoutSlotName

The name of the slot to mutate.

shown: boolean

The visibility state to set for the slot.

Returns: void

ui.layout.HoopsLayout.showSlot()
showSlot(name: HoopsLayoutSlotName): void

Sets the visibility of a layout slot to be shown.

Parameters

name: HoopsLayoutSlotName

The name of the layout slot.

Returns: void

ui.layout.HoopsLayout.toggleSlotVisibility()
toggleSlotVisibility(name: HoopsLayoutSlotName): void

Toggles the visibility of a layout slot.

Parameters

name: HoopsLayoutSlotName

The name of the layout slot to toggle.

Returns: void