mirror of
https://github.com/SPLURT-Station/S.P.L.U.R.T-Station-13.git
synced 2025-12-10 09:54:52 +00:00
docs and things
This commit is contained in:
@@ -180,8 +180,11 @@ See: [Component Reference](docs/component-reference.md).
|
||||
|
||||
## License
|
||||
|
||||
All code is licensed with the parent license of *tgstation*, **AGPL-3.0**.
|
||||
Source code is covered by /tg/station's parent license - **AGPL-3.0**
|
||||
(see the main [README](../README.md)), unless otherwise indicated.
|
||||
|
||||
See the main [README](../README.md) for more details.
|
||||
Some files are annotated with a copyright header, which explicitly states
|
||||
the copyright holder and license of the file. Most of the core tgui
|
||||
source code is available under the **MIT** license.
|
||||
|
||||
The Authors retain all copyright to their respective work here submitted.
|
||||
|
||||
@@ -30,6 +30,8 @@ Make sure to add new items to this list if you document new components.
|
||||
- [`Icon`](#icon)
|
||||
- [`Input`](#input)
|
||||
- [`Knob`](#knob)
|
||||
- [`LabeledControls`](#labeledcontrols)
|
||||
- [`LabeledControls.Item`](#labeledcontrolsitem)
|
||||
- [`LabeledList`](#labeledlist)
|
||||
- [`LabeledList.Item`](#labeledlistitem)
|
||||
- [`LabeledList.Divider`](#labeledlistdivider)
|
||||
@@ -239,7 +241,7 @@ A ghetto checkbox, made entirely using existing Button API.
|
||||
|
||||
### `Button.Confirm`
|
||||
|
||||
A button with a an extra confirmation step, using native button component.
|
||||
A button with an extra confirmation step, using native button component.
|
||||
|
||||
**Props:**
|
||||
|
||||
@@ -584,6 +586,24 @@ 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
|
||||
|
||||
@@ -142,7 +142,7 @@ export const SampleInterface = (props, context) => {
|
||||
<LabeledList.Item label="Button">
|
||||
<Button
|
||||
content="Dispatch a 'test' action"
|
||||
onClick={() => act('test')}>
|
||||
onClick={() => act('test')} />
|
||||
</LabeledList.Item>
|
||||
</LabeledList>
|
||||
</Section>
|
||||
@@ -345,7 +345,7 @@ export const SampleInterface = (props, context) => {
|
||||
<LabeledList.Item label="Button">
|
||||
<Button
|
||||
content="Dispatch a 'test' action"
|
||||
onClick={() => act('test')}>
|
||||
onClick={() => act('test')} />
|
||||
</LabeledList.Item>
|
||||
</LabeledList>
|
||||
</Section>
|
||||
|
||||
566
tgui/yarn.lock
566
tgui/yarn.lock
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user