https://github.com/saul-mirone/prosemirror-adapter

Universal adapter to create prosemirror nodeview from modern UI frameworks.
https://github.com/saul-mirone/prosemirror-adapter

javascript prosemirror react typescript vue

Last synced: 3 months ago
JSON representation

Universal adapter to create prosemirror nodeview from modern UI frameworks.

• Host: GitHub
• URL: https://github.com/saul-mirone/prosemirror-adapter
• Owner: Saul-Mirone
• License: mit
• Created: 2022-11-03T10:45:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T03:15:46.000Z (4 months ago)
• Last Synced: 2024-10-29T19:00:15.939Z (4 months ago)
• Topics: javascript, prosemirror, react, typescript, vue
• Language: TypeScript
• Homepage:
• Size: 1.02 MB
• Stars: 97
• Watchers: 3
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# prosemirror-adapter



    


    


    

    


    




Universal adapter for [ProseMirror](https://prosemirror.net/) to use it with modern UI frameworks.

![npm](https://img.shields.io/npm/v/@prosemirror-adapter/core)

[![ci](https://github.com/Saul-Mirone/prosemirror-adapter/actions/workflows/ci.yml/badge.svg)](https://github.com/Saul-Mirone/prosemirror-adapter/actions/workflows/ci.yml)

## What is this?

[Prosemirror](https://github.com/ProseMirror/prosemirror) is a toolkit to build modern rich text editors.

But it is not a good fit for a modern UI framework like React or Vue.

This adapter is a low level tool to make it work with them without pain.

You'll need this adapter if you want to use Prosemirror to build a rich text editor with complex UI in modern UI frameworks we support.

### What's on the plan?

- [x] Support Popular UI Frameworks

  - [x] [React](https://reactjs.org/)

  - [x] [Vue](https://vuejs.org/)

  - [x] [Svelte](https://svelte.dev/)

  - [x] [Lit](https://lit.dev/)

  - [x] [Solid](https://solidjs.com/)

  - [ ] 🚀 coming soon...

- [x] Add out of box support for prosemirror features

  - [x] [Prosemirror Node View](https://prosemirror.net/docs/ref/#view.NodeView)

  - [x] [Prosemirror Plugin View](https://prosemirror.net/docs/ref/#state.PluginView)

  - [x] [Prosemirror Widget Decoration](https://prosemirror.net/docs/ref/#view.Decoration%5Ewidget)

### What's not on the plan?

This package should only take care about building a bridge between prosemirror and UI frameworks. It should be kept as an low level binding.

So something out of this scope will not be considered. For example:

- ❎ We won't provide UI components.

- ❎ We won't provide key bindings.

- ❎ We won't provide schema for special modules like table or math.

## Getting Started

  

    react

    vue

    svelte

    lit

    solid

  

  

    

      

        

      

    

    

      

        

      

    

    

      

        

      

    

    

      

        

      

    

    

      

        

      

    

  

## Contributing

PR welcome! Follow our [contribution guide](/CONTRIBUTING.md) to learn how to contribute to prosemirror-adapter.

## License

[MIT](/LICENSE)