# eddies
> Fully featured, modern and extensible editor
Latest version **1.1.1** (published 2024-07-12) · 0 weekly downloads
## Install
```sh
npm install eddies
pnpm add eddies
yarn add eddies
bun add eddies
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.1 |
| Published | 2024-07-12 |
| First published | 2024-01-01 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 23 |
| Unpacked size | 204.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 12 |
| Author | malezjaa |
| Maintainers | malezjaa |
| Keywords | editor, markdown, html, tiptap, typescript |
## Links
- npm: https://www.npmjs.com/package/eddies
- Repository: https://github.com/malezjaa/eddies
- Homepage: https://malezjaa.github.io/eddies/
- Issues: https://github.com/malezjaa/eddies/issues
- npm.io page: https://npm.io/package/eddies
## Dependencies (23)
- [clsx](https://npm.io/package/clsx.md) ^2.1.0
- [tippy.js](https://npm.io/package/tippy.js.md) ^6.3.7
- [@tiptap/pm](https://npm.io/package/@tiptap/pm.md) ^2.1.13
- [@tiptap/core](https://npm.io/package/@tiptap/core.md) ^2.1.13
- [lucide-react](https://npm.io/package/lucide-react.md) ^0.303.0
- [@tiptap/react](https://npm.io/package/@tiptap/react.md) ^2.1.13
- [tailwind-merge](https://npm.io/package/tailwind-merge.md) ^2.2.0
- [tiptap-markdown](https://npm.io/package/tiptap-markdown.md) ^0.8.8
- [@eddieseditor/core](https://npm.io/package/@eddieseditor/core.md) 1.1.0
- [@tiptap/suggestion](https://npm.io/package/@tiptap/suggestion.md) ^2.1.16
- [@tiptap/starter-kit](https://npm.io/package/@tiptap/starter-kit.md) ^2.1.13
- [tailwindcss-animate](https://npm.io/package/tailwindcss-animate.md) ^1.0.7
- [@tiptap/extension-link](https://npm.io/package/@tiptap/extension-link.md) ^2.1.13
- [@radix-ui/react-popover](https://npm.io/package/@radix-ui/react-popover.md) ^1.0.7
- [@tiptap/extension-image](https://npm.io/package/@tiptap/extension-image.md) ^2.1.13
- [class-variance-authority](https://npm.io/package/class-variance-authority.md) ^0.7.0
- [@tiptap/extension-highlight](https://npm.io/package/@tiptap/extension-highlight.md) ^2.1.13
- [@tiptap/extension-task-item](https://npm.io/package/@tiptap/extension-task-item.md) ^2.1.13
- [@tiptap/extension-task-list](https://npm.io/package/@tiptap/extension-task-list.md) ^2.1.13
- [@tiptap/extension-text-align](https://npm.io/package/@tiptap/extension-text-align.md) ^2.1.13
- [@tiptap/extension-text-style](https://npm.io/package/@tiptap/extension-text-style.md) ^2.1.13
- [@tiptap/extension-placeholder](https://npm.io/package/@tiptap/extension-placeholder.md) ^2.1.13
- [@tiptap/extension-character-count](https://npm.io/package/@tiptap/extension-character-count.md) ^2.1.13
## Alternatives
- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads
## Recent versions
- 1.1.1 (latest) — 2024-07-12
- 1.1.0 — 2024-07-12
- 1.0.12 — 2024-01-28
- 1.0.11 — 2024-01-27
- 1.0.11-0 — 2024-01-26
- 1.0.10 — 2024-01-26
- 1.0.8 — 2024-01-26
- 1.0.7 — 2024-01-26
- 1.0.6 — 2024-01-25
- 1.0.5 — 2024-01-24
- 1.0.4 — 2024-01-18
- 1.0.2 — 2024-01-17
- 1.0.0 — 2024-01-17
- 0.0.9 — 2024-01-03
- 0.0.8 — 2024-01-02
- … 7 more at https://npm.io/package/eddies/versions
## README
Eddies
Fully featured, modern and extensible editor
## Quick start
```bash
pnpm install eddies
```
## Why Eddies?
The reason to use Eddies is very easy implementation. For those who don't want to build the whole editor from scratch, Eddies allows you to use editor with one line of code. Eddies has support for different types of markup (bold, italic, underline, etc.), also has visual components that make writing easier (bubble menu, text counter, etc.) and extensions (syntax highlighting, emojis). You can style the editor very easily with css variables or classes.
## Using editor:
```tsx
import { Editor } from "eddies";
export default function Page() {
return (
);
}
```
## Props
| Prop | Type | Description |
| --------------------- | ----------------------------------------- | ----------------------------------------------- |
| `className?` | `string` | The class name to use for the editor. |
| `theme?` | `"light" \| "dark"` | Defines the editor's theme. |
| `showCharacterCount?` | `boolean` | Show character count. |
| `limit?` | `number` | The limit of characters. |
| `menu?` | `boolean` | Shows menu above the editor. |
| `bubbleMenuItems?` | `BubbleMenuItem[]` | Items that will be displayed in bubble menu. |
| `slashMenuCommands?` | `SlashCommandItem[]` | Slash menu commands. |
| `onReady?` | `(editor: EddiesEditor) => void` | Triggered when the editor is ready. |
| `onContentChange?` | `(editor: EddiesEditor) => void` | Triggered on every content change. |
| `initialValue?` | `Content` | Content shown every time the editor is created. |
| `extensions` | `Extensions` | Extensions to add to the editor. |
| `placeholder?` | `PlaceholderOptions` | The placeholder text when the editor is empty. |
| `isEditable?` | `boolean` | Disables the editor. |
| `autofocus?` | `FocusPosition` | Auto focus settings |
| `keyboardShortcuts?` | `Record` | Custom keyboard shortcuts. |
| `tiptapOptions?` | `Partial` | Editor props to pass to the editor. |
[MIT][license] © [malezjaa][author]
Logo by [iconixar](https://www.flaticon.com/authors/iconixar)
[license]: license
[author]: https://github.com/malezjaa
---
_Source: https://npm.io/package/eddies · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._