Returns a settings form to configure this CKEditor plugin.

If the plugin's behavior depends on extensive options and/or external data, then the implementing module can choose to provide a separate, global configuration page rather than per-text-editor settings. In that case, this form should provide a link to the separate settings page.

Parameters

array $form: An empty form array to be populated with a configuration form, if any.

\Drupal\Core\Form\FormStateInterface $form_state: The state of the entire filter administration form.

\Drupal\editor\Entity\Editor $editor: A configured text editor object.

Return value

array A render array for the settings form.

Overrides CKEditorPluginConfigurableInterface::settingsForm

File

core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php, line 58

Class

LlamaContextualAndButton

Defines a "LlamaContextualAndButton" plugin, with a "llama" feature.

Namespace

Drupal\ckeditor_test\Plugin\CKEditorPlugin

Code

public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
  // Defaults.
  $config = [
    'ultra_llama_mode' => FALSE,
  ];
  $settings = $editor->getSettings();
  if (isset($settings['plugins']['llama_contextual_and_button'])) {
    $config = $settings['plugins']['llama_contextual_and_button'];
  }
  $form['ultra_llama_mode'] = [
    '#title' => $this->t('Ultra llama mode'),
    '#type' => 'checkbox',
    '#default_value' => $config['ultra_llama_mode'],
  ];
  return $form;
}

---