зеркало из
https://github.com/rs-pro/activeadmin-quill_editor.git
synced 2026-09-07 20:15:51 +03:00
Update README
Этот коммит содержится в:
@@ -1,10 +1,11 @@
|
|||||||
# ActiveAdmin Quill Editor [](https://badge.fury.io/rb/activeadmin_quill_editor) [](https://circleci.com/gh/blocknotes/activeadmin_quill_editor)
|
# ActiveAdmin Quill Editor [](https://badge.fury.io/rb/activeadmin_quill_editor) [](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs.yml)
|
||||||
|
|
||||||
An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill) in form fields.
|
An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill) in form fields.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
After installing Active Admin, add to your Gemfile: `gem 'activeadmin_quill_editor'` (and execute *bundle*)
|
After installing Active Admin, add to your Gemfile: `gem 'activeadmin_quill_editor'` (and execute *bundle*)
|
||||||
|
|
||||||
If you installed Active Admin without Webpacker support (default for now):
|
If you installed Active Admin without Webpacker support (default for now):
|
||||||
@@ -34,6 +35,7 @@ require('activeadmin_quill_editor')
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
In your Active Admin models, form configuration, set the text inputs with `as: :quill_editor` where needed.
|
In your Active Admin models, form configuration, set the text inputs with `as: :quill_editor` where needed.
|
||||||
|
|
||||||
**data-options**: permits to set *quill editor* options directly - see [options list](https://quilljs.com/docs/configuration/)
|
**data-options**: permits to set *quill editor* options directly - see [options list](https://quilljs.com/docs/configuration/)
|
||||||
@@ -61,6 +63,7 @@ f.input :description, as: :quill_editor, input_html: { data: { options: { module
|
|||||||
```
|
```
|
||||||
|
|
||||||
### ImageUploader plugin
|
### ImageUploader plugin
|
||||||
|
|
||||||
This plugin allows to upload images to the server (instead of storing them in *base64* by default), reference [here](https://github.com/NoelOConnell/quill-image-uploader).
|
This plugin allows to upload images to the server (instead of storing them in *base64* by default), reference [here](https://github.com/NoelOConnell/quill-image-uploader).
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
@@ -87,13 +90,16 @@ the *upload_admin_post_path*) and it doesn't provide a way to remove images (jus
|
|||||||
the editor will not destroy them, you'll need to implement a purge logic for that).
|
the editor will not destroy them, you'll need to implement a purge logic for that).
|
||||||
|
|
||||||
## Do you like it? Star it!
|
## Do you like it? Star it!
|
||||||
|
|
||||||
If you use this component just star it. A developer is more motivated to improve a project when there is some interest. My other [Active Admin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source).
|
If you use this component just star it. A developer is more motivated to improve a project when there is some interest. My other [Active Admin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source).
|
||||||
|
|
||||||
Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
|
Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
|
||||||
|
|
||||||
## Contributors
|
## Contributors
|
||||||
|
|
||||||
- [Mattia Roccoberton](http://blocknot.es): author
|
- [Mattia Roccoberton](http://blocknot.es): author
|
||||||
- The good guys that opened issues and pull requests from time to time
|
- The good guys that opened issues and pull requests from time to time
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The gem is available as open-source under the terms of the [MIT](LICENSE.txt).
|
The gem is available as open-source under the terms of the [MIT](LICENSE.txt).
|
||||||
|
|||||||
Ссылка в новой задаче
Block a user