Redactor: Why is Redactor trying to order my plugins?

Created on 12 Apr 2020 · 10Comments · Source: craftcms/redactor

For a few of the plugins being added automatically, they are telling Redactor to addButtonBefore or addButtonAfter another specific button...

It feels like the Craft plugin shouldn't be making decisions as to what order our Redactor plugins show up. Ideally, they would just appear in whatever order I have them listed in the JSON file.

  "buttons": [
    "bold",
    "italic",
    "underline",
    "link",
    "lists"
  ],
  "plugins": [
    "alignment",
    "table"   <--- Table is at the end
  ],

Ω 2020-04-11 at 3 33 56 PM

Because the Craft plugin is making these decisions, it's leading to strange behavior in my custom toolbar. When I add a plugin (for example table), it automatically places itself in the toolbar in a _specific_ position. It's confusing because the plugin button ends up not where I placed it.

Can we please remove the preset order preferences? Or somehow make them overridable?

enhancement

Source

lindseydiloreto

Most helpful comment

Took me a few months, but the solution is finally here in the form of a brand new enforceButtonOrder Redactor config option!

andris-sevcenko on 8 Dec 2020

🎉3

All 10 comments

Those are plugins provided by Redactor, so not sure how smart it would be to tamper with that code.

andris-sevcenko on 16 Apr 2020

Huh, I assumed that was just Craft's implementation of those libraries. It's odd that Redactor would be so strict about where those buttons will appear... isn't the entire point of Redactor its flexibility?

Is there any way to override that? I find it hard to believe that a Table button _must_ go next to a Link button, no exceptions. 😕

lindseydiloreto on 16 Apr 2020

It's probably possible to override that with some JS code, but, if we're going to tamper with this, let's do it right.

If you _wanted_ to insert the table button in the middle there - how would you expect to define this in the config?

andris-sevcenko on 26 May 2020

Hmm... that's a great question, because Redactor is already squirrely about how you arrange the buttons.

Ideally, we'd be able to use the before and after methods to place them anywhere we want...

https://imperavi.com/redactor/docs/settings/button/#s-buttonsaddafter

But worst case scenario, I'd just expect it to land exactly where I put it in the plugins array...

  "plugins": [
    "alignment",
    "fontcolor",
    "table",   <--- Table should be in the middle
    "fullscreen",
    "clips"
  ]

lindseydiloreto on 26 May 2020

@lindseydiloreto what I meant is how would you insert it between the bold and italic buttons, for example?

andris-sevcenko on 27 May 2020

Are you asking "how do I envision it working?" Maybe something like this...

  "buttonsAddAfter": {
    "after": "bold",
    "buttons": ["table"] // Places the plugin button
  },
  "plugins": [
    "table" // Loads the plugin
  ],

... or possibly like this...

  "pluginsAddAfter": {
    "after": "bold",
    "buttons": ["table"] // Loads & places the button
  },

I have no idea how easily that jives with what Redactor and/or the Craft plugin are already doing. Glancing at this commit, it seems that the Craft plugin occasionally needs to use brute force with Redactor anyway.

Let me know your thoughts, or if I completely misunderstood the question! 😄

lindseydiloreto on 27 May 2020

It is really weird that redactor isn't able to just order the buttons like they are defined in the array. It is the default behaviour I would expect when defining buttons. Considering that redactor is a paid tool I would wish for more flexibility and predictability.