All Projects → Ju99ernaut → grapesjs-rulers

Ju99ernaut / grapesjs-rulers

Licence: MIT License
Rulers and guides for grapesjs designer mode

Programming Languages

javascript
184084 projects - #8 most used programming language
HTML
75241 projects
SCSS
7915 projects

Projects that are alternatives of or similar to grapesjs-rulers

Guides
Here you will find Guides mainly for Sonarr/Radarr/Bazarr and everything related to it.
Stars: ✭ 207 (+885.71%)
Mutual labels:  guides
methods-guides
EGAP methods guides
Stars: ✭ 20 (-4.76%)
Mutual labels:  guides
PokemonRNGGuides
A repository of Pokemon RNG abuse guides
Stars: ✭ 62 (+195.24%)
Mutual labels:  guides
Tourguide.js
A simple, lightweight, clean and small library for creating guided product tours for your web app.
Stars: ✭ 231 (+1000%)
Mutual labels:  guides
awesome-backend
🚀 A curated and opinionated list of resources (English & Russian) for Backend developers | Структурированный список ресурсов для изучения Backend разработки
Stars: ✭ 826 (+3833.33%)
Mutual labels:  guides
docs
The documentation for Firefly III
Stars: ✭ 30 (+42.86%)
Mutual labels:  guides
Pharo Wiki
Wiki related to the Pharo programming language and environment.
Stars: ✭ 161 (+666.67%)
Mutual labels:  guides
Server-Creation-Tool
A Tool to easily create Server via SteamCMD
Stars: ✭ 33 (+57.14%)
Mutual labels:  guides
ficam-playbooks
The Federal Identity Credentials and Access Management program publishes guides and playbooks to help U.S. federal executive agencies implement, maintain, and modernize identity management systems.
Stars: ✭ 30 (+42.86%)
Mutual labels:  guides
Pangea-Docs
Get started with BITNATION and the Pangea Jurisdiction!
Stars: ✭ 46 (+119.05%)
Mutual labels:  guides
Lab
The Uberlab provides various tutorials - written by you! - on how to run software and tools on Uberspace 7.
Stars: ✭ 231 (+1000%)
Mutual labels:  guides
guides
Dealerdirect guides for getting things done, be a programming role-model, coding in style and being the better colleague.
Stars: ✭ 21 (+0%)
Mutual labels:  guides
pendo-mobile-ios
Pendo captures product usage data, gathers user feedback, and lets you communicate in-app to onboard, educate, and guide users to value
Stars: ✭ 31 (+47.62%)
Mutual labels:  guides
Awesome Powershell
A curated list of delightful PowerShell modules and resources
Stars: ✭ 2,967 (+14028.57%)
Mutual labels:  guides
plugin-grapesjs-builder
GrapesJS HTML and MJML integration for Mautic
Stars: ✭ 42 (+100%)
Mutual labels:  grapesjs-plugin
Guides
An organized list of guides and tutorials for design, development, and system administration.
Stars: ✭ 166 (+690.48%)
Mutual labels:  guides
meazure
Screen magnification, measurement, capture and color sampling for Windows.
Stars: ✭ 55 (+161.9%)
Mutual labels:  rulers
grapesjs-plugin-toolbox
Tools for grapesjs
Stars: ✭ 17 (-19.05%)
Mutual labels:  grapesjs-plugin
guides
How we do things at OK GROW!
Stars: ✭ 16 (-23.81%)
Mutual labels:  guides
Sketch-Guides
Quickly generate Guides for a selected element in Sketch
Stars: ✭ 74 (+252.38%)
Mutual labels:  guides

Grapesjs Rulers

Add rulers and guides for grapesjs designer mode

Screenshot

DEMO

HTML

<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet">
<link href="https://unpkg.com/grapesjs-rulers/dist/grapesjs-rulers.min.css" rel="stylesheet">
<script src="https://unpkg.com/grapesjs"></script>
<script src="https://unpkg.com/grapesjs-rulers"></script>

<div id="gjs"></div>

JS

const editor = grapesjs.init({
	container: '#gjs',
  height: '100%',
  fromElement: true,
  storageManager: false,
  plugins: ['grapesjs-rulers'],
});

CSS

body, html {
  margin: 0;
  height: 100%;
}

Summary

  • Plugin name: grapesjs-rulers
  • Commands
    • get-rulers-constructor
    • get-rulers - get rulers object
    • ruler-visibility - toggle ruler visibility
    • guides-visibility - toggle guides visibility
    • clear-guides
    • get-guides - get array of guides
    • set-guides - set guides from array e.g. editor.runCommand('set-guides', {guides: [...]})
    • set-zoom - sets zoom and updates rulers e.g. editor.runCommand('set-zoom', {zoom: 90})
    • destroy-ruler

Options

Option Description Default
dragMode Dragmode to set when rulers are toggled translate
rulerHeight Ruler thickness 15
canvasZoom Zoom out the canvas 94
rulerOpts Options for ruler object {}

Download

  • CDN
    • https://unpkg.com/grapesjs-rulers
  • NPM
    • npm i grapesjs-rulers
  • GIT
    • git clone https://github.com/Ju99ernaut/grapesjs-rulers.git

Usage

Directly in the browser

<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<link href="https://unpkg.com/grapesjs-rulers/dist/grapesjs-rulers.min.css" rel="stylesheet">
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-rulers.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
      container: '#gjs',
      // ...
      plugins: ['grapesjs-rulers'],
      pluginsOpts: {
        'grapesjs-rulers': { /* options */ }
      }
  });
</script>

Modern javascript

import grapesjs from 'grapesjs';
import plugin from 'grapesjs-rulers';
import 'grapesjs/dist/css/grapes.min.css';
import 'grapesjs-rulers/dist/grapesjs-rulers.min.css'

const editor = grapesjs.init({
  container : '#gjs',
  // ...
  plugins: [plugin],
  pluginsOpts: {
    [plugin]: { /* options */ }
  }
  // or
  plugins: [
    editor => plugin(editor, { /* options */ }),
  ],
});

Adding rulers toggle as panel button example

const pn = editor.Panels;
const panelViews = pn.addPanel({
  id: 'options'
});
panelViews.get('buttons').add([{
  attributes: {
    title: 'Toggle Rulers'
  },
  context: 'toggle-rulers', //prevents rulers from being toggled when another views-panel button is clicked 
  label: `<svg width="18" viewBox="0 0 16 16"><path d="M0 8a.5.5 0 0 1 .5-.5h15a.5.5 0 0 1 0 1H.5A.5.5 0 0 1 0 8z"/><path d="M4 3h8a1 1 0 0 1 1 1v2.5h1V4a2 2 0 0 0-2-2H4a2 2 0 0 0-2 2v2.5h1V4a1 1 0 0 1 1-1zM3 9.5H2V12a2 2 0 0 0 2 2h8a2 2 0 0 0 2-2V9.5h-1V12a1 1 0 0 1-1 1H4a1 1 0 0 1-1-1V9.5z"/></svg>`,
  command: 'ruler-visibility',
  id: 'ruler-visibility'
}]);

Disable rulers on preview

editor.on('run:preview', () => editor.stopCommand('ruler-visibility'));

Development

Clone the repository

$ git clone https://github.com/Ju99ernaut/grapesjs-rulers.git
$ cd grapesjs-rulers

Install dependencies

$ npm i

Build css

$ npm run build:css

Start the dev server

$ npm start

Build the source

$ npm run build

License

MIT

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].