# Component Reference > Notice: This documentation might be out of date, so always check the source > code to see the most up-to-date information. - [General Concepts](#general-concepts) - [`tgui/components`](#tguicomponents) - [`AnimatedNumber`](#animatednumber) - [`BlockQuote`](#blockquote) - [`Box`](#box) - [`Button`](#button) - [`Button.Checkbox`](#buttoncheckbox) - [`Button.Confirm`](#buttonconfirm) - [`Button.Input`](#buttoninput) - [`ByondUi`](#byondui) - [`Collapsible`](#collapsible) - [`ColorBox`](#colorbox) - [`Dimmer`](#dimmer) - [`Divider`](#divider) - [`Dropdown`](#dropdown) - [`Flex`](#flex) - [`Flex.Item`](#flexitem) - [`Grid`](#grid) - [`Grid.Column`](#gridcolumn) - [`Icon`](#icon) - [`Icon.Stack`](#iconstack) - [`Input`](#input) - [`Knob`](#knob) - [`LabeledControls`](#labeledcontrols) - [`LabeledControls.Item`](#labeledcontrolsitem) - [`LabeledList`](#labeledlist) - [`LabeledList.Item`](#labeledlistitem) - [`LabeledList.Divider`](#labeledlistdivider) - [`Modal`](#modal) - [`NoticeBox`](#noticebox) - [`NumberInput`](#numberinput) - [`ProgressBar`](#progressbar) - [`RoundGauge`](#roundgauge) - [`Section`](#section) - [`Slider`](#slider) - [`Stack`](#stack) - [`Table`](#table) - [`Table.Row`](#tablerow) - [`Table.Cell`](#tablecell) - [`Tabs`](#tabs) - [`Tabs.Tab`](#tabstab) - [`Tooltip`](#tooltip) - [`tgui/layouts`](#tguilayouts) - [`Window`](#window) - [`Window.Content`](#windowcontent) ## General Concepts These are the components which you can use for interface construction. If you have trouble finding the exact prop you need on a component, please note, that most of these components inherit from other basic components, such as [Box](#box). This component in particular provides a lot of styling options for all components, e.g. `color` and `opacity`, thus it is used a lot in this framework. **Event handlers.** Event handlers are callbacks that you can attack to various element to listen for browser events. Inferno supports camelcase (`onClick`) and lowercase (`onclick`) event names. - Camel case names are what's called *synthetic* events, and are the **preferred way** of handling events in React, for efficiency and performance reasons. Please read [Inferno Event Handling](https://infernojs.org/docs/guides/event-handling) to understand what this is about. - Lower case names are native browser events and should be used sparingly, for example when you need an explicit IE8 support. **DO NOT** use lowercase event handlers unless you really know what you are doing. - [Button](#button) component does not support the lowercase `onclick` event. Use the camel case `onClick` instead. ## `tgui/components` ### `AnimatedNumber` This component provides animations for numeric values. **Props:** - `value: number` - Value to animate. - `initial: number` - Initial value to use in animation when element first appears. If you set initial to `0` for example, number will always animate starting from `0`, and if omitted, it will not play an initial animation. - `format: value => value` - Output formatter. - Example: `value => Math.round(value)`. - `children: (formattedValue, rawValue) => any` - Pull the animated number to animate more complex things deeper in the DOM tree. - Example: `(_, value) => ` ### `BlockQuote` Just a block quote, just like this example in markdown: > Here's an example of a block quote. **Props:** - See inherited props: [Box](#box) ### `Box` The Box component serves as a wrapper component for most of the CSS utility needs. It creates a new DOM element, a `
` by default that can be changed with the `as` property. Let's say you want to use a `` instead: ```jsx ``` Flex item with `grow` property will grow to take all available empty space, while flex items without grow will take the minimum amount of space. This effectively places the last flex item to the very end of the flex container. **Props:** - See inherited props: [Box](#box) - ~~`spacing: number`~~ - **Removed in tgui 4.3**, use [Stack](#stack) instead. - `inline: boolean` - Makes flexbox container inline, with similar behavior to an `inline` property on a `Box`. - `direction: string` - This establishes the main-axis, thus defining the direction flex items are placed in the flex container. - `row` (default) - left to right. - `row-reverse` - right to left. - `column` - top to bottom. - `column-reverse` - bottom to top. - `wrap: string` - By default, flex items will all try to fit onto one line. You can change that and allow the items to wrap as needed with this property. - `nowrap` (default) - all flex items will be on one line - `wrap` - flex items will wrap onto multiple lines, from top to bottom. - `wrap-reverse` - flex items will wrap onto multiple lines from bottom to top. - `align: string` - Default alignment of all children. - `stretch` (default) - stretch to fill the container. - `start` - items are placed at the start of the cross axis. - `end` - items are placed at the end of the cross axis. - `center` - items are centered on the cross axis. - `baseline` - items are aligned such as their baselines align. - `justify: string` - This defines the alignment along the main axis. It helps distribute extra free space leftover when either all the flex items on a line are inflexible, or are flexible but have reached their maximum size. It also exerts some control over the alignment of items when they overflow the line. - `flex-start` (default) - items are packed toward the start of the flex-direction. - `flex-end` - items are packed toward the end of the flex-direction. - `space-between` - items are evenly distributed in the line; first item is on the start line, last item on the end line - `space-around` - items are evenly distributed in the line with equal space around them. Note that visually the spaces aren't equal, since all the items have equal space on both sides. The first item will have one unit of space against the container edge, but two units of space between the next item because that next item has its own spacing that applies. - `space-evenly` - items are distributed so that the spacing between any two items (and the space to the edges) is equal. - TBD (not all properties are supported in IE11). ### `Flex.Item` **Props:** - See inherited props: [Box](#box) - `order: number` - By default, flex items are laid out in the source order. However, the order property controls the order in which they appear in the flex container. - `grow: number | boolean` - This defines the ability for a flex item to grow if necessary. It accepts a unitless value that serves as a proportion. It dictates what amount of the available space inside the flex container the item should take up. This number is unit-less and is relative to other siblings. - `shrink: number | boolean` - This defines the ability for a flex item to shrink if necessary. Inverse of `grow`. - `basis: number | string` - This defines the default size of an element before any flex-related calculations are done. Has to be a length (e.g. `20%`, `5rem`), an `auto` or `content` keyword. - **Important:** IE11 flex is buggy, and auto width/height calculations can sometimes end up in a circular dependency. This usually happens, when working with tables inside flex (they have wacky internal widths and such). Setting basis to `0` breaks the loop and fixes all of the problems. - `align: string` - This allows the default alignment (or the one specified by align-items) to be overridden for individual flex items. See: [Flex](#flex). ### `Grid` > **Deprecated:** This component is no longer recommended due to the variety > of bugs that come with table-based layouts. > We recommend using [Flex](#flex) instead. Helps you to divide horizontal space into two or more equal sections. It is essentially a single-row `Table`, but with some extra features. Example: ```jsx
Hello world!
Hello world!
``` **Props:** - See inherited props: [Table](#table) ### `Grid.Column` **Props:** - See inherited props: [Table.Cell](#tablecell) - `size: number` (default: 1) - Size of the column relative to other columns. ### `Icon` Renders one of the FontAwesome icons of your choice. ```jsx ``` To smoothen the transition from v4 to v5, we have added a v4 semantic to transform names with `-o` suffixes to FA Regular icons. For example: - `square` will get transformed to `fas square` - `square-o` will get transformed to `far square` **Props:** - See inherited props: [Box](#box) - `name: string` - Icon name. - `size: number` - Icon size. `1` is normal size, `2` is two times bigger. Fractional numbers are supported. - `rotation: number` - Icon rotation, in degrees. - `spin: boolean` - Whether an icon should be spinning. Good for load indicators. ### `Icon.Stack` Renders children icons on top of each other in order to make your own icon. ```jsx ``` **Props:** - See inherited props: [Box](#box) - `children: Icon` - Icons to stack. ### `Input` A basic text input, which allow users to enter text into a UI. > Input does not support custom font size and height due to the way > it's implemented in CSS. Eventually, this needs to be fixed. **Props:** - See inherited props: [Box](#box) - `value: string` - Value of an input. - `placeholder: string` - Text placed into Input box when it's empty, otherwise nothing. Clears automatically when focused. - `fluid: boolean` - Fill all available horizontal space. - `selfClear: boolean` - Clear after hitting enter, as well as remain focused when this happens. Useful for things like chat inputs. - `onChange: (e, value) => void` - An event, which fires when you commit the text by either unfocusing the input box, or by pressing the Enter key. - `onInput: (e, value) => void` - An event, which fires on every keypress. ### `Knob` A radial control, which allows dialing in precise values by dragging it up and down. Single click opens an input box to manually type in a number. **Props:** - See inherited props: [Box](#box) - `animated: boolean` - Animates the value if it was changed externally. - `bipolar: boolean` - Knob can be bipolar or unipolar. - `size: number` - Relative size of the knob. `1` is normal size, `2` is two times bigger. Fractional numbers are supported. - `color: string` - Color of the outer ring around the knob. - `value: number` - Value itself, controls the position of the cursor. - `unit: string` - Unit to display to the right of value. - `minValue: number` - Lowest possible value. - `maxValue: number` - Highest possible value. - `fillValue: number` - If set, this value will be used to set the fill percentage of the outer ring independently of the main value. - `ranges: { color: [from, to] }` - Applies a `color` to the outer ring around the knob based on whether the value lands in the range between `from` and `to`. See an example of this prop in [ProgressBar](#progressbar). - `step: number` (default: 1) - Adjust value by this amount when dragging the input. - `stepPixelSize: number` (default: 1) - Screen distance mouse needs to travel to adjust value by one `step`. - `format: value => value` - Format value using this function before displaying it. - `suppressFlicker: number` - A number in milliseconds, for which the input will hold off from updating while events propagate through the backend. Default is about 250ms, increase it if you still see flickering. - `onChange: (e, value) => void` - An event, which fires when you release the input, or successfully enter a number. - `onDrag: (e, value) => void` - An event, which fires about every 500ms when you drag the input up and down, on release and on manual editing. ### `LabeledControls` LabeledControls is a horizontal grid, that is designed to hold various controls, like [Knobs](#knob) or small [Buttons](#button). Every item in this grid is labeled at the bottom. **Props:** - See inherited props: [Box](#box) - `children: LabeledControls.Item` - Items to render. ### `LabeledControls.Item` **Props:** - See inherited props: [Box](#box) - `label: string` - Item label. ### `LabeledList` LabeledList is a continuous, vertical list of text and other content, where every item is labeled. It works just like a two column table, where first column is labels, and second column is content. ```jsx Content ``` If you want to have a button on the right side of an item (for example, to perform some sort of action), there is a way to do that: ```jsx Click me! )}> Content ``` **Props:** - `children: LabeledList.Item` - Items to render. ### `LabeledList.Item` **Props:** - `label: string` - Item label. - `color: string` - Sets the color of the text. - `buttons: any` - Buttons to render aside the content. - `children: any` - Content of this labeled item. ### `LabeledList.Divider` Adds some empty space between LabeledList items. Example: ```jsx Content ``` **Props:** - `size: number` - Size of the divider. ### `Modal` A modal window. Uses a [Dimmer](#dimmer) under the hood, and dynamically adjusts its own size to fit the content you're trying to display. Must be a direct child of a layout component (e.g. [Window](#window)). **Props:** - See inherited props: [Box](#box) ### `NoticeBox` A notice box, which warns you about something very important. **Props:** - See inherited props: [Box](#box) - `info: boolean` - Info box - `success: boolean` - Success box - `warning: bolean` - Warning box - `danger: boolean` - Danger box ### `NumberInput` A fancy, interactive number input, which you can either drag up and down to fine tune the value, or single click it to manually type a number. **Props:** - `animated: boolean` - Animates the value if it was changed externally. - `fluid: boolean` - Fill all available horizontal space. - `value: number` - Value itself. - `unit: string` - Unit to display to the right of value. - `minValue: number` - Lowest possible value. - `maxValue: number` - Highest possible value. - `step: number` (default: 1) - Adjust value by this amount when dragging the input. - `stepPixelSize: number` (default: 1) - Screen distance mouse needs to travel to adjust value by one `step`. - `width: string|number` - Width of the element, in `Box` units or pixels. - `height: string|numer` - Height of the element, in `Box` units or pixels. - `lineHeight: string|number` - lineHeight of the element, in `Box` units or pixels. - `fontSize: string|number` - fontSize of the element, in `Box` units or pixels. - `format: value => value` - Format value using this function before displaying it. - `suppressFlicker: number` - A number in milliseconds, for which the input will hold off from updating while events propagate through the backend. Default is about 250ms, increase it if you still see flickering. - `onChange: (e, value) => void` - An event, which fires when you release the input, or successfully enter a number. - `onDrag: (e, value) => void` - An event, which fires about every 500ms when you drag the input up and down, on release and on manual editing. ### `Popper` Popper lets you position elements so that they don't go out of the bounds of the window. See [popper.js](https://popper.js.org/) for more information. **Props:** - `popperContent: InfernoNode` - The content that will be put inside the popper. - `options?: { ... }` - An object of options to pass to `createPopper`. See [https://popper.js.org/docs/v2/constructors/#options], but the one you want most is `placement`. Valid placements are "bottom", "top", "left", and "right". You can affix "-start" and "-end" to achieve something like top left or top right respectively. You can also use "auto" (with an optional "-start" or "-end"), where a best fit will be chosen. - `additionalStyles: { ... }` - A map of CSS styles to add to the element that will contain the popper. ### `ProgressBar` Progress indicators inform users about the status of ongoing processes. ```jsx ``` Usage of `ranges` prop: ```jsx ``` **Props:** - `value: number` - Current progress as a floating point number between `minValue` (default: 0) and `maxValue` (default: 1). Determines the percentage and how filled the bar is. - `minValue: number` - Lowest possible value. - `maxValue: number` - Highest possible value. - `ranges: { color: [from, to] }` - Applies a `color` to the progress bar based on whether the value lands in the range between `from` and `to`. - `color: string` - Color of the progress bar. - `children: any` - Content to render inside the progress bar. ### `RoundGauge` The RoundGauge component provides a visual representation of a single metric, as well as being capable of showing informational or cautionary boundaries related to that metric. ```jsx ``` The alert on the gauge is optional, and will only be shown if the `alertAfter` prop is defined. When defined, the alert will begin to flash the respective color upon which the needle currently rests, as defined in the `ranges` prop. **Props:** - See inherited props: [Box](#box) - `value: number` - The current value of the metric. - `minValue: number` (default: 0) - The lower bound of the guage. - `maxValue: number` (default: 1) - The upper bound of the guage. - `ranges: { color: [from, to] }` (default: `{ "good": [0, 1] }`) - Provide regions of the guage to color between two specified values of the metric. - `alertAfter: number` (optional) - When provided, will cause an alert symbol on the gauge to begin flashing in the color upon which the needle currently rest, as defined in `ranges`. - `format: function(value) => string` (optional) - When provided, will be used to format the value of the metric for display. - `size: number` (default: 1) - When provided scales the gauge. ### `Section` Section is a surface that displays content and actions on a single topic. They should be easy to scan for relevant and actionable information. Elements, like text and images, should be placed in them in a way that clearly indicates hierarchy. Section can also be titled to clearly define its purpose. ```jsx
Here you can order supply crates.
``` If you want to have a button on the right side of an section title (for example, to perform some sort of action), there is a way to do that: ```jsx
Send shuttle )}> Here you can order supply crates.
``` **New:** Sections can now be nested, and will automatically font size of the header according to their nesting level. Previously this was done via `level` prop, but now it is automatically calculated. - See inherited props: [Box](#box) - `title: string` - Title of the section. - `buttons: any` - Buttons to render aside the section title. - `fill: boolean` - If true, fills all available vertical space. - `fitted: boolean` - If true, removes all section padding. - `scrollable: boolean` - Shows or hides the scrollbar. - `children: any` - Content of this section. ### `Slider` A horizontal, [ProgressBar](#progressbar)-like control, which allows dialing in precise values by dragging it left and right. Single click opens an input box to manually type in a number. **Props:** - See inherited props: [Box](#box) - `animated: boolean` - Animates the value if it was changed externally. - `color: string` - Color of the slider. - `value: number` - Value itself, controls the position of the cursor. - `unit: string` - Unit to display to the right of value. - `minValue: number` - Lowest possible value. - `maxValue: number` - Highest possible value. - `fillValue: number` - If set, this value will be used to set the fill percentage of the progress bar filler independently of the main value. - `ranges: { color: [from, to] }` - Applies a `color` to the slider based on whether the value lands in the range between `from` and `to`. See an example of this prop in [ProgressBar](#progressbar). - `step: number` (default: 1) - Adjust value by this amount when dragging the input. - `stepPixelSize: number` (default: 1) - Screen distance mouse needs to travel to adjust value by one `step`. - `format: value => value` - Format value using this function before displaying it. - `suppressFlicker: number` - A number in milliseconds, for which the input will hold off from updating while events propagate through the backend. Default is about 250ms, increase it if you still see flickering. - `onChange: (e, value) => void` - An event, which fires when you release the input, or successfully enter a number. - `onDrag: (e, value) => void` - An event, which fires about every 500ms when you drag the input up and down, on release and on manual editing. ### `Stack` A higher-level component, that is based on [Flex](#flex). The main difference from `Flex`, is that this component automatically adds spacing between all stack items, reducing the boilerplate that you have to write! Consists of two elements: `` and ``. Stacks can be vertical by adding a `vertical` property. **Example:** ```jsx Button description ``` **Example of a high-level window layout:** Stacks can be used for high level window layout. Make sure to use the `fill` property. ```jsx
Sidebar
Main content
Bottom pane
``` **Props:** - See inherited props: [Flex](#flex) - `fill: boolean` - If set, stack will fill all available height. - `vertical: boolean` - If set, stack will work in vertical mode. ### `Stack.Item` **Props:** - See inherited props: [Flex.Item](#flexitem) ### `Table` A straight forward mapping to a standard html table, which is slightly simplified (does not need a `` tag) and with sane default styles (e.g. table width is 100% by default). Example: ```jsx Hello world! Label
``` **Props:** - See inherited props: [Box](#box) - `collapsing: boolean` - Collapses table to the smallest possible size. ### `Table.Row` A straight forward mapping to `` element. **Props:** - See inherited props: [Box](#box) ### `Table.Cell` A straight forward mapping to `` element. **Props:** - See inherited props: [Box](#box) - `collapsing: boolean` - Collapses table cell to the smallest possible size, and stops any text inside from wrapping. ### `Tabs` Tabs make it easy to explore and switch between different views. Here is an example of how you would construct a simple tabbed view: ```jsx setTabIndex(1)}> Tab one setTabIndex(2)}> Tab two Tab selected: {tabIndex} ``` Notice that tabs do not contain state. It is your job to track the selected tab, handle clicks and place tab content where you need it. In return, you get a lot of flexibility in regards to how you can layout your tabs. Tabs also support a vertical configuration. This is usually paired with [Stack](#stack) to render tab content to the right. ```jsx ... Tab content. ``` If you need to combine a tab section with other elements, or if you want to add scrollable functionality to tabs, pair them with the [Section](#section) component: ```jsx
... ... other things ...
``` **Props:** - See inherited props: [Box](#box) - `fluid: boolean` - If true, tabs will take all available horizontal space. - `fill: boolean` - Similarly to `fill` on [Section](#section), tabs will fill all available vertical space. Only makes sense in a vertical configuration. - `vertical: boolean` - Use a vertical configuration, where tabs will be stacked vertically. - `children: Tab[]` - This component only accepts tabs as its children. ### `Tabs.Tab` An individual tab element. Tabs function like buttons, so they inherit a lot of `Button` props. **Props:** - See inherited props: [Button](#button) - `altSelection` - Whether the tab buttons select via standard select (color change) or by adding a white indicator to the selected tab. Intended for usage on interfaces where tab color has relevance. - `icon: string` - Tab icon. - `children: any` - Tab text. - `onClick: function` - Called when element is clicked. ### `Tooltip` A boxy tooltip from tgui 1. It is very hacky in its current state, and requires setting `position: relative` on the container. Please note, that [Button](#button) component has a `tooltip` prop, and it is recommended to use that prop instead. Usage: ```jsx Sample text. ``` **Props:** - `position?: string` - Tooltip position. See [`Popper`](#Popper) for valid options. Defaults to "auto". - `content: string` - Content of the tooltip. Must be a plain string. Fragments or other elements are **not** supported. ## `tgui/layouts` ### `Window` A root-level component, which draws the window chrome, titlebar, resize handlers, and controls the UI theme. All tgui interfaces must implement it in one way or another. Example: ```jsx Hello, world! ``` **Props:** - See inherited props: [Box](#box) - `className: string` - Applies a CSS class to the element. - `theme: string` - A name of the theme. - For a list of themes, see `packages/tgui/styles/themes`. - `title: string` - Window title. - `width: number` - Window width. - `height: number` - Window height. - `canClose: boolean` - Controls the ability to close the window. - `children: any` - Child elements, which are rendered directly inside the window. If you use a [Dimmer](#dimmer) or [Modal](#modal) in your UI, they should be put as direct childs of a Window, otherwise you should be putting your content into [Window.Content](#windowcontent). ### `Window.Content` Canonical window content, which is usually the main target of window focus. Can be scrollable. **Props:** - See inherited props: [Box](#box) - `className: string` - Applies a CSS class to the element. - `fitted: boolean` - If true, removes all padding. - `scrollable: boolean` - Shows or hides the scrollbar. - `children: any` - Main content of your window.