Commits

Iacopo Spalletti committed 3ce3db8

Added documentation for force_show_title property

Comments (0)

Files changed (1)

admin_tools/dashboard/modules.py

     accordion, or just stacked (default).
     As well as the :class:`~admin_tools.dashboard.modules.DashboardModule`
     properties, the :class:`~admin_tools.dashboard.modules.Group`
-    has one extra property:
+    has two extra properties:
 
     ``display``
         A string determining how the group should be rendered, this can be one
         of the following values: 'tabs' (default), 'accordion' or 'stacked'.
 
+    ``force_show_title``
+        Default behaviour for Group module is to force children to always show
+        the title if Group has ``display`` = ``stacked``. If this flag is set
+        to ``False``, children title is shown according to their``show_title``
+        property. Note that in this case is children responsibility to have
+        meaningful content if no title is shown.
+
     Here's an example of modules group::
 
         from admin_tools.dashboard import modules, Dashboard
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.