ckstyles icon indicating copy to clipboard operation
ckstyles copied to clipboard

Improvements: Attributes, Readme, Code-Documentation

Open anianweber opened this issue 2 years ago • 1 comments

  • Refactor the usage of attribute vs. the usage of classes in the InlineStyleEditing.js und BlockStyleEditing.js code to get a clear distinction of the 2 implementations

    • Alternatively refactor them to be generic and unspecific to one or the other implementation
    • Avoid unclear conditional logic, like: https://github.com/techdivision/ckstyles/blob/master/Resources/Private/JavaScript/CkStyles/src/BlockStyleEditing.js#L39
  • Improve Readme to further clarify the use case of setting classes vs. the use case of setting other attributes

  • Add additional inline documentation to the code to further clarify whats happening (especially considering the complex API of CkEditor 5)

anianweber avatar Mar 21 '22 12:03 anianweber

i can aggree with that :P Code doesnt read that well, when i looked at it the first time ^^

I may be able to help

edit: https://github.com/techdivision/ckstyles/pull/32 🎉

mhsdesign avatar Aug 14 '22 17:08 mhsdesign