Skip to content

Latest commit

 

History

History
97 lines (64 loc) · 3.42 KB

readme.MD

File metadata and controls

97 lines (64 loc) · 3.42 KB
Raw

we-edit

we-edit is a JavaScript library for building text editor.

  • Declarative:
  • React Component Based:
  • Easy extend:

Learn how to use we-edit in your own project.

Documentation

You can find the documentation on the website.
It is divided into several sections:

You can improve it by sending pull requests to this repository.

Examples

We have several examples on the website. Here is the first one to get you started:

	ReactDOM.render(
		<WeEdit>
			<WeEditUI fonts={["Arial", "Calibri", "Cambria"]}>
				<Workspace accept="*.docx" layout="print" debug={false}>
					<Viewer
						toolBar={null} ruler={false}
						layout="read" icon={<IconRead/>}
						channel={<Pagination/>}>

					</Viewer>

					<Editor
						layout="print" 
						icon={<IconPrint/>}
						channel={<Pagination/>}
						>

					</Editor>

					<Editor ruler={false}
						layout="web" icon={<IconWeb/>}
						channel={<Html/>}>

					</Editor>
				</Workspace>
			</WeEditUI>
		</WeEdit>,
		document.querySelector("#OfficeContainer")
	)

This example will render we-edit-office into a container on the page.

Installation

npm install we-edit we-edit-office

we-edit is available as the we-edit package on npm. It is also available on a CDN.

we-edit is flexible and can be used in a variety of projects. You can create new apps with it, but you can also gradually introduce it into an existing codebase without doing a rewrite.

The recommended way to install we-edit depends on your project. Here you can find short guides for the most common scenarios:

Contributing

The main purpose of this repository is to continue to evolve we-edit core, making it faster and easier to use. Development of we-edit happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving we-edit.

Code of Conduct

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to we-edit.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

License

we-edit is MIT licensed.