File: orderless.el.html
This package provides an orderless completion style that divides
the pattern into components (space-separated by default), and
matches candidates that match all of the components in any order.
Completion styles are used as entries in the variables
completion-styles and completion-category-overrides, see their
documentation.
To use this completion style you can use the following minimal configuration:
(setq completion-styles '(orderless basic))
You can customize the orderless-component-separator to decide how
the input pattern is split into component regexps. The default
splits on spaces. You might want to add hyphens and slashes, for
example, to ease completion of symbols and file paths,
respectively.
Each component can match in any one of several matching styles:
literally, as a regexp, as an initialism, in the flex style, or as
word prefixes. It is easy to add new styles: they are functions
from strings to strings that map a component to a regexp to match
against. The variable orderless-matching-styles lists the
matching styles to be used for components, by default it allows
literal and regexp matching.
Defined variables (7)
orderless-affix-dispatch-alist | Alist associating characters to matching styles. |
orderless-component-separator | Component separators for orderless completion. |
orderless-expand-substring | Whether to perform literal substring expansion. |
orderless-match-faces | Vector of faces used (cyclically) for component matches. |
orderless-matching-styles | List of component matching styles. |
orderless-smart-case | Whether to use smart case. |
orderless-style-dispatchers | List of style dispatchers. |
Defined functions (23)
orderless--compile | (STRING TABLE PRED) |
orderless--compile-component | (COMPONENT INDEX TOTAL STYLES DISPATCHERS) |
orderless--dispatch | (DISPATCHERS DEFAULT STRING INDEX TOTAL) |
orderless--ignore-case-p | (REGEXPS) |
orderless--match-p | (PRED REGEXP STR) |
orderless--metadata | () |
orderless--predicate-and | (P Q) |
orderless--separated-by | (SEP RXS &optional BEFORE AFTER) |
orderless-all-completions | (STRING TABLE PRED POINT) |
orderless-annotation | (PRED REGEXP) |
orderless-define-completion-style | (NAME &optional DOCSTRING &rest CONFIGURATION) |
orderless-escapable-split-on-space | (STRING &optional SEP) |
orderless-filter | (STRING TABLE &optional PRED) |
orderless-flex | (COMPONENT) |
orderless-highlight-matches | (REGEXPS STRINGS) |
orderless-initialism | (COMPONENT) |
orderless-ivy-re-builder | (STR) |
orderless-literal-prefix | (COMPONENT) |
orderless-not | (PRED REGEXP) |
orderless-prefixes | (COMPONENT) |
orderless-regexp | (COMPONENT) |
orderless-try-completion | (STRING TABLE PRED POINT) |
orderless-without-literal | (COMPONENT) |
Defined faces (4)
orderless-match-face-0 | Face for matches of components numbered 0 mod 4. |
orderless-match-face-1 | Face for matches of components numbered 1 mod 4. |
orderless-match-face-2 | Face for matches of components numbered 2 mod 4. |
orderless-match-face-3 | Face for matches of components numbered 3 mod 4. |