# ckeditor5-find-replace

> Find and Replace plugin for CKEditor 5.

Latest version **0.3.1** (published 2021-06-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install ckeditor5-find-replace
pnpm add ckeditor5-find-replace
yarn add ckeditor5-find-replace
bun add ckeditor5-find-replace
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2021-06-09 |
| First published | 2020-12-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 0 |
| Unpacked size | 28.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Antonio Lucas Neres |
| Maintainers | antoniolucas |
| Keywords | ckeditor, ckeditor5, ckeditor 5, ckeditor5-feature, ckeditor5-plugin, find, search, replace |

## Links

- npm: https://www.npmjs.com/package/ckeditor5-find-replace
- Repository: https://github.com/antoniolucasnobar/ckeditor5-find-replace
- Issues: https://github.com/antoniolucasnobar/ckeditor5-find-replace/issues
- npm.io page: https://npm.io/package/ckeditor5-find-replace

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.3.1 (latest) — 2021-06-09
- 0.3.0 — 2021-04-21
- 0.2.1 — 2021-04-16
- 0.2.0 — 2021-04-14
- 0.1.1 — 2020-12-10
- 0.1.0 — 2020-12-10
- 0.0.3 — 2020-12-09

## README

CKEditor 5 Find and Replace feature
============================

This plugin implements Find and Replace Text in CKEditor 5.

Features:
- forward and backwards search (with visual and text indications of progress)
- replace one (also forward and backwards) or all occurrences 
- accessible (keyboard operation)
- use out of the editor (by execute findReplace command)
- Match case: you decide if upper or lower case matters
- selected text gets copied over to the find field

We need translators! If you want to translate to your language, open a PR! Supported so far:
- pt-BR
- en-US
- zh-CN (Thanks @YueHui)

## Installation
```shell script
$ npm install ckeditor5-find-replace
```

To use it, configure your build like this

```javascript
import FindReplace from 'ckeditor5-find-replace/src/findReplace';

// it can be any CKEditor editor. Decoupled is just an example
DecoupledEditor.builtinPlugins = [
//...
	FindReplace,
]
//...
	toolbar: {
		items: [
			'FindReplace'
        ]
    }
```

```javascript
// you can use this feature programatically also:
editor.execute('findReplace', {
    // text to find
    findText: '',
    // find prev or next , -1:prev,0:stay,1:next
    increment: 1 ,
    // text to replace
    replaceText: '',
    // is replaceAll
    replaceAll: false,
    // lower or upper case letters matters? 
    matchCase: false
})
```


Images of plugin:

![Plugin](docs/plugin.png)

![Selected Text](docs/selected-text.png)

![Search in action](docs/search.png)

![replace](docs/replace-all.png)

![Not found](docs/not-found.png)

## License

MIT

---
_Source: https://npm.io/package/ckeditor5-find-replace · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._