tgui-core 1.0.2 → 1.0.4

package/{src/components → components}/Knob.tsx

@@ -1,185 +1,185 @@
-/**
- * @file
- * @copyright 2020 Aleksej Komarov
- * @license MIT
- */
-
-import { keyOfMatchingRange, scale } from '../common/math';
-import { BooleanLike, classes } from '../common/react';
-
-import { BoxProps, computeBoxClassName, computeBoxProps } from './Box';
-import { DraggableControl } from './DraggableControl';
-
-type Props = {
-  /** Value itself, controls the position of the cursor. */
-  value: number;
-} & Partial<{
-  /** Animates the value if it was changed externally. */
-  animated: boolean;
-  /** Knob can be bipolar or unipolar. */
-  bipolar: boolean;
-  /** Color of the outer ring around the knob. */
-  color: string | BooleanLike;
-  /** If set, this value will be used to set the fill percentage of the outer ring independently of the main value. */
-  fillValue: number;
-  /** Format value using this function before displaying it. */
-  format: (value: number) => string;
-  /** Highest possible value. */
-  maxValue: number;
-  /** Lowest possible value. */
-  minValue: number;
-  /** Adjust value by this amount when dragging the input. */
-  onChange: (event: Event, value: number) => void;
-  /** An event, which fires about every 500ms when you drag the input up and down, on release and on manual editing. */
-  onDrag: (event: Event, value: number) => void;
-  /** Applies a `color` to the outer ring around the knob based on whether the value lands in the range between `from` and `to`. */
-  ranges: Record<string, [number, number]>;
-  /** Relative size of the knob. `1` is normal size, `2` is two times bigger. Fractional numbers are supported. */
-  size: number;
-  /** Adjust value by this amount when dragging the input. */
-  step: number;
-  /** Screen distance mouse needs to travel to adjust value by one `step`. */
-  stepPixelSize: 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. */
-  suppressFlicker: boolean;
-  /** Unit to display to the right of value. */
-  unit: string;
-  /** Whether to clamp the value to the range. */
-  unclamped: boolean;
-}> &
-  BoxProps;
-
-/**
- * ## 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.
- */
-export function Knob(props: Props) {
-  const {
-    // Draggable props (passthrough)
-    animated,
-    format,
-    maxValue,
-    minValue,
-    onChange,
-    onDrag,
-    step,
-    stepPixelSize,
-    suppressFlicker,
-    unclamped,
-    unit,
-    value,
-    // Own props
-    bipolar,
-    children,
-    className,
-    color,
-    fillValue,
-    ranges = {},
-    size = 1,
-    style,
-    ...rest
-  } = props;
-
-  return (
-    <DraggableControl
-      dragMatrix={[0, -1]}
-      {...{
-        animated,
-        format,
-        maxValue,
-        minValue,
-        onChange,
-        onDrag,
-        step,
-        stepPixelSize,
-        suppressFlicker,
-        unclamped,
-        unit,
-        value,
-      }}
-    >
-      {(control) => {
-        const {
-          displayElement,
-          displayValue,
-          dragging,
-          handleDragStart,
-          inputElement,
-          value,
-        } = control;
-        const scaledFillValue = scale(
-          fillValue ?? displayValue,
-          minValue,
-          maxValue
-        );
-        const scaledDisplayValue = scale(displayValue, minValue, maxValue);
-        const effectiveColor =
-          color || keyOfMatchingRange(fillValue ?? value, ranges) || 'default';
-        const rotation = Math.min((scaledDisplayValue - 0.5) * 270, 225);
-
-        return (
-          <div
-            className={classes([
-              'Knob',
-              'Knob--color--' + effectiveColor,
-              bipolar && 'Knob--bipolar',
-              className,
-              computeBoxClassName(rest),
-            ])}
-            {...computeBoxProps({
-              style: {
-                fontSize: size + 'em',
-                ...style,
-              },
-              ...rest,
-            })}
-            onMouseDown={handleDragStart}
-          >
-            <div className="Knob__circle">
-              <div
-                className="Knob__cursorBox"
-                style={{
-                  transform: `rotate(${rotation}deg)`,
-                }}
-              >
-                <div className="Knob__cursor" />
-              </div>
-            </div>
-            {dragging && (
-              <div className="Knob__popupValue">{displayElement}</div>
-            )}
-            <svg
-              className="Knob__ring Knob__ringTrackPivot"
-              viewBox="0 0 100 100"
-            >
-              <circle className="Knob__ringTrack" cx="50" cy="50" r="50" />
-            </svg>
-            <svg
-              className="Knob__ring Knob__ringFillPivot"
-              viewBox="0 0 100 100"
-            >
-              <circle
-                className="Knob__ringFill"
-                style={{
-                  strokeDashoffset: Math.max(
-                    ((bipolar ? 2.75 : 2.0) - scaledFillValue * 1.5) *
-                      Math.PI *
-                      50,
-                    0
-                  ),
-                }}
-                cx="50"
-                cy="50"
-                r="50"
-              />
-            </svg>
-            {inputElement}
-          </div>
-        );
-      }}
-    </DraggableControl>
-  );
-}
+/**
+ * @file
+ * @copyright 2020 Aleksej Komarov
+ * @license MIT
+ */
+
+import { keyOfMatchingRange, scale } from '../common/math';
+import { BooleanLike, classes } from '../common/react';
+
+import { BoxProps, computeBoxClassName, computeBoxProps } from './Box';
+import { DraggableControl } from './DraggableControl';
+
+type Props = {
+  /** Value itself, controls the position of the cursor. */
+  value: number;
+} & Partial<{
+  /** Animates the value if it was changed externally. */
+  animated: boolean;
+  /** Knob can be bipolar or unipolar. */
+  bipolar: boolean;
+  /** Color of the outer ring around the knob. */
+  color: string | BooleanLike;
+  /** If set, this value will be used to set the fill percentage of the outer ring independently of the main value. */
+  fillValue: number;
+  /** Format value using this function before displaying it. */
+  format: (value: number) => string;
+  /** Highest possible value. */
+  maxValue: number;
+  /** Lowest possible value. */
+  minValue: number;
+  /** Adjust value by this amount when dragging the input. */
+  onChange: (event: Event, value: number) => void;
+  /** An event, which fires about every 500ms when you drag the input up and down, on release and on manual editing. */
+  onDrag: (event: Event, value: number) => void;
+  /** Applies a `color` to the outer ring around the knob based on whether the value lands in the range between `from` and `to`. */
+  ranges: Record<string, [number, number]>;
+  /** Relative size of the knob. `1` is normal size, `2` is two times bigger. Fractional numbers are supported. */
+  size: number;
+  /** Adjust value by this amount when dragging the input. */
+  step: number;
+  /** Screen distance mouse needs to travel to adjust value by one `step`. */
+  stepPixelSize: 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. */
+  suppressFlicker: boolean;
+  /** Unit to display to the right of value. */
+  unit: string;
+  /** Whether to clamp the value to the range. */
+  unclamped: boolean;
+}> &
+  BoxProps;
+
+/**
+ * ## 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.
+ */
+export function Knob(props: Props) {
+  const {
+    // Draggable props (passthrough)
+    animated,
+    format,
+    maxValue,
+    minValue,
+    onChange,
+    onDrag,
+    step,
+    stepPixelSize,
+    suppressFlicker,
+    unclamped,
+    unit,
+    value,
+    // Own props
+    bipolar,
+    children,
+    className,
+    color,
+    fillValue,
+    ranges = {},
+    size = 1,
+    style,
+    ...rest
+  } = props;
+
+  return (
+    <DraggableControl
+      dragMatrix={[0, -1]}
+      {...{
+        animated,
+        format,
+        maxValue,
+        minValue,
+        onChange,
+        onDrag,
+        step,
+        stepPixelSize,
+        suppressFlicker,
+        unclamped,
+        unit,
+        value,
+      }}
+    >
+      {(control) => {
+        const {
+          displayElement,
+          displayValue,
+          dragging,
+          handleDragStart,
+          inputElement,
+          value,
+        } = control;
+        const scaledFillValue = scale(
+          fillValue ?? displayValue,
+          minValue,
+          maxValue
+        );
+        const scaledDisplayValue = scale(displayValue, minValue, maxValue);
+        const effectiveColor =
+          color || keyOfMatchingRange(fillValue ?? value, ranges) || 'default';
+        const rotation = Math.min((scaledDisplayValue - 0.5) * 270, 225);
+
+        return (
+          <div
+            className={classes([
+              'Knob',
+              'Knob--color--' + effectiveColor,
+              bipolar && 'Knob--bipolar',
+              className,
+              computeBoxClassName(rest),
+            ])}
+            {...computeBoxProps({
+              style: {
+                fontSize: size + 'em',
+                ...style,
+              },
+              ...rest,
+            })}
+            onMouseDown={handleDragStart}
+          >
+            <div className="Knob__circle">
+              <div
+                className="Knob__cursorBox"
+                style={{
+                  transform: `rotate(${rotation}deg)`,
+                }}
+              >
+                <div className="Knob__cursor" />
+              </div>
+            </div>
+            {dragging && (
+              <div className="Knob__popupValue">{displayElement}</div>
+            )}
+            <svg
+              className="Knob__ring Knob__ringTrackPivot"
+              viewBox="0 0 100 100"
+            >
+              <circle className="Knob__ringTrack" cx="50" cy="50" r="50" />
+            </svg>
+            <svg
+              className="Knob__ring Knob__ringFillPivot"
+              viewBox="0 0 100 100"
+            >
+              <circle
+                className="Knob__ringFill"
+                style={{
+                  strokeDashoffset: Math.max(
+                    ((bipolar ? 2.75 : 2.0) - scaledFillValue * 1.5) *
+                      Math.PI *
+                      50,
+                    0
+                  ),
+                }}
+                cx="50"
+                cy="50"
+                r="50"
+              />
+            </svg>
+            {inputElement}
+          </div>
+        );
+      }}
+    </DraggableControl>
+  );
+}

