1.0.2 • Published 4 months ago

@zw/remarklet v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Remarklet - JavaScript web page editor

CI npm version Downloads

Remarklet adds visual editing capabilities to any web page. This makes modifying and commenting on them remarkably easy!

Demo available at CodePen.

Features

  • Drag elements around the page
  • Resize elements
  • Edit text

Installation

This package can be installed with:

  • npm: npm install @zw/remarklet
  • yarn: yarn add @zw/remarklet
  • pnpm: pnpm add @zw/remarklet
  • unpkg: <script src="https://unpkg.com/@zw/remarklet/dist/remarklet.min.js"></script>
  • jsdelivr: <script src="https://cdn.jsdelivr.net/npm/@zw/remarklet/dist/remarklet.min.js"></script>

Example

To use Remarklet, you need to import the module in your JavaScript file:

import remarklet from "@zw/remarklet";

Then, you can activate or deactivate the features it provides:

import remarklet from "@zw/remarklet";
remarklet.activate();
// Now users can drag, resize, and edit elements on the page.
remarklet.deactivate();
// Now event handlers are unregistered and will be re-registered the next time remarklet.activate() is called.

CDN Example

<script src="https://unpkg.com/@zw/remarklet/dist/remarklet.min.js"></script>
<script>
    remarklet.activate();
    // Now users can drag, resize, and edit elements on the page.
    remarklet.deactivate();
    // Now event handlers are unregistered and will be re-registered the next time remarklet.activate() is called.
</script>

Feature Roadmap

  • Insert Note
  • Delete Elements
  • View Grid
  • Copy Elements
  • Export the edited page as an HTML file
  • Insert Image
  • Insert Code
  • Save
  • Restore

Copyright 2014-2025 Zachary Kendall Watkins zwatkins.it@gmail.com (https://zacharywatkins.com)

1.0.2

4 months ago

1.0.1

4 months ago

1.0.0

4 months ago