Skip to content

helios-ag/FMSummernoteBundle

Repository files navigation

FMSummernoteBundle

FMSummernoteBundle integrates the Summernote WYSIWYG editor with Symfony applications.

Tests

Total Downloads Latest Stable Version License Codacy Badge Codacy Badge

Requirements

  • PHP 8.0 or higher
  • Symfony 6.0 or higher
  • jQuery (can be included automatically)

Installation

Step 1: Install the bundle

composer require helios-ag/fm-summernote-bundle

Step 2: Enable the bundle

If you're using Symfony Flex, the bundle will be enabled automatically. Otherwise, enable it in your config/bundles.php file:

// config/bundles.php

return [
    // ...
    FM\SummernoteBundle\FMSummernoteBundle::class => ['all' => true],
];

Configuration

You can configure the bundle as follows, but note that the plugins "elfinder" and "video" are not supported in Jquery2.x.

fm_summernote:
    plugins:
        - video
        - elfinder # by default plugins not set, bundle comes with elfinder plugin / provides integration with FMElfinderBundle
    selector: .summernote #defines summernote selector for apply to
    toolbar: # define toolbars, if no toolbar configured, default toolbars defined
        style: [style]
        bold: [bold]
    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
    language: '' # define language (with language culture code like de-DE, fr-FR, etc.) by default, it is in english
    include_jquery: true #include js libraries, if your template already have them, set to false
    include_bootstrap: true
    include_fontawesome: true

Usage

Twig template example

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

About

FMSummernoteBundle, adds Summernote editor to your symfony project

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 7