mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-24 06:34:09 +00:00
57 lines
1.9 KiB
YAML
57 lines
1.9 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: Frame
|
|
type: class
|
|
memory_category: Gui
|
|
summary: |
|
|
A `Class.GuiObject` that renders as a plain rectangle, generally used as a
|
|
container.
|
|
description: |
|
|
`Class.Frame` is a `Class.GuiObject` that acts as a container for other
|
|
`Class.GuiObject|GuiObjects`. You can use it for UI that either displays on a
|
|
user's [screen](../../../ui/on-screen-containers.md) or on a
|
|
[surface](../../../ui/in-experience-containers.md) within the experience.
|
|
|
|
<img src="/assets/ui/ui-objects/Frame-Example.jpg" width="840" />
|
|
|
|
`Class.Frame|Frames` are ideal containers for responsive layouts such as
|
|
[list and flex layouts](../../../ui/list-flex-layouts.md), allowing you to
|
|
change the size of the frame and dynamically adjust how layout items fit
|
|
within it. `Class.Frame|Frames` are also core `Class.GuiObject|GuiObjects`, so
|
|
you can customize properties such as
|
|
`Class.GuiObject.BackgroundColor3|BackgroundColor3`,
|
|
`Class.GuiObject.Transparency|Transparency`, apply a
|
|
[background gradient](../../../ui/appearance-modifiers.md#gradient) or
|
|
[border](../../../ui/appearance-modifiers.md#stroke), and more.
|
|
code_samples: []
|
|
inherits:
|
|
- GuiObject
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: Frame.Style
|
|
summary: |
|
|
Sets what the frame looks like from a selection of pre-determined styles.
|
|
description: |
|
|
Sets what the frame looks like from a selection of pre-determined styles.
|
|
See `Enum.FrameStyle` for a description of each style.
|
|
code_samples: []
|
|
type: FrameStyle
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- UI
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|