https://github.com/malezjaa/eddies
Fully featured, modern and extensible editor. Preview: https://eddies-web.vercel.app/
https://github.com/malezjaa/eddies
eddies editor extensions html markdown markdown-editor tiptap
Last synced: about 1 month ago
JSON representation
Fully featured, modern and extensible editor. Preview: https://eddies-web.vercel.app/
- Host: GitHub
- URL: https://github.com/malezjaa/eddies
- Owner: malezjaa
- License: mit
- Created: 2023-12-30T20:47:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-12T12:29:41.000Z (11 months ago)
- Last Synced: 2025-04-18T04:36:22.297Z (2 months ago)
- Topics: eddies, editor, extensions, html, markdown, markdown-editor, tiptap
- Language: TypeScript
- Homepage: https://malezjaa.github.io/eddies/
- Size: 986 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Eddies
## 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. |
## Contributing
Pull requests and stars are always welcome. See [`contributing.md`](.github/contributing.md) for ways to get started.
This repository has a [`code of conduct`](.github/CODE_OF_CONDUCT.md). By interacting with this repository, organization, or community you agree to abide by its terms.
[MIT][license] © [malezjaa][author]
Logo by [iconixar](https://www.flaticon.com/authors/iconixar)
[license]: license
[author]: https://github.com/malezjaa