Introduction

InteractiveBlocks.js is a front-end javascript library allowing developers to easily create interactive components anywhere on their webpage. Currently, you can mount questions and score panels on your page using the pre-built components. You may also extend the library and use it as a "lightweight" React.

Please check out this quick start guide on what the library can do: https://blocks.jimmy-lan.com/#/quick-start/installation.

Documentation

Landing Page: https://blocks.jimmy-lan.com

API Docs: https://blocks.jimmy-lan.com/#/api-docs/base-classes/attribute-registry

Guides: https://blocks.jimmy-lan.com/#/guides/multiple-choice

Installation

InteractiveBlocks.js can be installed via npm or through a CDN. You may also save a copy of this library and include it using a script tag.

Installation Methods

Local

<script src="interactive-blocks.js"></script>

or

<script src="interactive-blocks.min.js"></script>

NPM

npm install interactive-blocks

CDN

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/interactive-blocks.min.js"></script>

Source Maps

Source maps are provided with the library. If you install InteractiveBlocks.js via npm or downloaded a local copy, you can find source map files in the folder dist.

You may also include a copy of the source map file for interactive-blocks.min.js via the following cdn:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/interactive-blocks.min.js.map"></script>

Type Definitions

InteractiveBlocks.js is written with Typescript. You can find a copy of the type definition files in the dist folder. Please start by looking at index.d.ts.

Local Compilation

You can compile the dist folder locally on your machine, by running the following commands.

One-time Build:

npm run build

Automatic Builds:

npm run dev

Credit

The design of some prebuilt components were inspired by Google's material design.

The arrow-right icon was taken from Google's Material Design Icons. Thanks to Google!

Note: InteractiveBlocks.js has no production dependencies.