Skip to content

PanelProps

PanelProps = { anchor?: undefined; children?: ReactNode; className?: string; maxDistance?: undefined; order?: number; slot: Slot; variant?: PanelVariant; } | { anchor: Anchor; children?: ReactNode; className?: string; maxDistance?: number; order?: undefined; slot?: undefined; variant?: PanelVariant; }

Defined in: packages/engine/src/components/Panel.tsx:75

{ anchor?: undefined; children?: ReactNode; className?: string; maxDistance?: undefined; order?: number; slot: Slot; variant?: PanelVariant; }

Name Type Description
anchor? undefined -
children? ReactNode -
className? string An override that shows in the diff.
maxDistance? undefined -
order? number Its place in the slot’s stack, lowest first. Panels with none keep the order they mounted in.
slot Slot Where it stands on the screen, such as Slot.TopRight or Slot.Bottom.
variant? PanelVariant Glass unless it says otherwise.

{ anchor: Anchor; children?: ReactNode; className?: string; maxDistance?: number; order?: undefined; slot?: undefined; variant?: PanelVariant; }

Name Type Description
anchor Anchor Where it stands against the entity it sits in.
children? ReactNode -
className? string An override that shows in the diff.
maxDistance? number Metres from the camera beyond which it hides. No limit unless set, as Roblox’s BillboardGui.MaxDistance has none.
order? undefined -
slot? undefined -
variant? PanelVariant Glass unless it says otherwise.