Skip to content

Commit b81ec6d

Browse files
committed
Add documentation for component and screenshots
1 parent 8179a08 commit b81ec6d

File tree

3 files changed

+17
-7
lines changed

3 files changed

+17
-7
lines changed

docs/source/components.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -280,20 +280,30 @@ Media component
280280
The media component is another legacy component from djangocms-bootstrap4.
281281
**djangocms-frontend** recreates it using responsive utilities.
282282

283-
.. index::
284-
single: Modal
285-
286-
*******************
283+
***************
287284
Modal component
288-
*******************
285+
***************
289286

290287
The modal component shows content inside an modal.
291288

292-
Content is added to the modal plugin by creating child plugin "Modal inner".
289+
Also see Bootstrap 5 `Modal <https://getbootstrap.com/docs/5.3/components/modal/>`_
290+
documentation.
291+
292+
Modal consist of an Modal Plugin which uses an Modal Trigger Plugin and an Modal Container Plugin.
293+
Inside the Modal Container add an Modal Inner Plugin and select the inner type "header" or "body".
294+
295+
.. image:: screenshots/modal-example.png
296+
:width: 394
297+
298+
The unique identifier of the Modal Trigger Plugin and Modal Container Plugin have to be identical.
299+
300+
The layout of the modal can be modified in the Modal Container plugin.
301+
302+
.. image:: screenshots/modal-settings.png
293303

294304
.. note::
295305

296-
Restiction:
306+
Restriction:
297307
The footer is not editable and shows only a close button.
298308

299309
.. index::
91.5 KB
Loading
130 KB
Loading

0 commit comments

Comments
 (0)