package/{src/components → components}/LabeledList.tsx

@@ -1,130 +1,130 @@
-/**
- * @file
- * @copyright 2020 Aleksej Komarov
- * @license MIT
- */
-
-import { BooleanLike, classes } from '../common/react';
-import { PropsWithChildren, ReactNode } from 'react';
-
-import { Box, unit } from './Box';
-import { Divider } from './Divider';
-import { Tooltip } from './Tooltip';
-
-export const LabeledList = (props: PropsWithChildren) => {
-  const { children } = props;
-  return <table className="LabeledList">{children}</table>;
-};
-
-type LabeledListItemProps = Partial<{
-  buttons: ReactNode;
-  className: string | BooleanLike;
-  color: string;
-  key: string | number;
-  label: string | ReactNode | BooleanLike;
-  labelColor: string;
-  labelWrap: boolean;
-  textAlign: string;
-  /** @deprecated */
-  content: any;
-  children: ReactNode;
-  verticalAlign: string;
-  tooltip: string;
-}>;
-
-const LabeledListItem = (props: LabeledListItemProps) => {
-  const {
-    className,
-    label,
-    labelColor = 'label',
-    labelWrap,
-    color,
-    textAlign,
-    buttons,
-    content,
-    children,
-    verticalAlign = 'baseline',
-    tooltip,
-  } = props;
-
-  let innerLabel;
-  if (label) {
-    innerLabel = label;
-    if (typeof label === 'string') innerLabel += ':';
-  }
-
-  if (tooltip !== undefined) {
-    innerLabel = (
-      <Tooltip content={tooltip}>
-        <Box
-          as="span"
-          style={{
-            borderBottom: '2px dotted rgba(255, 255, 255, 0.8)',
-          }}
-        >
-          {innerLabel}
-        </Box>
-      </Tooltip>
-    );
-  }
-
-  let labelChild = (
-    <Box
-      as="td"
-      color={labelColor}
-      className={classes([
-        'LabeledList__cell',
-        // Kinda flipped because we want nowrap as default. Cleaner CSS this way though.
-        !labelWrap && 'LabeledList__label--nowrap',
-      ])}
-      verticalAlign={verticalAlign}
-    >
-      {innerLabel}
-    </Box>
-  );
-
-  return (
-    <tr className={classes(['LabeledList__row', className])}>
-      {labelChild}
-      <Box
-        as="td"
-        color={color}
-        textAlign={textAlign}
-        className={classes(['LabeledList__cell', 'LabeledList__content'])}
-        // @ts-ignore
-        colSpan={buttons ? undefined : 2}
-        verticalAlign={verticalAlign}
-      >
-        {content}
-        {children}
-      </Box>
-      {buttons && (
-        <td className="LabeledList__cell LabeledList__buttons">{buttons}</td>
-      )}
-    </tr>
-  );
-};
-
-type LabeledListDividerProps = {
-  size?: number;
-};
-
-const LabeledListDivider = (props: LabeledListDividerProps) => {
-  const padding = props.size ? unit(Math.max(0, props.size - 1)) : 0;
-  return (
-    <tr className="LabeledList__row">
-      <td
-        colSpan={3}
-        style={{
-          paddingTop: padding,
-          paddingBottom: padding,
-        }}
-      >
-        <Divider />
-      </td>
-    </tr>
-  );
-};
-
-LabeledList.Item = LabeledListItem;
-LabeledList.Divider = LabeledListDivider;
+/**
+ * @file
+ * @copyright 2020 Aleksej Komarov
+ * @license MIT
+ */
+
+import { BooleanLike, classes } from '../common/react';
+import { PropsWithChildren, ReactNode } from 'react';
+
+import { Box, unit } from './Box';
+import { Divider } from './Divider';
+import { Tooltip } from './Tooltip';
+
+export const LabeledList = (props: PropsWithChildren) => {
+  const { children } = props;
+  return <table className="LabeledList">{children}</table>;
+};
+
+type LabeledListItemProps = Partial<{
+  buttons: ReactNode;
+  className: string | BooleanLike;
+  color: string;
+  key: string | number;
+  label: string | ReactNode | BooleanLike;
+  labelColor: string;
+  labelWrap: boolean;
+  textAlign: string;
+  /** @deprecated */
+  content: any;
+  children: ReactNode;
+  verticalAlign: string;
+  tooltip: string;
+}>;
+
+const LabeledListItem = (props: LabeledListItemProps) => {
+  const {
+    className,
+    label,
+    labelColor = 'label',
+    labelWrap,
+    color,
+    textAlign,
+    buttons,
+    content,
+    children,
+    verticalAlign = 'baseline',
+    tooltip,
+  } = props;
+
+  let innerLabel;
+  if (label) {
+    innerLabel = label;
+    if (typeof label === 'string') innerLabel += ':';
+  }
+
+  if (tooltip !== undefined) {
+    innerLabel = (
+      <Tooltip content={tooltip}>
+        <Box
+          as="span"
+          style={{
+            borderBottom: '2px dotted rgba(255, 255, 255, 0.8)',
+          }}
+        >
+          {innerLabel}
+        </Box>
+      </Tooltip>
+    );
+  }
+
+  let labelChild = (
+    <Box
+      as="td"
+      color={labelColor}
+      className={classes([
+        'LabeledList__cell',
+        // Kinda flipped because we want nowrap as default. Cleaner CSS this way though.
+        !labelWrap && 'LabeledList__label--nowrap',
+      ])}
+      verticalAlign={verticalAlign}
+    >
+      {innerLabel}
+    </Box>
+  );
+
+  return (
+    <tr className={classes(['LabeledList__row', className])}>
+      {labelChild}
+      <Box
+        as="td"
+        color={color}
+        textAlign={textAlign}
+        className={classes(['LabeledList__cell', 'LabeledList__content'])}
+        // @ts-ignore
+        colSpan={buttons ? undefined : 2}
+        verticalAlign={verticalAlign}
+      >
+        {content}
+        {children}
+      </Box>
+      {buttons && (
+        <td className="LabeledList__cell LabeledList__buttons">{buttons}</td>
+      )}
+    </tr>
+  );
+};
+
+type LabeledListDividerProps = {
+  size?: number;
+};
+
+const LabeledListDivider = (props: LabeledListDividerProps) => {
+  const padding = props.size ? unit(Math.max(0, props.size - 1)) : 0;
+  return (
+    <tr className="LabeledList__row">
+      <td
+        colSpan={3}
+        style={{
+          paddingTop: padding,
+          paddingBottom: padding,
+        }}
+      >
+        <Divider />
+      </td>
+    </tr>
+  );
+};
+
+LabeledList.Item = LabeledListItem;
+LabeledList.Divider = LabeledListDivider;