Giter Club home page Giter Club logo

artibox's Introduction

React-Artibox

React Rich Text Editor in Structured Data, easy render for RWD layout.

** IMPORTANT ** This repo is in development, please careful use in your production product.

Get Started

Initialize modules

// @flow
// index.jsx

import React from 'react';
import {
  createConfigProvider,
  Base64ImageHandler,
} from 'react-artibox';
import AricleEditor from './ArticleEditor.jsx';

const ArtiboxProvider = createConfigProvider({
  imageHandler: new Base64ImageHandler(),
});

function App() {
  return (
    <ArtiboxProvider>
      <ArticleEditor />
    </ArtiboxProvider>
  );
}

export default App;

Implement Editor on your site

// ArticleEditor.jsx

import React, { Component } from 'react';
import Editor from 'react-artibox/editor';

const styles = {
  color: '#4a4a4a',
  fontSize: 24,
};

class ArticleEditor extends Component {
  submit(data) {
    // Upload to API Server
    // data structure
    //{
    //  title: 'I am title',
    //  blocks: [{
    //    type: 'ARTIBOX/TEXT',
    //    content: 'Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.'
    //  }, {
    //    type: 'ARTIBOX/IMAGE',
    //    link: '90ab0747709b3cc10f37dfd6b92b1adaf4ea0b36.jpg'
    //  }],
    //}
  }

  render() {
    return (
      <h1 style={styles.title}>Article Editor</h1>
      <Editor onSubmit={data => this.submit(data)} />
    );
  }
}

export default ArticleEditor;

Display on Viewer

// ArticleViewer.jsx

import React, { Component } from 'react';
import Viewer from 'react-artibox/viewer';

class ArticleViewer extends Component {
  state = {
    data: null,
  }

  componentDidMount() {
    fetch('https://DATA_HOST/articles/2')
      .then(res => res.json())
      .then((data) => {
        this.setState({
          data,
        });
      });
  }

  render() {
    return <Viewer data={this.state.data} />;
  }
}

artibox's People

Contributors

dependabot[bot] avatar fantasywind avatar jay0328 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

artibox's Issues

Icons

To unify and complement all icons.
Prefer single path svg.

Software Architecture

Benchmarks:

  • The config of common plugin
  • The config of toolbar plugin
  • Migrate plugins to class which include queries and commands instead of register to editor.

Next

The version of slate now we use is v0.47.9.
Recently the v0.50.0 is out and have some new good concepts.

The more great part are:

  • bundle size reduce 70%.
  • be able to get editor instance outside slate.
  • structure of slate value is simpler and more presentative.

But the issues increase after v0.50.0.
Need to investigate if we need to migrate to that now.

Locale(i18n)

Features:

  • Support placeholder for all plugins needed.

Inputable Toolbar

Features:

  • while expanded, toolbar can be input.
  • while collapsed, input block like medium.

Link Plugin

TODO:

  • Link plugin
  • Link icon
  • Link modal UI

Theme Structure

Benchmarks:

  • Palette Variables
  • Layout
  • Bundle structure, merge all theme into one package

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.