Module filter

This module provides more features than Backdrop core where the modules list
page includes a filter input search.

This module provides a method for filtering modules on the modules page as well
as for filtering projects on the update status report, and an enhanced filter on
the user permissions page.

The supplied filter is simpler than using your browsers find feature which
searches the entire page. The provided filter will filter modules/projects that
meet your input.

On the modules page, plain text you type into the filter is matched against
the module name, description, package, and tags; a module is shown if any of
those fields contain your search text.

Some module names may coincide with words commonly found in descriptions and to
narrow the filtered results to a specific module may require entering a term
related to the machine name of the module, e.g. module_ will narrow results to
module_filter.

To search a single field instead of all of them, prefix your search text with
the field name and a colon:

• description:spam matches only the description text.
• requires:token matches only modules that require modules with this term.
• requiredBy:views matches only modules that are required by modules with this term.

You can combine multiple terms, separated by spaces, e.g. token requires:views
matches modules with "token" in their name, description, or tags, or that
require the Views module. A module is shown if it matches any one of the
terms (not all of them).

Along with the filter textfield there are additional checkboxes that help to
narrow the search more. The modules page contains four checkboxes: Enabled,
Disabled, Required, and Unavailable. While the first two are self-explanatory,
the latter two can take an explanation. The Required checkbox affects visibility
of modules that are enabled and have other module(s) that require it also
enabled. The Unavailable checkbox affects visibility of modules that are
disabled and depend on module(s) that are missing.

The update status report filter also contains four checkboxes: Up-to-Date,
Update available, Security update, and Unknown. These directly affect the
visibility of each project; whether it is up-to-date, there is an update
available, a security update is available, or the status is unknown.

Requirements

This module has no additional requirements.

Installation

• Install this module using the official Backdrop CMS instructions at
  https://backdropcms.org/guide/modules.

• Visit the configuration page under Administration > Configuration > User
  Interface > Module Filter (admin/config/user-interface/modulefilter) to
  configure to taste.

Tabs

By default Module Filter alters the modules page into tabs (Can be disabled on
configuration page). In the tabs view, each package is converted to a vertical
tab rather than a fieldset which greatly increases the ability to browse them.

There are several benefits to using the tabs view over the standard view for
the modules page. I've listed the key benefits below as well as additional
information that pertains to each.

1. The increased ease of browsing between packages.

2. Allows all modules to be listed alphabetically outside of their package,
   making it all the easier to find the module by name rather than package it
   happens to be in.

3. The operations for a module are moved within the description column giving
   the description more "elbow room".

4. Filtering is restricted to within the active tab or globally when no tab is
   selected. By default no tab is selected which will list all modules. When a
   tab is active and you want to get back to the 'all' state click on the
   active tab to deselect it.

5. The number of enabled modules per tab is shown on the active tab. (Can be
   disabled on configuration page)

6. Nice visual aids become available showing what modules are to be
   enabled/disabled and the number of matching modules in each tab when
   filtering. (Can be disabled on configuration page)

7. The save configuration button becomes more accessible, either staying at
   the bottom of the window when the tabs exceed past the bottom and at the
   top when scrolling past the tabs. (Can be disabled on configuration page)

8. When filtering, tabs that do not contain matches can be hidden. (Can be
   enabled on configuration page)

9. Tab states are remembered like individual pages allowing you to move
   forward and backward within your selections via your browsers
   forward/backward buttons.

10. When viewing all modules (no active tab) and mousing over modules it's tab
    becomes highlighted to signify which tab it belongs to.

Filter operators

The modules page's filter has three filter operators available. Filter
operators allow alternative filtering techniques. A filter operator is applied
by typing within the filter textfield 'operator:' (where operator is the
operator type) followed immediately with the string to pass to the operator
function (e.g. 'requires:block'). The available operators are:

description:
Filter based on a module's description.

requiredBy:
Filter based on what a module is required by.

requires:
Filter based on what a module requires.

Multiple filters (or queries) can be applied by space delimiting. For example,
the filter string 'token requires:views' would filter down to modules with
"token" in the description and "views" in the requires field. To pass a
space within a single query wrap it within double quotes (e.g. 'requires:"meta
views"' or '"bulk export"').

Mobile devices

On mobile devices and narrow screens the Tabs are not displayed, the dynamic
Save configuration button becomes static and a separate version column is not
displayed, regardless of settings. These elements are present on wider displays.

Documentation

Additional documentation is located in the Wiki:
https://github.com/backdrop-contrib/module_filter/wiki/Documentation.

Issues

Bugs and Feature requests should be reported in the Issue Queue:
https://github.com/backdrop-contrib/module_filter/issues.

Current Maintainers

• John Franklin.
• izmeez - Assisted-by: LLM agent.
• Seeking additional maintainers.

Credits

• Ported to Backdrop CMS by John Franklin.
• Originally written for Drupal by James Jeffery.

License

This project is GPL v2 software.
See the LICENSE.txt file in this directory for complete text.