CygnusRoboticus / uivm

UI view model generation library

UIVM: User Interface View Models

A library for creating framework- and interface-agnostic view models with a variety of options.

Installation and Usage

npm install uivm
yarn add uivm

Sample control usage. Sandbox

import { tuple } from "fp-ts/lib/function";
import { FieldControl, GroupControl } from "uivm";

const viewModel = new GroupControl({
  firstName: new FieldControl("John"),
  lastName: new FieldControl("Wick"),
  group: (() =>
    new GroupControl({
      username: new FieldControl("[e-mail]"),
      password: new FieldControl(null, {
        hints: [() => tuple("private", true)],
      }),
      rememberMe: new FieldControl(false),
    }))(),
});

console.log(viewModel.value.group.username); // [e-mail]
viewModel.state$.subscribe(console.log);

Sample config usage, this produces a view model identical to the above. Sandbox

import { BasicVisitor, BasicRegistry, createConfigBuilder, FieldConfig, GroupConfig, GroupControl } from "uivm";

interface CustomGroupConfig extends GroupConfig<CustomConfigs, BasicRegistry>, FieldConfig<BasicRegistry> {
  type: "group";
}

interface TextConfig extends FieldConfig<BasicRegistry> {
  type: "text";
}

interface CheckboxConfig extends FieldConfig<BasicRegistry> {
  type: "checkbox";
}

type CustomConfigs = CustomGroupConfig | TextConfig | CheckboxConfig;

const config: CustomConfigs = {
  type: "group",
  name: "group",
  fields: [
    { type: "text", name: "firstName" },
    { type: "text", name: "lastName" },
    {
      type: "group",
      name: "group",
      fields: [
        { type: "text", name: "username" },
        {
          type: "text",
          name: "password",
          hints: {
            private: [{ name: "static", params: { value: true } }],
          },
        },
        { type: "checkbox", name: "rememberMe" },
      ],
    },
  ],
};

const visitor = new BasicVisitor<CustomConfigs, BasicRegistry>();
const bundler = createConfigBuilder<CustomConfigs, BasicRegistry, typeof visitor>(new BasicRegistry(), visitor);

const control = bundler<
  typeof config,
  GroupControl<{
    firstName: string;
    lastName: string;
    group: {
      username: string;
      password: string | null;
      rememberMe: boolean;
    };
  }>
>(config);
control.reset({
  firstName: "John",
  lastName: "Wick",
  group: {
    username: "[e-mail]",
    password: null,
    rememberMe: false,
  },
});

control.state$.subscribe(console.log);

Demo

https://cygnusroboticus.github.io/uivm

Building/Testing

• yarn build build everything
• yarn test run tests