From e27bc2eda33e0116ab28781c457a5be15ec8175f Mon Sep 17 00:00:00 2001 From: Letter N <24603524+LetterN@users.noreply.github.com> Date: Tue, 21 Jul 2020 13:32:12 +0800 Subject: [PATCH] docs and things --- tgui/README.md | 7 +- tgui/docs/component-reference.md | 22 +- tgui/docs/tutorial-and-examples.md | 4 +- tgui/yarn.lock | 566 ++++++++++++++++------------- 4 files changed, 337 insertions(+), 262 deletions(-) diff --git a/tgui/README.md b/tgui/README.md index 5ddeb18fdd..c479324764 100644 --- a/tgui/README.md +++ b/tgui/README.md @@ -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. diff --git a/tgui/docs/component-reference.md b/tgui/docs/component-reference.md index a2a0066a70..e1f7ebf9b4 100644 --- a/tgui/docs/component-reference.md +++ b/tgui/docs/component-reference.md @@ -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 diff --git a/tgui/docs/tutorial-and-examples.md b/tgui/docs/tutorial-and-examples.md index 683f819a8c..3497ea9746 100644 --- a/tgui/docs/tutorial-and-examples.md +++ b/tgui/docs/tutorial-and-examples.md @@ -142,7 +142,7 @@ export const SampleInterface = (props, context) => {