Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/revertit/mybb-rt_livesearch

RT LiveSearch Is a plugin which utilizes native MyBB search functionality and provides result via ajax. Very light and highly customizable plugin for your search queries.
https://github.com/revertit/mybb-rt_livesearch

ajax fetch-api javascript mybb mybb-plugin php

Last synced: 5 days ago
JSON representation

RT LiveSearch Is a plugin which utilizes native MyBB search functionality and provides result via ajax. Very light and highly customizable plugin for your search queries.

Host: GitHub
URL: https://github.com/revertit/mybb-rt_livesearch
Owner: RevertIT
License: mit
Created: 2023-04-08T20:13:23.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-12T23:39:17.000Z (9 months ago)
Last Synced: 2024-10-12T06:21:07.303Z (about 1 month ago)
Topics: ajax, fetch-api, javascript, mybb, mybb-plugin, php
Language: PHP
Homepage:
Size: 59.6 KB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ## RT LiveSearch

Is a plugin which utilizes native MyBB search functionality and provides result via ajax.

Very light and highly customizable plugin for your search queries.

### Table of contents

1. [❗ Dependencies](#-dependencies)

2. [📃 Features](#-features)

3. [➕ Installation](#-installation)

4. [🔼 Update](#-update)

5. [➖ Removal](#-removal)

6. [❔ How-to: Add custom search box](#-how-to-add-custom-search-box)

7. [💡 Feature request](#-feature-request)

8. [🙏 Questions](#-questions)

9. [🐞 Bug reports](#-bug-reports)

8. [📷 Preview](#-preview)

### ❗ Dependencies

- MyBB 1.8.x

- https://github.com/frostschutz/MyBB-PluginLibrary (>= 13)

- PHP >= 8.0

### 📃 Features

- Ajax search with native MyBB search function.

- **ZERO** additional database queries!

- **KeyPress search**: Bind key (default "S") on your keyboard to open search popup modal at any time while not typing.

- **CustomAjaxSearch**: Attach ajax search on any HTML form you wish! Ref: [How-to: Add custom search box](#how-to-add-custom-search-box) 

- **Detailed search statistics**:

  - Provides a graph with detailed data for search queries on the forum

    - Total ajax/normal search queries

    - Total ajax search queries

    - Total normal search queries

  - Search type graphs (Threads / Posts)

    - Total ajax/normal search types (24 hrs)

    - Total ajax search types (24 hrs)

    - Total normal search types (24 hrs)

  - Search stats by users (See which users use search function the most and how many queries)

    - Total ajax/normal search queries by users (24 hrs)

    - Total ajax search queries by users (24 hrs)

    - Total normal search queries by users (24 hrs)

  - Most searched keywords

    - Most searched keywords via ajax/normal search queries (24 hrs)

    - Most searched keywords via ajax search queries (24 hrs)

    - Most searched keywords via normal search queries (24 hrs)

- **Search history**:

  - View all search history data from user

  - Sort your search via username, and from selected forum

- Replace/Revert MyBB quick search with ajax search via settings.

- **Organized templates**

- Easy to use configuration and settings.

### ➕ Installation

1. Copy the directories from the plugin inside your root MyBB installation.

2. Settings for the plugin are located in the "Plugin Settings" tab. (`/admin/index.php?module=config-settings`)

### 🔼 Update

1. Deactivate the plugin.

2. Replace the plugin files with the new files.

3. Activate the plugin again.

### ➖ Removal

1. Uninstall the plugin from your plugin manager.

2. _Optional:_ Delete all the RT LiveSearch plugin files from your MyBB folder.

### ❔ How-to: Add custom search box

This is a minimal configuration needed for form to fire up ajax

You can replace `custom_ajax*` with any other class

```smarty



  

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

  



LiveSearch.searchInput('.custom_ajax', {$mybb->settings['rt_livesearch_keypress_timeout']});

```

### 💡 Feature request

Open a new idea by [clicking here](https://github.com/RevertIT/mybb-rt_livesearch/discussions/new?category=ideas)

### 🙏 Questions

Open a new question by [clicking here](https://github.com/RevertIT/mybb-rt_livesearch/discussions/new?category=q-a)

### 🐞 Bug reports

Open a new bug report by [clicking here](https://github.com/RevertIT/mybb-rt_livesearch/issues/new)

### 📷 Preview