-
-
Notifications
You must be signed in to change notification settings - Fork 244
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
24f33bd
commit 7929e69
Showing
88 changed files
with
1,959 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
<p align="center"> | ||
<a href="https://vueup.github.io/vue-quill/" target="_blank" rel="noopener noreferrer"> | ||
<img height="120" src="https://vueup.github.io/vue-quill/quill.svg" alt="Vue + Quill logo"> | ||
</a> | ||
</p> | ||
<h1 align="center">VueQuill</h1> | ||
<h3 align="center"> | ||
Vue 3 + Quill Component for your powerful text editor. | ||
</h3> | ||
<p align="center"> | ||
<a href="https://www.npmjs.com/package/@vueup/vue-quill" title="Version"> | ||
<img alt="npm (tag)" src="https://img.shields.io/npm/v/@vueup/vue-quill/alpha"> | ||
</a> | ||
<a href="https://www.npmjs.com/package/@vueup/vue-quill" title="License"> | ||
<img src="https://img.shields.io/npm/l/@vueup/vue-quill" alt="License"> | ||
</a> | ||
<a href="https://github.com/vueup/vue-quill" title="Checks"> | ||
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/vueup/vue-quill/Release%20package?logo=github"> | ||
</a> | ||
<a href="https://github.com/vueup/vue-quill" title="Last commit"> | ||
<img src="https://img.shields.io/github/last-commit/vueup/vue-quill?logo=github" alt="Last commit"> | ||
</a> | ||
</p> | ||
|
||
## Overview | ||
|
||
**VueQuill** is a **Vue Component** for building rich text editors, this package is a thin wrapper around Quill, to make it easier to use in a Vue 3 application. | ||
|
||
- 💚 **Built With Vue 3:** More powerful and performant framework than ever before. | ||
- 🧙♂️ **Fully Typescript:** VueQuill source code is written entirely in TypeScript. | ||
- 🛠️ **Easy To Use:** Straightforward implementation through a simple API. | ||
|
||
[👀 See a Live Demo](https://vueup.github.io/vue-quill/#demo). | ||
|
||
[📘 Read the Docs to Learn More.](https://vueup.github.io/vue-quill/guide/) | ||
|
||
> 🚀 **VueQuill** is in **@alpha** version! Currently the focus is on making VueQuill stable and feature complete first. It is not recommended to use this for anything serious yet. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions. | ||
> 🧑🤝🧑 **VueQuill** is also contributor-driven. It is not backed by any huge company, which means that all contributions are voluntary and done by the people who need them. If you need something improved, added, or fixed, please contribute it yourself or no one will. | ||
## Support me | ||
You can support me by [**☕ buying me a cup of coffee ☕**](https://www.buymeacoffee.com/luthfimasruri) to help me stay awake while I am coding, spend more time on the projects, and speed up the development. | ||
|
||
## To do list | ||
|
||
- [x] Release alpha version | ||
- [ ] Release beta version | ||
- [ ] Initial `v1.0.0` release | ||
- [ ] Enhance Typescript support with Vue 3 | ||
- [ ] Update the Documentation with improved examples and more information | ||
- [ ] **vue-quill-plugin-api:** provide built-in API for quill modules | ||
|
||
### Our Dream Features | ||
Our next goal is to provide a first-class plugins ecosystem: | ||
- [ ] [**vue-quill-table:**](#) add table editing functionality with options to modify cells, rows and columns. | ||
- [ ] [**vue-quill-media:**](#) add image, HTML5 video, and audio elements to the editable area. Includes option for live preview of embedded videos. | ||
- [ ] [**vue-quill-emoji:**](#) Insert emojis into VueQuill’s editable area. The default emoji set can be extended or overridden. | ||
- [ ] [**vue-quill-suggest:**](#) insert shortcut-text and transforming it into `@mentions`, [links](), and `#hashtags`. | ||
- [ ] [**vue-quill-form:**](#) module for automatic form input and submit binding. | ||
- [ ] [**vue-quill-code:**](#) insert and embed syntax color highlighted code snippets into the editable area. | ||
- [ ] [**vue-quill-collab:**](#) module for realtime collaboration. | ||
|
||
## Demo | ||
- [See a Live Demo](https://vueup.github.io/vue-quill/#demo). | ||
|
||
[![Screenshot VueQuill Editor](https://user-images.githubusercontent.com/6185447/111898684-33761b00-8a5a-11eb-9458-372c0185f576.png)](https://vueup.github.io/vue-quill/#demo) | ||
|
||
## Documentation | ||
- **[Guide](https://vueup.github.io/vue-quill/guide/)** | ||
- [Introduction](https://vueup.github.io/vue-quill/guide/) | ||
- [Installation](https://vueup.github.io/vue-quill/guide/installation.html) | ||
- [Usage](https://vueup.github.io/vue-quill/guide/usage.html) | ||
- [Themes](https://vueup.github.io/vue-quill/guide/themes.html) | ||
- [Toolbar](https://vueup.github.io/vue-quill/guide/toolbar.html) | ||
- [Options](https://vueup.github.io/vue-quill/guide/options.html) | ||
|
||
- **[APIs](https://vueup.github.io/vue-quill/api/)** | ||
- [Props](https://vueup.github.io/vue-quill/api/) | ||
- [Events](https://vueup.github.io/vue-quill/api/events.html) | ||
- [Methods](https://vueup.github.io/vue-quill/api/methods.html) | ||
- [Slots](https://vueup.github.io/vue-quill/api/slots.html) | ||
- [Export](https://vueup.github.io/vue-quill/api/export.html) | ||
|
||
## Contributing | ||
Pull requests are welcome. For major changes, please create a [new discussion](https://github.com/vueup/vue-quill/discussions) first about what you would like to change. | ||
|
||
## Quill | ||
[Quill API document](https://quilljs.com/docs/quickstart/) | ||
|
||
## License | ||
[MIT](https://choosealicense.com/licenses/mit/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"extends": "../../api-extractor.json", | ||
"mainEntryPointFilePath": "./dist/packages/<unscopedPackageName>/src/index.d.ts", | ||
"dtsRollup": { | ||
"publicTrimmedFilePath": "./dist/<unscopedPackageName>.d.ts" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
{ | ||
"css": [ | ||
{ | ||
"input": "./node_modules/quill/assets/core.styl", | ||
"output": "./dist/vue-quill.core.css" | ||
}, | ||
{ | ||
"input": "./node_modules/quill/assets/bubble.styl", | ||
"output": "./dist/vue-quill.bubble.css" | ||
}, | ||
{ | ||
"input": "./src/assets/snow.styl", | ||
"output": "./dist/vue-quill.snow.css" | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
'use strict' | ||
|
||
if (process.env.NODE_ENV === 'production') { | ||
module.exports = require('./dist/vue-quill.cjs.prod.js') | ||
} else { | ||
module.exports = require('./dist/vue-quill.cjs.js') | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.