adnedelcu/summernote-bundle

Summernote bundle, adds Summernote WYSIWYG editor to your Symfony2 project

0.1 2015-09-23 16:51 UTC

Requires

• php: >=5.3.3
• symfony/framework-bundle: ~2.4
• symfony/twig-bundle: ~2.4

Suggests

• helios-ag/fm-elfinder-bundle: Elfinder bundle, file manager

MIT

• Al Ganiev
• Symfony Community

• wysiwyg
• editor
• summernote

README

SummernoteBundle adds summernote bundle

Installation

Step 1: Installation

Using Composer, just add the following configuration to your composer.json:

Or you can use composer to install this bundle: Add SummernoteBundle in your composer.json:

    composer require adnedelcu/summernote-bundle --no-update

Now tell composer to download the bundle by running the command:

    composer update adnedelcu/summernote-bundle

Step 2: Enable the bundle

Finally, enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new ADN\SummernoteBundle\ADNSummernoteBundle(),
    );
}

Configuration

You can configure bundle as follows

adn_summernote:
    plugins:
        - video
    selector: .summernote #defines summernote selector for apply to
    toolbar: # define toolbars, if no toolbar configured, default toolbars defined
        ['style', ['style']]
    extra_toolbar: # extra toolbar can be used for plugins toolbar and as additional toolbar setings, when 'toolbar' option is omitted
        elfinder: [elfinder]
    width: 600
    height: 400
    include_jquery: true #include js libraries, if your template already have them, set to false
    include_bootstrap: true
    include_fontawesome: true

To upload the images pasted in the editor, you can add the following configuration to the bundle

adn_summernote:
    # ...
    upload_images: true # set to false if you don't want to upload images
        # used for the image upload (so that the images will not be saved as base64 in the content)
        max_upload_size: 1048576
        # this route must be implemented if you want to use the image upload feature
        image_upload_route: acme_image_upload
    # ...

##Usage

Twig template example

    {{ summernote_init() }}
    <textarea class="summernote"></textarea>