diff --git a/source/components/editing/list.rst b/source/components/editing/list.rst index a3560c1..dc4de07 100644 --- a/source/components/editing/list.rst +++ b/source/components/editing/list.rst @@ -1,352 +1,345 @@ List View ========= Purpose ------- A *list view* offers orientation, organization, and allows navigation without the need for more controls. Additionally, a list view may be used for single selection (users select one item from a list of mutually exclusive values) or multiple selections (selections in combination with the Shift key or Control key). However, because there is no common visual clue whether a list box’ mode is single or multiple and since other controls are more efficient for single selection, a list box should be used for single selection only. .. image:: /img/ListView.png :alt: ListView.png Guidelines ---------- Is this the right control ~~~~~~~~~~~~~~~~~~~~~~~~~ - Prefer a list view to show items that belong together and in case there is enough space. - Use the list view for selection when it is easy for users to know which items are selected at any given time, for one or more of these reasons: - There are no more than twice the number of options then are visible at a time - The options are well-known and familiar (for example months of a year or days of a week) - Usually the selected options are close to each other in the list Behavior ~~~~~~~~ - Do not have blank list items; use meta-options, e.g. (None) instead. - Place options that represent general options (e.g. All, None) at the beginning of the list. - Sort list items in a logical order. Make sure sorting fits translation. On demand actions ^^^^^^^^^^^^^^^^^ List items can uses an :doc:`on-demand pattern ` as -alternative to always visible controls. If the user often performs tasks on -single items of a list, add a handle on the side the list item (next to the -context drawer's edge, defined by a system-wide configuration) which. +an alternative to always-visible controls. If the user often performs tasks on +single items of a list, you can add on-demand controls to the list item for +these. .. image:: /img/Slide_to_reveal.jpg :alt: Slide to reveal actions :scale: 30 % |desktopicon| Desktop """"""""""""""""""""" -If only one action is available, most the time it's better -to not use the on-demand pattern, but show the action right away. +If only one action is available, most the time it's better to not use the +on-demand pattern and instead show the action right away. .. raw:: html On-demand controls are shown when hovering over the item with the cursor. A handle is shown to support devices with touch screens. Swiping the handle right to left reveals the actions. -As soon as the user taps anywhere else or the pointer is not any longer -hovering the item, the handle is slid back. +As soon as the user taps anywhere else or the pointer is no longer +hovering over the item, the handle is slid back. |mobileicon| Mobile """"""""""""""""""" .. raw:: html On-demand controls are revealed by sliding a handle from right to left to reveal them. As soon as the user taps anywhere else, the handle is slid back. Selection ^^^^^^^^^ List items can contain a checkbox to enable the selection of multiple items at the same time. Clicking on the checkbox should not trigger an action, but only change the selection. Place buttons below the list to perform actions on the selected items. If the selection is the only action a user can execute on the items, there is no need for a checkbox. Change the background item color to toggle selection state. .. figure:: /img/PickerOverlay.png :alt: Picker in Language KCM :scale: 60% Multiple selected items in a picker overlay. - Do *not* provide extended multiple selections with Shift+Click or Ctrl+Click to select groups of contiguous or non-adjacent values, respectively. Instead, use the :doc:`dual-list pattern ` or the :doc:`picker pattern ` if multiple items have to be selected, because it allows users to easily see which items are selected at any point, without having to scroll through the available options, and it can be used with only the mouse. Picker ^^^^^^ Lists can be used for the :doc:`picker pattern `. -Place a button below the list to add items to the list. To remove items from the -list, either add an remove action on the item, or give the user the posibility +Place a button below the list to add items to the list. To remove items from +the +list, either add an remove action on the item, or give the user the possibility to select items and add a global remove button at the bottom of the list. Ordering ^^^^^^^^ Allow drag and drop of items, if the the order of the items can be changed by the user. -.. .. attention:: -.. Due to technical limitations, drag and drop is not working for Kirigami. -.. You must use inline actions for the ordering of list items. -.. -.. .. figure:: /img/ListitemOrderingInline.png -.. :alt: Ordering flat pack sources with inline buttons -.. -.. Ordering flat pack sources with inline buttons - |desktopicon| Desktop """"""""""""""""""""" If you use a :doc:`dual-list pattern ` and want -to be able to order the items in the selected list you can add aditional up and +to be able to re-order the items in the selected list you can add aditional up +and down buttons. .. figure:: /img/DualListOrdering.png :scale: 50 % :alt: Dual-list pattern with up and down buttons Dual-list pattern with up and down buttons Appearance ~~~~~~~~~~ - Alternate row color (use theme settings). Use different keys (e.g. page up/down) when more lists should be accessible. - Show at least four list view items at any time without the need for scrolling. - Make windows and the list within a dialog or utility window resizeable so that users can choose how many list items are visible at a time without scrolling. Make these windows remember last used dimensions. - If selections affect the appearance or control states, place these controls next to the list view. - Disable controls in a dialog if not in use rather than hide, or remove them from the list (i.e. they are dependent controls), - Label the list view with a descriptive caption to the top left (cf. :doc:`alignment `). - Create a buddy relation so access keys are assigned. - End each label with a colon. ":" - Use :doc:`sentence style capitalization ` for list view items. |desktopicon| Desktop ^^^^^^^^^^^^^^^^^^^^^ .. figure:: /img/Listview6.png :alt: Several different lists :scale: 40 % :figclass: border List items with and without icons List items can have a lot of different styles and sizes, but should always be coherent in a list. .. container:: flex .. container:: .. figure:: /img/Listview3.png :alt: Default padding of an item :scale: 40 % :figclass: border - Default padding of a swipelistitem on desktop + Default padding of a SwipeListItem on desktop Items have a padding of :doc:`Units.smallSpacing ` on the top and bottom and a padding of :doc:`2 * Units.smallSpacing ` on the left. .. container:: .. figure:: /img/Listview4.png :alt: Label is vertically centered :scale: 40 % :figclass: border Label is vertically centered Labels are vertically centered within the list item. If the list item includes an icon, add a :doc:`2 * Units.smallSpacing ` margin between the icon and the label. |mobileicon| Mobile ^^^^^^^^^^^^^^^^^^^ .. container:: flex .. container:: .. figure:: /img/Listview1.png :alt: Default padding of an item :scale: 50 % :figclass: border - Default padding of a swipelistitem on mobile + Default padding of a SwipeListItem on mobile Items have a padding of :doc:`Units.largeSpacing ` on the top and bottom and a padding of :doc:`2 * Units.largeSpacing ` on the left. .. container:: .. figure:: /img/Listview2.png :alt: Label is vertically centered :scale: 50 % :figclass: border Label is vertically centered Labels are vertically centered within the list item. If the list item includes an icon, add a :doc:`2 * Units.largeSpacing ` margin between the icon and the label. Selection ^^^^^^^^^ Checkboxes should be placed to the left of the item. .. figure:: /img/Listview5.png :alt: List items with checkboxes :scale: 40 % :figclass: border List items with checkboxes for multi selection. Add a :doc:`2 * Units.largeSpacing ` margin between the checkbox and the icon or the label. If you change the background color to toggle selection state, use Kirigami.Theme.highlightColor to indicate an active item. Picker ^^^^^^ -Place the button add items to the bottom right of list. +Place the button to add items to the bottom right of list. .. figure:: /img/ListPicker.png :alt: Picker :scale: 40 % :figclass: border Add button at the bottom right of a list -For deselection you can either add a remove button for seleted icons next to the -add button or use an icon on the list item. +For deselection you can either add a remove button for seleted icons next to +the add button or use an icon on the list item. .. figure:: /img/ListPickerRemoveItem.png :alt: Remove from a picker :scale: 40 % :figclass: border - Using an on demand pattern to display a remove icon. + Using an on-demand pattern to display a "Remove" icon. Ordering ^^^^^^^^ Code ---- Kirigami ~~~~~~~~ .. code-block:: qml ... ListView { ... delegate: Kirigami.SwipeListItem { id: lineItem contentItem: Row { spacing: lineItem.leftPadding Item { width: Kirigami.Units.iconSizes.medium height: width Image { id: avatar width: parent.width height: width source: "..." visible: false } OpacityMask { anchors.fill: avatar source: avatar maskSource: Rectangle { height: avatar.width width: height radius: height / 2 } } } Label { anchors.verticalCenter: parent.verticalCenter text: "..." } } actions: [ Kirigami.Action { text: i18n("&Make call") iconName: "call-start" }, Kirigami.Action { text: i18n("&Write mail") iconName: "mail-message" } ] } ... } ... diff --git a/source/patterns/content/picker.rst b/source/patterns/content/picker.rst index 24dd136..da4caa5 100644 --- a/source/patterns/content/picker.rst +++ b/source/patterns/content/picker.rst @@ -1,58 +1,58 @@ Picker ====== -Pickers are a pattern to select multiple items from a list of available -choises. The main component only displays the selected items. More items can be -added by choosing them from a list or grid in an dialog or overlay. +Pickers implement a pattern to select multiple items from a list of available +choices. The main component only displays the selected items, and more items +can be added by choosing them from a list or grid in a dialog or overlay. In compairison to dual lists, they work well on desktop and mobile. Example ------- .. figure:: /img/LanguagePicker.png :alt: Picker in Language KCM :scale: 60% Use of a picker to select aditional languages. When to use ----------- - Use a picker for multiple selection and in case of large lists. - Don't use it if both selected and unselected items need to be visible at once. Use a dual list instead. - Do not use a picker to show data primarily. - If selection state needs to change often, think about using a list with checkboxes or similar instead. How to use ---------- .. figure:: /img/PickerOverlay.png :alt: Using an overlay :scale: 60% Using an overlay to pick aditional items. - Use a :doc:`grid ` or a :doc:`list ` to display the selected elemets. - Open list of additional items to choose in a overlay sheet or a dialog - Allow the user to select multiple items at once. -- Use either an on demand control or display an button to allow the user +- Use either an on-demand control or display an button to allow the user to deselect items. - If the list of selected items can be reordered, place up/down buttons to the right of the list of current items. Only enable the up/down buttons when an item is selected and can be moved. - Do not have blank list items; use meta-options, (e.g. "None") instead. - Place options that represent general options (e.g. "All", "None") at the beginning of the list. - Sort list items in a logical order. Alphabetical sorting should be able to change when the text is translated. - If the lists or grids appears in a dialog, consider making the window and the lists or grids within it resizeable so that the user can choose how many list items are visible at a time without scrolling. - Use :doc:`sentence style capitalization ` for items.