react-var-ui v1.5.2

react-var-ui is a simple React component library for variable setting and preview, inspired by iOS settings, react-dat-gui and dat.gui.

While some code from react-dat-gui was used, this library functions in a completely different way. The codebase uses modern React code practices such as hooks and functional components. Instead of iterating over the children array, react-var-ui uses a Context. Creation of custom components is also easier.

What makes react-var-ui different when compared to similar libraries such as Leva or react-dat-gui, react-var-ui doesn't force itself to float over all your content, instead react-var-ui lives peacefully inside of the React node it is placed in. Unlike Leva and much more like react-dat-gui, react-var-ui relies on a local state variable, providing the developer with more flexibility. While this might seem less convenient, it allows for more customization and usage of multiple instances of react-dat-gui within one project.

Table of contents

• Installation
• Example usage
• Testing
• Utility components
  • VarUI
  • VarCategory
  • VarArray
• Input components
  • Base properties
  • VarAngle
  • VarBase
  • VarButton
  • VarColor
  • VarDisplay
  • VarFile
  • VarImage
  • VarMedia
  • VarNumber
  • VarSelect
  • VarSlider
  • VarString
  • VarToggle
  • VarXY
• Theme customization
• Custom input components

Installation

Install react-var-ui with either npm or yarn:

yarn add react-var-ui
# or
npm install react-var-ui

Then include the CSS with:

/* In your CSS/SCSS file: */
@import 'react-var-ui/index.css';

or:

// In your JS/TS file (assuming your bundler supports loading CSS files):
import 'react-var-ui/index.css';

Example usage

const [values, setValues] = React.useState({
  toggle: true,
  color: '#FF0000',
  select: 1,
  slider: 0.4,
  xy: [0, 0.2],
  string: 'Hello world!',
});

return (
  <VarUI onChange={setValues} values={values}>
    <VarCategory label="Example">
      <VarColor path="color" label="Color" />
      <VarToggle path="toggle" label="Toggle" />
      <VarSelect
        path="select"
        label="Select"
        options={[
          { key: 0, label: 'Zero' },
          { key: 1, label: 'One' },
        ]}
      />
      <VarSlider
        label="VarSlider"
        path="slider"
        min={0.2}
        max={0.8}
        step={0.1}
      />
      <VarString label="VarString" path="string" />
      <VarXY label="VarXY" path="xy" />
      <VarButton buttonLabel="VarButton" onClick={() => alert('clicked!')} />
    </VarCategory>
  </VarUI>
);

Testing

react-var-ui uses jest for automated unit tests and storybook for manually testing the UI.

You can run unit tests after installing by running:

yarn test

Storybook can be ran with:

yarn storybook

To run the example app, you first need to start the project with:

yarn start

And then enter the example directory and start the app:

cd ./example
yarn start

(make sure to run yarn install before.)

Utility components

This is the main component which provides a Context for other components. It is not required to use this component - other components accept onChange and value properties which provide a similar functionality.

Required properties

Optional properties

Category component for grouping inputs.

Required properties

Optional properties

Renders an array value as a list of elements.

Optional properties

Creates a context with a certain path as base.

Optional properties

Examples

With ReactNode children:

<VarUI values={{ test: [{ prop: 'a' }, { prop: 'b' }, { prop: 'c' }] }}>
  <VarArray path="test">
    <VarInput path="prop" label="Example" />
  </VarArray>
</VarUI>

With function:

<VarUI values={{ test: [{ prop: 'a' }, { prop: 'b' }, { prop: 'c' }] }}>
  <VarArray path="test">
    {(element, index) => <VarInput path="prop" label={`Element: ${index}`} />}
  </VarArray>
</VarUI>

Input components

Base properties

Most input components accept the following base properties.

Does not apply to <VarButton />.

Optional properties

T is component's value type.

Angle picker component. Accepts and provides numbers (radians).

T = number (rad)

Base VarUI input component. Doesn't do anything besides displaying the label.

Used to construct other components from.

Button component.

Does not accept any of the base component properties.

Required properties

Optional properties

Color picker component. Returns and accepts values in form of hex color strings.

Uses @uiw/react-color-sketch to render the color picker.

T = string (#XXXXXX)

Optional properties

A simple component that displays a string or a numeric value.

Only accepts path and value. Does not change any values.

T = string | number

A simple file input component. Accepts and provides File instances.

T = File

Optional properties

A simple image input component. Accepts and provides blob/data URLs.

T = string

Media (audio/video/image) input component. Accepts and provides a blob URL.

If acceptImage, acceptAudio and acceptVideo are all false, the component will accept all 3.

T = string

Optional properties

Integer/float number component. Accepts and provides numbers.

T = number

Optional properties

Select component. Returns and accepts either value from option object or key when value is not provided.

T = any

Required properties

Interface: IVarSelectOption

Required:

Optional:

Integer/float slider component. Accepts and provides numbers.

T = number

Required properties

Optional properties

String input component. Accepts and provides a string value.

T = string

Optional properties

Checkbox/toggle component. Accepts and returns a boolean (true/false).

T = boolean

XY offset picker. Accepts and provides an array in form of x, y.

T = number (x), number (y)

Optional properties

Theme customization

The colors can be customized as such (provided are default values):

.react-var-ui {
  /* Foreground color, used for text. */
  --react-var-ui-foreground-color: #ddd;

  /* Background color, used for category header backgrounds. */
  --react-var-ui-background-color: #11111a;

  /* Accent color, used for active parts of sliders, toggles and XY. */
  --react-var-ui-accent-color: #77f;

  /* Input background color. */
  --react-var-ui-input-background-color: #353542;

  /* Input background color (when hovered). */
  --react-var-ui-input-background-hover-color: #424253;

  /* Input background color (when pressed). Only applies to buttons. */
  --react-var-ui-input-background-pressed-color: #2b2b37;

  /* Label background color. */
  --react-var-ui-label-background-normal-color: #22222a;

  /* Label background color (when hovered). */
  --react-var-ui-label-background-hover-color: #2a2a33;

  /* Label border color. */
  --react-var-ui-label-border-color: #33333a;
}

Custom input components

react-var-ui provides a <VarBase /> component and a useVarUIValue hook designed to facilitate creation of custom components.

Example usage

import React from 'react';
import { useVarUIValue, IVarBaseInputProps, VarBase } from 'react-var-ui';

// Please specify the <T>.
export interface IVarCustomProps extends IVarBaseInputProps<string> {}

/**
 * Custom input component. In this example, it's a simple text input.
 */
export const VarCustom = ({
  label,
  path,
  value,
  onChange,
  disabled,
  className,
}: IVarCustomProps): JSX.Element => {
  /**
   * currentValue will contain the current value from the value object
   * (at a given path) or value from properties if that's not available.
   *
   * setCurrentValue will set the value onto a given path in the object
   * and call onChange if available.
   *
   * All arguments are optional, path/object-based value changes take
   * precedence.
   */
  const [currentValue, setCurrentValue] = useVarUIValue(path, value, onChange);

  /**
   * We're wrapping our component in VarBase which provides the default
   * label.
   *
   * It is necessary to wrap what should appear on the right in a <span>.
   * If this behavior is undesired, a <div> with grid-column: 1 / 3; can
   * be used.
   */
  return (
    <VarBase label={label} disabled={disabled} className={className}>
      <span>
        <input
          type="text"
          maxLength={maxLength}
          value={currentValue}
          onChange={e => setCurrentValue(e.target.value)}
        />
      </span>
    </VarBase>
  );
};