1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 17:30:04 +08:00
SpaceVim/docs/layers/foldsearch.md
2021-06-21 20:39:29 +08:00

51 lines
1.2 KiB
Markdown

---
title: "SpaceVim foldsearch layer"
description: "This layer provides functions that fold away lines that don't match a specific search pattern."
---
# [Available Layers](../) >> foldsearch
<!-- vim-markdown-toc GFM -->
- [Intro](#intro)
- [Install](#install)
- [Options](#options)
- [Key bindings](#key-bindings)
<!-- vim-markdown-toc -->
## Intro
This layer provides functions that fold away lines that don't match a specific search pattern.
The search pattern can be a word or a regular expression.
## Install
To use this layer, add it to your configuration file.
```toml
[[layers]]
name = "foldsearch"
```
This layer requires at least one search tool: `ag`, `rg`, `ack`, `pt` and `grep`, Choose your favorite one.
## Options
- foldsearch_highlight: a boolean option to enable/disabled highlight. Enabled by default. To disable the highlight:
```toml
[[layers]]
name = "foldsearch"
foldsearch_highlight = false
```
## Key bindings
| Key bindings | Description |
| ------------ | ----------------------------- |
| `SPC F w` | foldsearch input word |
| `SPC F W` | foldsearch cursor word |
| `SPC F p` | foldsearch regular expression |
| `SPC F e` | end foldsearch |