diff --git a/developer_manual/design/index.rst b/developer_manual/design/index.rst index 89829bf81..38262d68f 100644 --- a/developer_manual/design/index.rst +++ b/developer_manual/design/index.rst @@ -6,7 +6,6 @@ Design guidelines :maxdepth: 2 navigation - settings content list popovermenu diff --git a/developer_manual/design/navigation.rst b/developer_manual/design/navigation.rst index 2d45a952a..caf0be6d0 100644 --- a/developer_manual/design/navigation.rst +++ b/developer_manual/design/navigation.rst @@ -2,10 +2,61 @@ .. codeauthor:: John Molakvoæ .. _navigation: +.. _newbutton: + =============== -App navigation +Introduction =============== +The navigation section of any nextcloud app is the left sidebar. +It is basically composed of + +* a 'new' button +* a menu +* a settings area + +The 'new' button and the settings area are optional. + + +=============== +New button +=============== + +Introduction +------------- + +A 'new' button is just a stylised button located above the navigation part of your app. +It can be tied to whatever you want as long as it follow those simple rules. +The goal is to have an homogeneity of design across all apps using this button. + +Basic layout +------------- + +.. figure:: ../images/newbutton.png + :alt: Navigation with a new button + :figclass: figure-with-code + +.. code-block:: html + +
+
+ +
+
+ +Rules +------ + +* Stay simple, don't use overcomplicated text in this button. +* Avoid using sentences longer than one line. +* Do not edit the styling of this button. + +.. _appnavigation: + +===================== +App navigation menu +===================== + Introduction ------------ @@ -387,3 +438,43 @@ Various information * You can add the ``icon-loading-small`` class to any ``li`` element to set it in a `loading` state. * Every element as a ``min-height`` of 44px as that is the minimum recommended touch target. It also helps with clickability and separation on desktop environments. + +.. _settings: + +========= +Settings +========= + +Introduction +------------- + +To create a settings area create a div with the id ``app-settings`` inside the ``app-navigation`` div. + +* The data attribute ``data-apps-slide-toggle`` slides up a target area using a jQuery selector and hides the area if the user clicks outside of it. +* Max height of the settings area is 300px. Do **not** change that. +* Keep it clear, organized and simple. + +Basic layout +------------- + +.. figure:: ../images/settings.* + :alt: Settings + :figclass: figure-with-code + +.. code-block:: html + +
+ + + +
+
+ +
+
+ +
+
+
diff --git a/developer_manual/design/settings.rst b/developer_manual/design/settings.rst deleted file mode 100644 index 9d712f1b5..000000000 --- a/developer_manual/design/settings.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. sectionauthor:: John Molakvoæ -.. codeauthor:: John Molakvoæ -.. _settings: - -======== -Settings -======== - -To create a settings area create a div with the id ``app-settings`` inside the ``app-navigation`` div. - -* The data attribute ``data-apps-slide-toggle`` slides up a target area using a jQuery selector and hides the area if the user clicks outside of it. -* Max height of the settings area is 300px. Do **not** change that. -* Keep it clear, organized and simple. - -.. figure:: ../images/settings.* - :alt: Settings - :figclass: figure-with-code - -.. code-block:: html - -
- - - -
-
- -
-
- -
-
-
diff --git a/developer_manual/images/newbutton.png b/developer_manual/images/newbutton.png new file mode 100644 index 000000000..ba1dd4dfe Binary files /dev/null and b/developer_manual/images/newbutton.png differ