.. role:: clio-static
   :class: clio-flag clio-flag-static


####
List
####

.. js:class:: ui.list.List

   Provides a list view component for displaying sortable elements.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~ui.list.List.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~ui.list.List.styles`
   * :js:data:`~ui.list.List.list`
   * :js:data:`~ui.list.List.selected`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~ui.list.List.updateContext`
   * :js:meth:`~ui.list.List.updateSelected`
   * :js:meth:`~ui.list.List.render`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: ui.list.List.constructor

      .. rst-class:: sig-pretty-signature
      
         | List(): :js:class:`List <ui.list.List>`
      
      **Returns**\ : :js:class:`List <ui.list.List>`
      



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: ui.list.List.styles

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | styles: *CSSResult*\ []
      
      Array of styles to apply to the element. The styles should be defined using the ? tag function, via constructible stylesheets, or imported from native CSS module scripts.
      
      Note on Content Security Policy:
      
      Element styles are implemented with ``<style>`` tags when the browser doesn't support adopted StyleSheets. To use such ``<style>`` tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or ``nonce-<base64-value>`` with ``<base64-value>`` replaced be a server-generated nonce.
      
      To provide a nonce to use on generated ``<style>`` elements, set ``window.litNonce`` to a server-generated nonce in your page's HTML, before loading application code:
      
      .. code-block:: html
      
         <script>
           // Generated and unique per request:
           window.litNonce = 'a1b2c3d4';
         </script>
      



.. js:data:: ui.list.List.list

      .. rst-class:: sig-pretty-signature
      
         | list: :js:data:`ContextWrapper <ui.list.ContextWrapper>`
      
      Context wrapper providing list data access methods. Reassign to trigger updates.
      



.. js:data:: ui.list.List.selected

      .. rst-class:: sig-pretty-signature
      
         | selected: *number*\ []
      
      Array of selected element keys. Reassign to trigger updates.
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: ui.list.List.updateContext

      .. rst-class:: sig-pretty-signature
      
         | updateContext(): *void*
      
      Triggers a re-render by reassigning list context.
      
      **Returns**\ : *void*
      
      
         void
      
      



.. js:method:: ui.list.List.updateSelected

      .. rst-class:: sig-pretty-signature
      
         | updateSelected(): *void*
      
      Triggers a re-render by reassigning selected elements.
      
      **Returns**\ : *void*
      
      
         void
      
      



.. js:method:: ui.list.List.render

      .. rst-class:: sig-pretty-signature
      
         | render(): *unknown*
      
      Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ``ChildPart`` - typically a ``TemplateResult``\ . Setting properties inside this method will *not* trigger the element to update.
      
      **Returns**\ : *unknown*
      




