@togglhire/question-editor

Question editor components

This repository contains components that are used to edit questions.

The components are using React and Emotion for styling.

Installation

yarn add @togglhire/question-editor

This package has peer dependencies, so make sure that react, react-dom and react-beautiful-dnd are installed as well.

Usage

All editor components use the OptionsState type to manage their state. This type contains all question options, together with their contents, weights and points.

To create the state, use the createOptionsState function. It takes an array of question options and returns a new state. To create an empty state, use emptyOptionsState.

const state = createOptionsState([
  { id: "100", content: "First option", weight: 0, points: 1 },
  { id: "101", content: "Second option", weight: 2, points: 0 },
]);

const empty = emptyOptionsState();

To transform the state back to options, use getOptions. Any option that has been added will have its id set to null.

const options = getOptions(state);

If you expect only one option (for example with numeric questions), you can use the getSingleOptionContent to get the content of the first options.

const content = getSingleOptionContent(state);

Numeric answer editor

The NumericAnswerEditor component renders a simple numeric input for editing the correct answer for number input questions.

import {
  NumericAnswerEditor,
  OptionsState,
  createOptionsState,
  getSingleOptionContent,
} from "@togglhire/question-editor";

const Editor = () => {
  const [state, setState] = React.useState<OptionsState>(
    createOptionsState([{ id: "100", content: "123", weight: 0, points: 1 }])
  );

  return (
    <div>
      <NumericAnswerEditor state={state} onChange={setState} />
      Current value is {getSingleOptionContent(state)}
    </div>
  );
};

Choice answer editor

You can use the ChoiceAnswerEditor component to edit options of any choice question (single choice, multiple choice, picture). The type prop specifies the type of the question. The uploadImage prop needs to be passed a function that accepts a File and returns a promise for the URL of the uploaded image. The id prop should be set to a unique value, because it is used to identify options during dragging.

The whole component needs to be inside a DragDropContext from react-beautiful-dnd. You can use the getMovedOption and handleMovedOption functions in the onDragEnd handler of DragDropContext.

import {
  ChoiceAnswerEditor,
  OptionsState,
  createOptionsState,
  getSingleOptionContent,
  getOptions,
} from "@togglhire/question-editor";

const Editor = () => {
  const [state, setState] = React.useState<OptionsState>(
    createOptionsState([
      { id: "100", content: "First option", weight: 0, points: 1 },
      { id: "101", content: "Second option", weight: 1, points: 0 },
    ])
  );

  const uploadImage = (file: File) => Promise.resolve("http://example.com");

  return (
    <div>
      <ChoiceAnswerEditor
        id="200"
        type="picture"
        uploadImage={uploadImage}
        state={state}
        onChange={setState}
      />
      Current options: {getOptions(state)
        .map((option) => option.content)
        .join(", ")}
    </div>
  );
};

Development

This project uses Storybook. You can start it with yarn start.

Publishing to npm

This project uses semantic versioning:

• If a bug is fixed without changing any component props, bump the patch version.
• If you add props to a component or add new components, bump the minor version.
• If you remove or change props in a component or remove components, bump the major version.

Source files are automatically compiled to JavaScript before publishing to npm, so simply running npm publish --access public should work.

The build script does two things:

1. Compiles TypeScript files with Babel to JavaScript. It is easier to use Babel instead of TypeScript compiler as the Emotion Babel plugin must be used to process CSS-in-JS.
2. Generates TypeScript definition files with the TypeScript compiler, so that the package can be used in TypeScript apps without losing type information.