PHPackages                             maestrodimateo/scramble-search - 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. [API Development](/categories/api)
4. /
5. maestrodimateo/scramble-search

ActiveLibrary[API Development](/categories/api)

maestrodimateo/scramble-search
==============================

Adds a keyboard-driven route search palette (Ctrl+K) to Scramble API docs

v1.3.0(2mo ago)254MITBladePHP ^8.2

Since Mar 7Pushed 2mo agoCompare

[ Source](https://github.com/maestrodimateo/scramble-search)[ Packagist](https://packagist.org/packages/maestrodimateo/scramble-search)[ Docs](https://github.com/maestrodimateo/scramble-search)[ RSS](/packages/maestrodimateo-scramble-search/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (5)Used By (0)

Scramble Search Palette
=======================

[](#scramble-search-palette)

A keyboard-driven route search palette for [Scramble](https://scramble.dedoc.co) API documentation.

Adds a `Ctrl+K` / `Cmd+K` shortcut that opens an instant search overlay to find and navigate to any API route — without touching Scramble's source code.

---

Features
--------

[](#features)

- **Instant search** across route path, HTTP method, summary and tag
- **Keyboard navigation** — `↑` `↓` to move, `Enter` to navigate, `Esc` to close
- **Color-coded method badges** — GET, POST, PUT, PATCH, DELETE
- **Term highlighting** in results
- **Dark mode** compatible
- **Zero dependencies** — vanilla JS + CSS injected into Scramble's view
- **No extra HTTP request** — reads the spec already embedded in the page

---

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

[](#requirements)

- PHP `^8.2`
- Laravel `^10|^11`
- `dedoc/scramble` (any version)

---

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

[](#installation)

```
composer require maestrodimateo/scramble-search
```

The service provider is auto-discovered by Laravel. No further configuration needed.

> **Note:** Do not publish Scramble's views (`vendor:publish --tag=scramble-views`). If you already have a published view at `resources/views/vendor/scramble/docs.blade.php`, remove it — this package provides its own.

---

Preview
-------

[](#preview)

[![Search palette closed — floating trigger button visible](art/capture-1.png)](art/capture-1.png)

[![Search palette open — filtering routes in real time](art/capture-2.png)](art/capture-2.png)

---

Usage
-----

[](#usage)

Open your Scramble documentation (default: `/docs/api`) and:

ActionResult`Ctrl+K` / `Cmd+K`Open the search paletteType anythingFilter by path, method, summary or tag`↑` / `↓`Navigate results`Enter`Jump to the selected route`Esc` or click outsideClose the paletteA floating **Search** button is also available in the bottom-right corner.

---

How it works
------------

[](#how-it-works)

`ScrambleSearchServiceProvider` prepends its `resources/views` directory to the `scramble` view namespace after all providers have booted. This means Laravel resolves `scramble::docs` from this package instead of Scramble's default, without modifying any vendor file.

The view is identical to Scramble's default (`docs.blade.php`) with two additions:

1. **CSS** — styles for the overlay, search box, result items and the trigger button
2. **JS** — reads `spec.paths` already injected by Scramble (`@json($spec)`), builds the route list and handles all interactions

---

License
-------

[](#license)

MIT

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance87

Actively maintained with recent releases

Popularity15

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Every ~0 days

Total

4

Last Release

64d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/92a2c64304e341345f2854b5bc9c43806b9e54f0b5b9b57135d37d69dd7c5c67?d=identicon)[mebalenoel](/maintainers/mebalenoel)

---

Top Contributors

[![maestrodimateo](https://avatars.githubusercontent.com/u/40523415?v=4)](https://github.com/maestrodimateo "maestrodimateo (6 commits)")

---

Tags

apisearchlaraveldocumentationopenapiscramble

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/maestrodimateo-scramble-search/health.svg)

```
[![Health](https://phpackages.com/badges/maestrodimateo-scramble-search/health.svg)](https://phpackages.com/packages/maestrodimateo-scramble-search)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[darkaonline/swagger-lume

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)[juststeveking/laravel-redoc

A simple API documentation package for Laravel using OpenAPI and Redoc

92289.9k1](/packages/juststeveking-laravel-redoc)

PHPackages © 2026

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