npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@togglhire/question-editor

v0.1.1

Published

This repository contains components that are used to edit questions.

Downloads

15

Readme

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.