PHPackages                             justinholtweb/craft-puppy - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. justinholtweb/craft-puppy

ActiveCraft-plugin

justinholtweb/craft-puppy
=========================

A lightweight Craft CMS 5 control panel companion that follows editors through their session, tracking visited pages, edits, and providing quick links back.

00JavaScript

Since Apr 6Pushed 1mo agoCompare

[ Source](https://github.com/justinholtweb/craft-puppy)[ Packagist](https://packagist.org/packages/justinholtweb/craft-puppy)[ RSS](/packages/justinholtweb-craft-puppy/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)DependenciesVersions (1)Used By (0)

Puppy for Craft CMS 5
=====================

[](#puppy-for-craft-cms-5)

A lightweight control panel companion that follows editors through their session. Puppy displays a draggable, collapsible overlay with a live trail of visited pages, edited elements, and quick links back to recently worked-on locations.

Requirements
------------

[](#requirements)

- Craft CMS 5.0 or later
- PHP 8.2 or later

Installation
------------

[](#installation)

Open your terminal and run:

```
composer require justinholtweb/craft-puppy
php craft plugin/install puppy
```

Or install via the Craft control panel under **Settings &gt; Plugins**.

Features
--------

[](#features)

### Session Trail

[](#session-trail)

Puppy records where you go in the control panel and normalizes routes into readable labels:

- `/admin/dashboard` → Dashboard
- `/admin/entries/blog` → Entries: Blog
- `/admin/entries/blog/123-spring-launch` → Spring Launch
- `/admin/assets/images` → Assets: Images
- `/admin/globals/footerSettings` → Global: Footer Settings

### Edit Tracking

[](#edit-tracking)

Puppy listens for element save events on the backend and records them separately from page visits. Each edit captures the element type, title, action (saved or created), and section/volume context.

### Floating Panel

[](#floating-panel)

The overlay sits on top of the control panel and includes:

- **Trail tab** — the last 25 pages visited, with clickable links back
- **Edits tab** — elements you saved or created during the session
- **Stats tab** — pages visited, items edited, and session duration

### Collapse and Drag

[](#collapse-and-drag)

- Collapse to a small badge showing the paw icon and item count
- Drag the panel anywhere on screen
- Position and state are remembered across page loads via localStorage

### Pause and Clear

[](#pause-and-clear)

- Pause tracking at any time without hiding the panel
- Clear the session trail to start fresh

How It Works
------------

[](#how-it-works)

**Frontend:** A JavaScript module loads on every CP page. It detects the current route, normalizes it into a human-readable label, and sends it to the plugin backend. The panel polls for updates every 10 seconds to pick up backend-recorded edits.

**Backend:** The plugin stores trail and edit data in the PHP session. Element save events are captured via Craft's `Element::EVENT_AFTER_SAVE` and recorded automatically. No database tables are created.

Storage
-------

[](#storage)

All data is stored in the PHP session and disappears when the session ends. UI preferences (panel position, collapsed state, active tab, paused state) are stored in the browser's localStorage.

Configuration
-------------

[](#configuration)

Puppy works out of the box with no configuration. Install and go.

Plugin Structure
----------------

[](#plugin-structure)

```
src/
├── Plugin.php                          # Registers asset bundle and event listeners
├── assetbundles/puppy/PuppyAsset.php   # Injects JS and CSS into the CP
├── controllers/SessionController.php   # Endpoints: get-trail, record-visit, clear
├── models/TrailItem.php                # Data model for trail and edit items
├── services/Trail.php                  # Session-based trail storage and normalization
└── resources/
    ├── js/puppy.js                     # Floating panel, drag, tabs, route parsing
    └── css/puppy.css                   # Panel styles

```

Roadmap
-------

[](#roadmap)

Phase 2:

- Pin favorite items during a session
- Search within the session trail
- Filter by viewed vs. edited
- Auto-group related pages

Phase 3:

- Team mode for admins to see active editors
- Handoff mode for sharing what you worked on
- Optional daily activity digest

License
-------

[](#license)

See [LICENSE.md](LICENSE.md).

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance60

Regular maintenance activity

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity11

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/035cb655c55af0e9e5b96754b80fd9703e195c32dbdfc49ae9a43ab9cf8db560?d=identicon)[justinholtweb](/maintainers/justinholtweb)

---

Top Contributors

[![justinholtweb](https://avatars.githubusercontent.com/u/295903?v=4)](https://github.com/justinholtweb "justinholtweb (5 commits)")

### Embed Badge

![Health badge](/badges/justinholtweb-craft-puppy/health.svg)

```
[![Health](https://phpackages.com/badges/justinholtweb-craft-puppy/health.svg)](https://phpackages.com/packages/justinholtweb-craft-puppy)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
