org.homepage_widgets
====================

.. py:module:: org.homepage_widgets


Classes
-------

.. autoapisummary::

   org.homepage_widgets.RowWidget
   org.homepage_widgets.ColumnWidget
   org.homepage_widgets.TextWidget
   org.homepage_widgets.PanelWidget
   org.homepage_widgets.LinksWidget
   org.homepage_widgets.DirectoriesWidget
   org.homepage_widgets.NewsWidget
   org.homepage_widgets.CoverWidget
   org.homepage_widgets.EventsWidget
   org.homepage_widgets.TilesWidget
   org.homepage_widgets.HrWidget
   org.homepage_widgets.SliderWidget


Functions
---------

.. autoapisummary::

   org.homepage_widgets.get_lead


Module Contents
---------------

.. py:function:: get_lead(text: str, max_chars: int = 180, consider_sentences: bool = True) -> str

.. py:class:: RowWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="row">
                     <div class="row">
                         <xsl:apply-templates select="node()"/>
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: ColumnWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="column">
                     <div class="small-12 medium-{@span} columns">
                         <xsl:apply-templates select="node()"/>
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: TextWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="text">
                     <p class="homepage-text">
                         <xsl:apply-templates select="node()"/>
                     </p>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: PanelWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="panel">
                     <div class="side-panel requires-children">
                         <xsl:attribute name="data-required-children">
                             <xsl:value-of select="'a:not(.more-link)'"/>
                         </xsl:attribute>
                         <xsl:attribute name="data-required-count">
                             <xsl:value-of select="'1'"/>
                         </xsl:attribute>
                         <xsl:attribute name="data-required-unless">
                             <xsl:value-of select="'.is-logged-in'"/>
                         </xsl:attribute>
         
                         <xsl:apply-templates select="node()"/>
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: LinksWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="links">
                     <xsl:if test="@title">
                         <h2>
                             <xsl:value-of select="@title" />
                         </h2>
                     </xsl:if>
                     <ul class="panel-links">
                         <xsl:for-each select="link">
                         <li>
                             <a>
                                 <xsl:attribute name="href">
                                     <xsl:value-of select="@url" />
                                 </xsl:attribute>
         
                                 <xsl:value-of select="node()" />
                             </a>
         
                             <xsl:if test="@description">
                                 <small>
                                     <xsl:value-of select="@description" />
                                 </small>
                             </xsl:if>
                         </li>
                         </xsl:for-each>
                     </ul>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: DirectoriesWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="directories">
                     <metal:block use-macro="layout.macros['directories-panel']" />
                 </xsl:template>
             """

      .. raw:: html

         </details>




   .. py:method:: get_variables(layout: onegov.org.layout.DefaultLayout) -> onegov.core.types.RenderData


.. py:class:: NewsWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="news">
                     <div metal:use-macro="layout.macros.newslist"
                         tal:define="heading 'h3'; show_all_news_link True;
                         hide_date True"
                     />
                 </xsl:template>
             """

      .. raw:: html

         </details>




   .. py:method:: get_variables(layout: onegov.org.layout.DefaultLayout) -> onegov.core.types.RenderData


.. py:class:: CoverWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="homepage-cover">
                     <div class="homepage-content page-text">
                         <tal:block
                             content="structure layout.org.meta.get('homepage_cover')"
                         />
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: EventsWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="events">
                     <metal:block use-macro="layout.macros['events-panel']" />
                 </xsl:template>
             """

      .. raw:: html

         </details>




   .. py:method:: get_variables(layout: onegov.org.layout.DefaultLayout) -> onegov.core.types.RenderData


.. py:class:: TilesWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="homepage-tiles">
                     <xsl:choose>
                         <xsl:when test="@show-title">
                             <metal:block use-macro="layout.macros['homepage-tiles']"
                                tal:define="show_title True" />
                         </xsl:when>
                         <xsl:otherwise>
                             <metal:block use-macro="layout.macros['homepage-tiles']"
                               tal:define="show_title False" />
                         </xsl:otherwise>
                     </xsl:choose>
                 </xsl:template>
             """

      .. raw:: html

         </details>




   .. py:method:: get_variables(layout: onegov.org.layout.DefaultLayout) -> onegov.core.types.RenderData


   .. py:class:: Tile

      Bases: :py:obj:`NamedTuple`


      .. py:attribute:: page
         :type:  onegov.org.elements.Link


      .. py:attribute:: links
         :type:  collections.abc.Sequence[onegov.org.elements.Link]


      .. py:attribute:: number
         :type:  int



   .. py:method:: get_tiles(layout: onegov.org.layout.DefaultLayout) -> collections.abc.Iterator[Tile]


.. py:class:: HrWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="line">
                     <hr />
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: SliderWidget

   .. py:attribute:: template
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 <xsl:template match="slider">
                     <div metal:use-macro="layout.macros['slider']"
                     tal:define="height_m '{@height-m}';
                     height_d '{@height-d}'"
                     />
                 </xsl:template>
             """

      .. raw:: html

         </details>




   .. py:method:: get_images_from_sets(layout: onegov.org.layout.DefaultLayout) -> collections.abc.Iterator[onegov.core.types.RenderData]


   .. py:method:: get_variables(layout: onegov.org.layout.DefaultLayout) -> onegov.core.types.RenderData