https://github.com/trendyminds/visor

🕶 A simple admin overlay to get to the relevant areas of the Craft CMS control panel.
https://github.com/trendyminds/visor

craft craft3 craftcms craftcms-plugin

Last synced: about 2 months ago
JSON representation

🕶 A simple admin overlay to get to the relevant areas of the Craft CMS control panel.

• Host: GitHub
• URL: https://github.com/trendyminds/visor
• Owner: trendyminds
• License: mit
• Created: 2016-09-12T17:20:01.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T02:57:35.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T05:29:45.320Z (9 months ago)
• Topics: craft, craft3, craftcms, craftcms-plugin
• Language: HTML
• Homepage: https://plugins.craftcms.com/visor
• Size: 2.35 MB
• Stars: 24
• Watchers: 10
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
#  Visor

![Screenshot](resources/promo.png)

## 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](resources/demo.gif)

### Screengrab

![Visor screengrab](resources/screengrab.png)

## 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 `` 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](https://github.com/trendyminds/visor/tree/master/src/controllers/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](https://github.com/trendyminds/visor/issues/new) 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:

0. Ensure you have Node version 10.x running on your machine

1. Clone the repo to your computer

2. Run `npm i`

3. Run `npm start` to compile the CSS and JS into the main `src/resources/` directory

## Visor Changelog

[View the changelog](https://github.com/trendyminds/visor/blob/master/CHANGELOG.md)