# PCUI API

> The API reference of `@playcanvas/pcui` 6.1.4: the UI components of browser-based tools such as the PlayCanvas Editor, and the bindings that connect them to observer data.

Each link leads to a Markdown page with the symbol's properties and methods. React wrappers of the components are exported from `@playcanvas/pcui/react`. For guides, see the [PCUI index](https://developer.playcanvas.com/user-manual/pcui/llms.txt) of the User Manual.

## Classes

- [ArrayInput](https://api.playcanvas.com/pcui/classes/ArrayInput.md): Element that allows editing an array of values.
- [BindingBase](https://api.playcanvas.com/pcui/classes/BindingBase.md): Base class for data binding between IBindable Elements and Observers.
- [BindingElementToObservers](https://api.playcanvas.com/pcui/classes/BindingElementToObservers.md): Provides one way binding between an IBindable element and Observers.
- [BindingObserversToElement](https://api.playcanvas.com/pcui/classes/BindingObserversToElement.md): Provides one way binding between Observers and an IBindable element and Observers.
- [BindingTwoWay](https://api.playcanvas.com/pcui/classes/BindingTwoWay.md): Provides two way data binding between Observers and IBindable elements.
- [BooleanInput](https://api.playcanvas.com/pcui/classes/BooleanInput.md): A checkbox element.
- [Button](https://api.playcanvas.com/pcui/classes/Button.md): User input with click interaction.
- [Canvas](https://api.playcanvas.com/pcui/classes/Canvas.md): Represents a Canvas.
- [Code](https://api.playcanvas.com/pcui/classes/Code.md): Represents a code block.
- [ColorPicker](https://api.playcanvas.com/pcui/classes/ColorPicker.md): Represents a color picker.
- [Container](https://api.playcanvas.com/pcui/classes/Container.md): A container is the basic building block for Elements that are grouped together.
- [Divider](https://api.playcanvas.com/pcui/classes/Divider.md): Represents a vertical division between two elements.
- [Element](https://api.playcanvas.com/pcui/classes/Element.md): The base class for all UI elements.
- [GradientPicker](https://api.playcanvas.com/pcui/classes/GradientPicker.md): Represents a gradient picker.
- [GridView](https://api.playcanvas.com/pcui/classes/GridView.md): Represents a container that shows a flexible wrappable list of items that looks like a grid.
- [GridViewItem](https://api.playcanvas.com/pcui/classes/GridViewItem.md): Represents a grid view item used in GridView.
- [InfoBox](https://api.playcanvas.com/pcui/classes/InfoBox.md): Represents an information box.
- [InputElement](https://api.playcanvas.com/pcui/classes/InputElement.md): The InputElement is an abstract class that manages an input DOM element.
- [Label](https://api.playcanvas.com/pcui/classes/Label.md): The Label is a simple span element that displays some text.
- [LabelGroup](https://api.playcanvas.com/pcui/classes/LabelGroup.md): Represents a group of an Element and a Label.
- [Menu](https://api.playcanvas.com/pcui/classes/Menu.md): A Menu is a list of MenuItems which can contain child MenuItems.
- [MenuItem](https://api.playcanvas.com/pcui/classes/MenuItem.md): The MenuItem is a selectable option that is appended to a Menu.
- [NumericInput](https://api.playcanvas.com/pcui/classes/NumericInput.md): The NumericInput represents an input element that holds numbers.
- [Overlay](https://api.playcanvas.com/pcui/classes/Overlay.md): An overlay element.
- [Panel](https://api.playcanvas.com/pcui/classes/Panel.md): The Panel is a Container that itself contains a header container and a content container.
- [Progress](https://api.playcanvas.com/pcui/classes/Progress.md): Represents a bar that can highlight progress of an activity.
- [RadioButton](https://api.playcanvas.com/pcui/classes/RadioButton.md): A radio button element.
- [SelectInput](https://api.playcanvas.com/pcui/classes/SelectInput.md): An input that allows selecting from a dropdown or entering tags.
- [SliderInput](https://api.playcanvas.com/pcui/classes/SliderInput.md): The SliderInput shows a NumericInput and a slider widget next to it.
- [Spinner](https://api.playcanvas.com/pcui/classes/Spinner.md): Represents a spinning icon.
- [TextAreaInput](https://api.playcanvas.com/pcui/classes/TextAreaInput.md): The TextAreaInput wraps a textarea element.
- [TextInput](https://api.playcanvas.com/pcui/classes/TextInput.md): The TextInput is an input element of type text.
- [TreeView](https://api.playcanvas.com/pcui/classes/TreeView.md): A container that can show a TreeView like a hierarchy.
- [TreeViewItem](https://api.playcanvas.com/pcui/classes/TreeViewItem.md): A TreeViewItem is a single node in a hierarchical TreeView control.
- [VectorInput](https://api.playcanvas.com/pcui/classes/VectorInput.md): A vector input.

## Interfaces

- [ArrayInputArgs](https://api.playcanvas.com/pcui/interfaces/ArrayInputArgs.md): The arguments for the ArrayInput constructor.
- [BindingBaseArgs](https://api.playcanvas.com/pcui/interfaces/BindingBaseArgs.md): The interface for arguments for the BindingBase constructor.
- [BindingObserversToElementArgs](https://api.playcanvas.com/pcui/interfaces/BindingObserversToElementArgs.md): The interface for arguments for the BindingObserversToElement constructor.
- [BindingTwoWayArgs](https://api.playcanvas.com/pcui/interfaces/BindingTwoWayArgs.md): The interface for arguments for the BindingTwoWay constructor.
- [BooleanInputArgs](https://api.playcanvas.com/pcui/interfaces/BooleanInputArgs.md): The arguments for the BooleanInput constructor.
- [ButtonArgs](https://api.playcanvas.com/pcui/interfaces/ButtonArgs.md): The arguments for the Button constructor.
- [CanvasArgs](https://api.playcanvas.com/pcui/interfaces/CanvasArgs.md): The arguments for the Canvas constructor.
- [CodeArgs](https://api.playcanvas.com/pcui/interfaces/CodeArgs.md): The arguments for the Code constructor.
- [ColorPickerArgs](https://api.playcanvas.com/pcui/interfaces/ColorPickerArgs.md): The arguments for the ColorPicker constructor.
- [ContainerArgs](https://api.playcanvas.com/pcui/interfaces/ContainerArgs.md): The arguments for the Container constructor.
- [GradientPickerArgs](https://api.playcanvas.com/pcui/interfaces/GradientPickerArgs.md): The arguments for the GradientPicker constructor.
- [GridViewArgs](https://api.playcanvas.com/pcui/interfaces/GridViewArgs.md): The arguments for the GridView constructor.
- [GridViewItemArgs](https://api.playcanvas.com/pcui/interfaces/GridViewItemArgs.md): The arguments for the GridViewItem constructor.
- [IBindable](https://api.playcanvas.com/pcui/interfaces/IBindable.md): The interface for bindable elements.
- [IBindableArgs](https://api.playcanvas.com/pcui/interfaces/IBindableArgs.md): The interface for arguments for bindable elements.
- [IFlexArgs](https://api.playcanvas.com/pcui/interfaces/IFlexArgs.md): The interface for flex-related CSS properties available on elements.
- [IFocusable](https://api.playcanvas.com/pcui/interfaces/IFocusable.md): The interface for elements that can be focused.
- [InfoBoxArgs](https://api.playcanvas.com/pcui/interfaces/InfoBoxArgs.md): The arguments for the InfoBox constructor.
- [InputElementArgs](https://api.playcanvas.com/pcui/interfaces/InputElementArgs.md): The arguments for the InputElement constructor.
- [IParentArgs](https://api.playcanvas.com/pcui/interfaces/IParentArgs.md): The interface for arguments for elements that have children.
- [IPlaceholder](https://api.playcanvas.com/pcui/interfaces/IPlaceholder.md): The interface for elements that have placeholder text.
- [IPlaceholderArgs](https://api.playcanvas.com/pcui/interfaces/IPlaceholderArgs.md): The interface for arguments for elements that have placeholder text.
- [LabelArgs](https://api.playcanvas.com/pcui/interfaces/LabelArgs.md): The arguments for the Label constructor.
- [LabelGroupArgs](https://api.playcanvas.com/pcui/interfaces/LabelGroupArgs.md): The arguments for the LabelGroup constructor.
- [MenuArgs](https://api.playcanvas.com/pcui/interfaces/MenuArgs.md): The arguments for the Menu constructor.
- [MenuItemArgs](https://api.playcanvas.com/pcui/interfaces/MenuItemArgs.md): The arguments for the MenuItem constructor.
- [NumericInputArgs](https://api.playcanvas.com/pcui/interfaces/NumericInputArgs.md): The arguments for the NumericInput constructor.
- [OverlayArgs](https://api.playcanvas.com/pcui/interfaces/OverlayArgs.md): The arguments for the Overlay constructor.
- [PanelArgs](https://api.playcanvas.com/pcui/interfaces/PanelArgs.md): The arguments for the Panel constructor.
- [ProgressArgs](https://api.playcanvas.com/pcui/interfaces/ProgressArgs.md): The arguments for the Progress constructor.
- [RadioButtonArgs](https://api.playcanvas.com/pcui/interfaces/RadioButtonArgs.md): The arguments for the RadioButton constructor.
- [ReparentedItem](https://api.playcanvas.com/pcui/interfaces/ReparentedItem.md): Represents an item that has been reparented in a TreeView drag operation.
- [SelectInputArgs](https://api.playcanvas.com/pcui/interfaces/SelectInputArgs.md): The arguments for the SelectInput constructor.
- [SliderInputArgs](https://api.playcanvas.com/pcui/interfaces/SliderInputArgs.md): The arguments for the SliderInput constructor.
- [SpinnerArgs](https://api.playcanvas.com/pcui/interfaces/SpinnerArgs.md): The arguments for the Spinner constructor.
- [TextAreaInputArgs](https://api.playcanvas.com/pcui/interfaces/TextAreaInputArgs.md): The arguments for the TextAreaInput constructor.
- [TextInputArgs](https://api.playcanvas.com/pcui/interfaces/TextInputArgs.md): The arguments for the TextInput constructor.
- [TreeViewArgs](https://api.playcanvas.com/pcui/interfaces/TreeViewArgs.md): The arguments for the TreeView constructor.
- [TreeViewItemArgs](https://api.playcanvas.com/pcui/interfaces/TreeViewItemArgs.md): The arguments for the TreeViewItem constructor.
- [VectorInputArgs](https://api.playcanvas.com/pcui/interfaces/VectorInputArgs.md): The arguments for the VectorInput constructor.

## Variables

- [revision](https://api.playcanvas.com/pcui/variables/revision.md): The git revision of the PCUI library.
- [version](https://api.playcanvas.com/pcui/variables/version.md): The version of the PCUI library.

## Optional

- [All pages in one file](https://api.playcanvas.com/pcui/llms-full.txt): 77 pages (248 KB), for downloading and searching rather than reading into context.