Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 3.07 KB

README.md

File metadata and controls

82 lines (49 loc) · 3.07 KB
Raw

Visor logo Visor

Screenshot

What is Visor?

Visor is a simple admin overlay to get to the relevant areas of the Craft CMS control panel from the front-end of your site.

Demo

Visor Demo

Screengrab

Visor screengrab

Requirements

This plugin requires Craft CMS 3.1.20 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project

  2. Then tell Composer to load the plugin:

     composer require trendyminds/visor

  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Visor.

Keyboard Shortcuts

You can activate Visor by clicking the gear icon or using the following keyboard shortcuts:

Key Description
` Toggles Visor open or close
ESC Closes Visor (if open)

Customizing Visor

Overriding styles

Visor has a class of Visor--override on the outer <section> element. To change any of the default styles, simply start your styles with .Visor.Visor--override. This will make your styles more specific without resorting to !important madness.

Overriding icons

Visor also uses inline SVGs for all graphics. This:

  • Reduces HTTP requests
  • Looks crisp at any pixel density
  • Allows you to re-style the icons using fill in your CSS

Overriding background

If you'd prefer to replace purple with a different color you can change this by targeting .Visor--override .Visor__modal.

Caveats

Since 3.0 Visor offers support for full-page static caching. In order to offer this a network request is made on every page request to check if the user should see the Visor controls. To ensure this does not impact performance numerous things are done:

  1. The JavaScript to make this check is inserted at the bottom of the page
  2. The JavaScript used to make the check is very small (< 2 KB)
  3. Early returns are used if the user is a guest and should not see anything from Visor

The checks to ensure we return early for guests is documented entirely in DefaultController.php. If you see opportunities to improve the performance of these checks (or any other part of Visor) pull requests are welcomed.

Browser compatibility

This has been tested on Chrome, Firefox and Safari, but drop in an Issue if you notice any strangeness.

Contributing

We welcome anyone and everyone who would like to improve Visor to fork it and send in pull requests. To start developing Visor:

  1. Ensure you have Node version 10.x running on your machine
  2. Clone the repo to your computer
  3. Run npm i
  4. Run npm start to compile the CSS and JS into the main src/resources/ directory

Visor Changelog

View the changelog