Commit 98315d11 authored by Fabian Riethmayer's avatar Fabian Riethmayer

Changed position of API links and fixed structure in some component pages

parent 1fde12ce
......@@ -148,15 +148,12 @@ shown instead.
Code
----
API
~~~
Kirigami
~~~~~~~~
- :kirigamiapi:`Kirigami: InlineMessage <InlineMessage>`
- :kwidgetsaddons:`QtWidgets: KMessageWidget <KMessageWidget>`
Kirigami
~~~~~~~~
.. code-block:: qml
...
......
......@@ -88,8 +88,8 @@ Here are some general recommendations for card layouts:
Code
----
API
~~~
Kirigami
~~~~~~~~
- :kirigamiapi:`Kirigami: Card <Card>`
- :kirigamiapi:`Kirigami: CardsGridView <CardsGridView>`
......
......@@ -201,7 +201,7 @@ like , that will take care of lay outing and spacing of your controls.
Code
----
API
~~~
Kirigami
~~~~~~~~
- `QML: CheckBox <https://doc.qt.io/qt-5/qml-qtquick-controls-checkbox.html>`_
......@@ -82,7 +82,7 @@ Appearance
Code
----
API
~~~
Kirigami
~~~~~~~~
- `QML: ComboBox <https://doc.qt.io/qt-5/qml-qtquick-controls-combobox.html>`_
......@@ -38,8 +38,8 @@ Appearance
Code
----
API
~~~
Kirigami
~~~~~~~~
- `QML: GridView <https://doc.qt.io/qt-5/qml-qtquick-gridview.html>`_
- :kirigamiapi:`Kirigami: CardsGridView <CardsGridView>`
......@@ -287,17 +287,14 @@ Ordering
Code
----
API
~~~
Kirigami
~~~~~~~~
- `QML: ListView <https://doc.qt.io/qt-5/qml-qtquick-listview.html>`_
- :kirigamiapi:`Kirigami: CardsListView <CardsListView>`
- :kirigamiapi:`Kirigami: AbstractListItem <AbstractListItem>`
- :kirigamiapi:`Kirigami: BasicListItem <BasicListItem>`
- :kirigamiapi:`Kirigami: SwipeListItem <SwipeListItem>`
Kirigami
~~~~~~~~
.. code-block:: qml
......
......@@ -181,8 +181,8 @@ which will take care of laying out and spacing of your controls.
Code
----
API
~~~
Kirigami
~~~~~~~~
- `QML: RadioButton
<https://doc.qt.io/qt-5/qml-qtquick-controls-radiobutton.html>`_
......@@ -115,7 +115,7 @@ Slider and Spinbox together
Code
----
API
~~~
Kirigami
~~~~~~~~
- `QML: Slider <https://doc.qt.io/qt-5/qml-qtquick-controls-slider.html>`_
......@@ -67,7 +67,7 @@ Appearance
Code
----
API
~~~
Kirigami
~~~~~~~~
- `QML: SpinBox <https://doc.qt.io/qt-5/qml-qtquick-controls2-spinbox.html>`_
......@@ -69,16 +69,12 @@ If your application is using :doc:`column-based navigation </patterns/navigation
Code
----
API
~~~
Kirigami
~~~~~~~~
- :kirigamiapi:`Kirigami: Action <Action>`
- :kirigamiapi:`Kirigami: ScrollablePage <ScrollablePage>`
Kirigami
^^^^^^^^
.. code-block:: qml
...
......@@ -107,3 +103,6 @@ Kirigami
}
...
}
......@@ -24,16 +24,19 @@ The Context Drawer is used to access controls that depend on the current
context. This can be, for example, controls that affect a selected
element in a list or that navigate through an opened document.
Is this the right control?
--------------------------
Guidelines
----------
Is this the right control
~~~~~~~~~~~~~~~~~~~~~~~~~
Use a Context Drawer if your application has any functions which are
only relevant in specific contexts, and which are not central enough to
the application's main purpose to put them in the main user interface or
in a toolbar. For actions which are always available, use the :doc:`Global Drawer <globaldrawer>`.
Guidelines
----------
Behavior
~~~~~~~~
- The Context Drawer is opened by swiping in from the left or right
edge of the screen (depending on a system-wide setting) and closed by
......@@ -65,12 +68,12 @@ Guidelines
Code
----
Kirigami
~~~~~~~~
- :kirigamiapi:`Kirigami: Action <Action>`
- :kirigamiapi:`Kirigami: ScrollablePage <ScrollablePage>`
Kirigami
^^^^^^^^
.. code-block:: qml
...
......
Global drawer
=============
Purpose
-------
The Global Drawer is a standard element in KDE mobile applications. It
contains an application's main menu, and any functions which are not
part of the application's main usecases but are not specific to the
current context either.
.. container:: intend
|desktopicon| |mobileicon|
......@@ -17,16 +25,11 @@ Global drawer
Global drawer on mobile
Purpose
-------
The Global Drawer is a standard element in KDE mobile applications. It
contains an application's main menu, and any functions which are not
part of the application's main usecases but are not specific to the
current context either.
Guidelines
----------
Is this the right control?
--------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. figure:: /img/Globaldrawer3.png
:figclass: border
......@@ -41,8 +44,8 @@ the main user interface, and which are not dependent on the current
context. For context-specific actions (e.g. those affecting a selected
item), use the :doc:`Context Drawer <contextdrawer>`
Guidelines
----------
Behavior
~~~~~~~~
.. figure:: /img/Globaldrawer2.png
:alt: Global drawer on desktop
......@@ -79,7 +82,7 @@ The main menu
Do not use the Menu Drawer for navigation purposes.
|desktopicon| Collapsible
^^^^^^^^^^^^^^^^^^^^^^^^^
"""""""""""""""""""""""""
On the desktop, if the elements in the Global Drawer need to be accessed more
often and enough space is available, the Global Drawer can default to showing a
......@@ -98,14 +101,11 @@ collapsed icons-only state.
Code
----
API
~~~
Kirigami
~~~~~~~~
- :kirigamiapi:`Kirigami: GlobalDrawer <GlobalDrawer>`
Kirigami
^^^^^^^^
.. code-block:: qml
...
......
......@@ -83,15 +83,12 @@ Appearance
Code
----
API
~~~
Kirigami
~~~~~~~~
- :kirigamiapi:`Kirigami: ApplicationWindow <ApplicationWindow>`
- `QML: MenuBar <https://doc.qt.io/qt-5/qml-qtquick-controls-menubar.html>`_
Kirigami
^^^^^^^^
.. code-block:: qml
...
......
......@@ -99,18 +99,16 @@ Appearance
Code
----
API
~~~
Kirigami
~~~~~~~~
- :kirigamiapi:`Kirigami: Action <Action>`
- :kirigamiapi:`Kirigami: ScrollablePage <ScrollablePage>`
- :kirigamiapi:`Kirigami: ActionToolBar <ActionToolBar>`
Kirigami
~~~~~~~~
Application toolbar
^^^^^^^^^^^^^^^^^^^
"""""""""""""""""""
.. code-block:: qml
......
......@@ -145,17 +145,13 @@ Component
Kirigami
~~~~~~~~
Example code how to use the component with QML and Kirigami.
Link to the API and example code how to use the component with QML and
Kirigami.
Qt Widgets
~~~~~~~~~~
Example code how to use the component with Qt Widgets.
API
~~~
Link to KDE and Qt API pages.
Link to the API and example code how to use the component with Qt Widgets.
Optional: you can add subsections for desktop and mobile.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment