GithubHelp home page GithubHelp logo

artmadiar / yopta-editor Goto Github PK

View Code? Open in Web Editor NEW

This project forked from darginec05/yoopta-editor

0.0 0.0 0.0 3.59 MB

Notion-like editor with similar behaviour

Home Page: https://yopage.co/blog/0zntIA46L4/W0epdDpnRa

License: MIT License

JavaScript 1.38% TypeScript 89.44% SCSS 9.19%

yopta-editor's Introduction

Yopta-Editor v1 ๐ŸŽ‰

Yopta-Editor - is an open source notion-like editor ๐Ÿ’ฅ

Screen Shot 2023-01-25 at 16 04 29

Full docs | Get started | API | FAQs | Examples

Features

  • Triggering by "/" to show list of elements and search needed element by typing
  • Drag and drop beetween elements
  • Redo/Undo your changes (Ctrl-Z/Ctrl-V)
  • Offline ready mode
  • Shortcuts
  • A cool representation of the data in JSON format, so you can easily save the content data to the database and validate You can import two components from library: <YoptaEditor /> and <YoptaRender />.
    <YoptaEditor /> - it's for building beautiful content
    <YoptaRender /> - it's just for rendering from your saved data, without any editor tools and libraries, so it make you page loading faster
  • Custom styling ...and other

Install

yarn add yopta-editor
or
npm install yopta-editor

Peer dependencies

yarn add react react-dom slate slate-react
or
npm install react react-dom slate slate-react

Quickstart

import { YoptaEditor } from 'yopta-editor';
import { useState } from 'react';

import 'yopta-editor/dist/index.css';

function App() {
  const [editorValue, setEditorValue] = useState([]);

  const onChange = (data) => setEditorValue(data);

  return (
    <div>
      <YoptaEditor value={editorValue} onChange={onChange} />
    </div>
  );
}

Check out other DEMO's ๐Ÿ‘‡

โ— Yopta-Editor is on BETA version now. The core functionality works, but you may encounter some bugs. I have big plans for the v2 version with a lot of cool features and improvements. Let's build together the best open source editor ever โ˜
Read more about future plans "What's next Lebovski?"

๐Ÿ“ This WYSIWYG editor build on top of Slate JS framework
๐Ÿ’™ SlateJS - is the best tool for building rich-text editors. It has beautiful design and great API

Donation.

If you like this open source project you can support me using Stripe link ๐Ÿ’™

Used by

License

MIT LICENSE

yopta-editor's People

Contributors

darginec05 avatar ler4onok avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.