Skip to content

Pantheon

The table that require(Packages.Pantheon) returns.

Properties

Name Description
Components The components. Each is a function (scope, props) -> Instance.
Game The in-game components: TopBar, Hotbar and Backpack. See Hotbar.
Theme Making and providing themes. See Theme.
Style Reusable defaults for components. See Style.
Persist Keeping component state across rebuilds. See Persist.
Layer The overlay layer of an interface. See Layer.
Flags Switches for library behaviour. See Flags.
Validators Validators for form fields. See Validators.
Accessibility Reading and applying accessibility settings. See the Accessibility guide.
GroupFade Fades an instance and everything under it. See GroupFade.
CanvasFade Helpers that fade panels with a CanvasGroup, or with GroupFade when the flag is off.
Shadow The elevation shadow component that other components use.
Color Colour helpers: luminance, lerp, onColor, toColor3 and others.
Material The Material colour swatches, such as Material.Blue[500].
Apply Apply(scope, instance)(props) applies properties to an instance that already exists.
Fusion, Iona The libraries, re-exported.
Version { major, minor, isRelease }.

Functions

Name Description
scoped: () -> Scope Makes a Fusion scope that has the Fusion methods and the instance methods of Iona. scope:Apply(instance) is available on it too, and scope:Hydrate is an alias for it.

Types

The module also exports the types Theme, ThemeMode, Scope, ButtonProps, TextFieldProps, ListItemProps, ButtonVariant, ColorInput, ThemeColorRole and ThemePalette.