Skip to content

Latest commit

 

History

History
122 lines (85 loc) · 3.05 KB

README.md

File metadata and controls

122 lines (85 loc) · 3.05 KB
Raw

scribby

scribby is a javascript library which lets users draw simple "scribbles" on a web page.

Objectives

  • svg-based, smooth/natural drawing

  • simple/intuitive (non-existent) interface

  • json representation

  • localStorage and (experimental) rest-based persistence

  • lightweight, no dependencies

Components

The main functionality is in scribby.js, which handles the drawing on an svg dom element. Also included is notey.js which presents a simple post-it note-like object on a webpage, as an example application using scribby.js. Utility functionality is found in draggy.js and resty.js (but these are only needed for the Notey app).

Embeddable svg file

There is also a scribby-embed.svg file that can simply be inserted into a page as an HTML Object, such as:

<object data="scribby-embed.svg"></object>

Usage examples

Draw on svg

Using scribby to enable drawing on an svg element:

var svgEl = document.getElementById('svg');
var scr = new Scribby(svgEl);
scr.setAttrStroke('blue');
scr.setAttrStrokeWidth(4);
 ...
scr.undo();
scr.redo();
scr.reset();

var keep = scr.toJson();
var dup = new Scribby(svgEl2, keep);

svg element

Notey usage

Using notey to put a note on a page (which uses scribby for its contents):

var note = new Notey();
note.attachToBody();
note.save();

note and active note (mouseover)

Using scribby-embed.svg

Self-contained, simple, one-line usage. (May be used multiple times on a single page.)

   <object data="scribby-embed.svg" id="my-id" style="width: 300px; height: 200px;"></object>

Misc.

Typical json representation of a note:

{
    "id": "7654b53b-a087-45f7-8163-46e96081fca7",
    "version": "1.0b",
    "dateCreated": "2020-06-14T08:19:04.927Z",
    "dateModified": "2020-06-14T08:19:11.316Z",
    "dateSaved": "2020-06-14T08:19:11.316Z",
    "dateSynced": "2020-06-14T08:19:04.930Z",
    "bgColorId": 1,
    "bgColor": "#FE8",
    "strokeColorId": 0,
    "strokeColor": "#000",
    "width": 167,
    "height": 167,
    "x": 876,
    "y": 353,
    "scribby": {
        "version": "1.0b",
        "dateCreated": "2020-06-14T08:19:04.928Z",
        "dateModified": "2020-06-14T08:19:11.316Z",
        "svg": {
            "width": 167,
            "height": 167,
            "content": "<path fill=\"none\" stroke=\"#000\" stroke-width=\"2\" stroke-linecap=\"round\" d=\"M57 69 L56.66 69 L56.2 69 [...] 135.75 L98.87 136.87 L98.37 137.87 L97.87 138.87 L97.37 139.75 L96.87 140.62 L96.5 141.5 L96.16 142.5 L96 143.5 L96 144.5\"></path>"
        },
        "strokeWidth": 2,
        "bufferSize": 8
    }
}

Demo

Try it out.

Future development

Possible features and improvements.... though these may go against the objective of simplified usage!

  • multi-touch & pressure support
  • better configuration via constructor
  • generalize (or plugin?) rest support
  • scaling / re-sizing
  • sharing (live), see also:
  • multi-user (as "layers")