Interface TwistyPlayerConfig

The config argument passed to TwistyPlayer when calling the constructor. This interface type be useful for avoiding bugs when you would like to create a TwistyPlayer using a dynamic config, or by combining configs.

import { TwistyPlayer, type TwistyPlayerConfig } from "cubing/twisty";

const MY_DEFAULT_CONFIG: TwistyPlayerConfig = {
  puzzle: "megaminx",
  alg: "R U R'"
};
export function createTwistyPlayer(overrideConfig: TwistyPlayerConfig) {
  const options = { ...MY_DEFAULT_CONFIG, ...overrideConfig };
  return new TwistyPlayer(options);
}

// Example: if the current page is https://alpha.twizzle.net/edit/?alg=M2+E2+S2
// then this gives us the "alg" param value "M2 E2 S2".
const myOverrideConfig: TwistyPlayerConfig = {};
const algParam = new URL(location.href).searchParams.get("alg");
if (algParam) {
  myOverrideConfig.alg = algParam;
}
createTwistyPlayer(myOverrideConfig);
Copy