Skip to content

acerix/jrid

Repository files navigation

Jrid

A dynamic grid overlay for JavaScript.

NPM Version NPM Downloads Build Status Build Size Code Coverage Scrutinizer Code Quality Language Grade GPL 3.0

Install

yarn add jrid

Usage

Script Tags

<div id="jrid"></div>
<script src="https://unpkg.com/jrid"></script>
<script>
jrid.init(
  document.getElementById('jrid'),
  {
    locale: 'fr'
  }
)
</script>

Build System

import {Widget as Jrid} from 'jrid'

export default function App(): VNode {
  return (
    <Jrid />
  )
}

CodePen Demo

Screenshots

Screenshot of basic demo

Read the Docs

Documentation

CLI Commands

  • yarn install: Install dependencies
  • yarn dev: Test in browser, rebuilding when source files are changed
  • yarn lint --fix: Lint with ESLint
  • yarn test: Run tests
  • yarn doc: Build documentation
  • yarn build: Production build
  • yarn prepublish: Prepare for publishing
  • yarn publish: Publish to npm

Feedback

Sponsorship

About

Grid overlay for the Cartesian coordinate system.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published