Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-04-25 09:04:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add entities disclaimer

Browse source
This commit is contained in:
Thibaud Colas 2018-01-31 00:21:37 +02:00 committed by Matt Westcott
parent 49c9999cb8
commit fac8582ac4
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/advanced_topics/customisation/page_editing_interface.rst
View file

@ -225,6 +225,21 @@ Here are the main differences:
That’s it! The extra complexity is that you may need to write some CSS if using a ``className`` so your blocks look good in the editor.
Creating new entities
"""""""""""""""""""""
.. warning::
This is an advanced feature. Please carefully consider whether you really need this. You have been warned.
Entities aren’t simply formatting buttons in the toolbar. They usually need to be much more versatile, communicating to APIs or requesting further user input. As such,
* You will most likely need to write a **hefty dose of JavaScript**, some of it with React.
* The API is very **low-level**. You will most likely need some **Draft.js knowledge**.
* There are a lot of ways for custom UIs within rich text to go wrong. Be prepared to spend a lot of time **testing in multiple browsers**.
The good news is that having such a low-level API will enable third-party Wagtail plugins to innovate on rich text features, proposing new kinds of experiences.
But in the meantime, if this doesn’t seem worth the investment, consider implementing your UI through :doc:`StreamField <../topics/streamfield>` instead, which has a battle-tested API meant for Django developers.
Extending the WYSIWYG Editor (``hallo.js``)
+++++++++++++++++++++++++++++++++++++++++++