Download the PHP package pxlrbt/filament-spotlight without Composer

On this page you can find all versions of the php package pxlrbt/filament-spotlight. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of pxlrbt/filament-spotlight

Informations about the package filament-spotlight

![header](./.github/resources/pxlrbt-spotlight.png)

Filament Spotlight

[![Latest Version on Packagist](https://img.shields.io/packagist/v/pxlrbt/filament-spotlight.svg?include_prereleases)](https://packagist.org/packages/pxlrbt/filament-spotlight) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/pxlrbt/filament-spotlight/code-style.yml?branch=main&label=Code%20style&style=flat-square) [![Total Downloads](https://img.shields.io/packagist/dt/pxlrbt/filament-spotlight.svg)](https://packagist.org/packages/pxlrbt/filament-spotlight)

Quickly navigate your Filament Resources with Spotlight functionality.

Supports pages, resources and links from the user menu.

https://user-images.githubusercontent.com/22632550/159757479-ca9c3f46-7638-4889-98ba-6164e5205509.mp4

Installation

Plugin Version Filament Version PHP Version
0.x 2.x > 8.0
1.x 3.x > 8.1
2.x 3.x, 4.x > 8.1

Upgrade guide for Filament v4

From v2 onwards you will need a Custom Theme to include the Tailwind classes for the Spotlight component. See note below.

Styles

To include the Tailwind classes that are used in the Spotlight component, you need to create a Custom Theme and include the following line:

Plugin registration

To use this plugin register it in your panel configuration:

Usage

There is no configuration needed.

"its genius"

  – Dan Harrin

To open the Spotlight input bar you can use one of the following shortcuts:

CTRL + K
CMD + K
CTRL + /
CMD + /

Setup

This plugin relies on the same properties and methods used for Filament's global search. For records showing up with the correct name in "Edit/View" you need to set $recordTitleAttribute. Check the docs for more information

Excluding pages

If you need to exclude a page from the spotlight results you may do so by adding a static shouldRegisterSpotlight method to the page and return false:

This can be useful when you have pages that require URL parameters.

Translation

To translate or edit the default placeholder, you have to publish the translation file for wire-element/spotlight:

Contributing

If you want to contribute to this packages, you may want to test it in a real Filament project:

Install the packages in your app's composer.json:

Now, run composer update.

Credits

All versions of filament-spotlight with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
filament/filament Version ^3.0|^4.0
wire-elements/spotlight Version ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package pxlrbt/filament-spotlight contains the following files

Loading the files please wait ....