Use CKEditor for textareas in custom form

Question

I'm using the CKEditor module, and I would like to have the CKEditor in my custom textarea. I tried hard but it just doesn't work...

This some of the code I tried:

    $form['body'] = array (
        '#type' => 'textarea',
        '#title' => 'Item Snippet',
        '#default_value' => $body,
        '#cols' => 80,
        '#rows' => 7
    );
    $form['']['format'] = filter_form();

Answer 1

Use the text_format element type and CKEditor will catch your field:

  $form['body'] = array(
    '#type' => 'text_format',
    '#title' => t('Body'),
    '#format'=> 'full_html',
  );

If you have issues with showing CKEditor in popup use additional #pre_render:

  $form['body'] = array(
    '#type' => 'text_format',
    '#title' => t('Body'),
    '#format'=> 'full_html',
    '#pre_render' => array('ckeditor_pre_render_text_format'),
  );

Answer 2

u need to use "text_format" instead of "textarea"

text_format

Description: A text-format-enabled version of a textarea.

Answer 3

In Drupal 8.6.x my solution was:

$form['Description'] = [
  '#type' => 'text_format',
  '#title' => $this->t('Description'),
  '#format' => 'rich_text',
];

Answer 4

just in case somebody only wants a basic_html format one and does not want show format selection ('#allowed_formats' => ['basic_html'] is the point),

$form['description'] = [
  '#type' => 'text_format',
  '#title' => $this->t('message'),
  '#format' => "basic_html",
  '#allowed_formats' => ['basic_html'],
  '#required' => TRUE,
];

Answer 5

You can try this

 $form['body'] = array(
   '#type' => 'textarea',
   '#title' => 'Item Snippet',
   '#default_value' => $body,
   '#cols' => 80,
   '#rows' => 7,
   '#wysiwyg' => TRUE, // just add this and you'll get the CKeditor 
 );
 // …

I was facing the same problem; when I added '#wysiwyg' => TRUE, it worked.

Answer 6

Some of the methods discussed above do get the CKEditor in the textarea, but if it is a configuration form, the values don't get saved properly. If you are stuck with same problem you can use a second CKEditor from DNS as explained here: http://naikacademy.blogspot.com/2018/09/how-to-add-text-editor-to-custom-form.html

Answer 7

There is a setting page for CKEdiors. You can configure there. You need to give the path to that form and select include from dropdown and it will apply Rich Text editors to all text areas in that path.