-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
94 lines (65 loc) · 3.39 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
=== Search Modal Block ===
Contributors: philhoyt
Tags: block, search, modal, search form, popup search
Requires at least: 6.1
Tested up to: 6.7
Stable tag: 1.0.1
Requires PHP: 7.4
License: GPL-2.0-or-later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
A customizable search modal block that adds an elegant and accessible search experience to your WordPress site.
== Description ==
The Search Modal Block enhances your WordPress site with a modern, popup search interface that's both beautiful and functional. Built specifically for the block editor (Gutenberg), it provides a seamless way to add search functionality to any part of your content.
**Key Features:**
* Clean, minimal design that works with any theme
* Fully responsive layout
* Accessibility-ready with ARIA labels and keyboard navigation
* Customizable text elements:
* Search input placeholder
* Search button text
* Screen reader labels
* Focus-visible support for better keyboard navigation
* Seamless integration with WordPress search
**Perfect For:**
* Minimalist themes needing an elegant search solution
* Sites wanting to improve their search UX
* Accessibility-focused websites
* Any WordPress site using the block editor
== Installation ==
1. Upload the plugin files to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.
3. Go to the block editor and search for "Search Modal Block" in the block inserter to add it to your content.
== Frequently Asked Questions ==
= How do I customize the search button appearance? =
The search button inherits your theme's colors by default. You can customize its appearance using your theme's custom CSS or the WordPress site editor.
== Screenshots ==
1. The search modal block in the block editor with customizable settings.
2. The search modal displayed on the frontend after being triggered by the search icon.
== Development ==
This block is built using the WordPress Create Block tool, ensuring compatibility with modern WordPress standards and practices. The source code is available in the plugin's `/src` directory.
= Building from Source =
To build the plugin from source:
1. Clone the repository
2. Install dependencies with `npm install`
3. Run `npm run build` to build the production files
4. For development, use `npm run start` to start the development server
The build process uses @wordpress/scripts to compile and minify the JavaScript and CSS files. The source code for the compiled files in the `/build` directory can be found in the `/src` directory.
= Development Dependencies =
* @wordpress/scripts: ^27.9.0
* @wordpress/eslint-plugin: ^21.4.0
* @wordpress/stylelint-config: ^21.41.0
* eslint: ^8.57.1
The complete source code is available on GitHub: https://github.com/philhoyt/search-modal-block
== Changelog ==
= 1.0.1 =
* Include assets for .org
* Include src for .org
= 1.0.0 =
* Initial release with search modal block functionality
* Customizable placeholder text, button text, and label text
* Responsive and accessible design
* Integration with WordPress search functionality
* Focus-visible support for enhanced keyboard navigation
== Credits ==
This plugin uses the following third-party libraries:
* [MicroModal](https://micromodal.vercel.app/) - A lightweight, configurable modal library for web applications.