town6.homepage_widgets
======================

.. py:module:: town6.homepage_widgets


Classes
-------

.. autoapisummary::

   town6.homepage_widgets.RowWidget
   town6.homepage_widgets.RowWidgetWide
   town6.homepage_widgets.ColumnWidget
   town6.homepage_widgets.TitleWidget
   town6.homepage_widgets.AutoplayVideoWidget
   town6.homepage_widgets.RandomVideosWidget
   town6.homepage_widgets.IconLinksWidget
   town6.homepage_widgets.TextWidget
   town6.homepage_widgets.LinksWidget
   town6.homepage_widgets.NewsWidget
   town6.homepage_widgets.EventCard
   town6.homepage_widgets.EventsWidget
   town6.homepage_widgets.PartnerWidget
   town6.homepage_widgets.ServicesWidget
   town6.homepage_widgets.ContactsAndAlbumsWidget
   town6.homepage_widgets.DirectoriesWidget
   town6.homepage_widgets.FocusWidget
   town6.homepage_widgets.TestimonialsWidget
   town6.homepage_widgets.TestimonialSliderWidget
   town6.homepage_widgets.JobsWidget
   town6.homepage_widgets.RSSItem
   town6.homepage_widgets.RSSChannel


Functions
---------

.. autoapisummary::

   town6.homepage_widgets.parsed_rss


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

.. 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="grid-container">
                         <div class="grid-x grid-padding-x {@class}">
                             <xsl:apply-templates select="node()"/>
                         </div>
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: RowWidgetWide

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="row-wide">
                     <div class="grid-container full {@bgcolor}">
                         <div class="grid-x {@class}">
                             <xsl:apply-templates select="node()"/>
                         </div>
                     </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} cell">
                         <xsl:apply-templates select="node()"/>
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: TitleWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="title">
                     <h3 class="{@class}">
                         <xsl:apply-templates select="node()"/>
                     </h3>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: AutoplayVideoWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="autoplay_video">
                     <div metal:use-macro="layout.macros.autoplay_video"
                     tal:define="max_height '{@max-height}'; link_mp4 '{@link_mp4}';
                     link_mp4_low_res '{@link_mp4_low_res}';
                     link_webm '{@link_webm}'; button_url '{@button_url}';
                     link_webm_low_res '{@link_webm_low_res}'; text '{@text}';
                     button_text '{@button_text}';
                     "
                     />
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: RandomVideosWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="random_videos">
                     <div id="random-video">
                         <xsl:apply-templates select="node()" />
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: IconLinksWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="icon_link">
                     <div metal:use-macro="layout.macros.icon_link"
                     tal:define="
                         title '{@title}'; invert '{@invert}'; icon '{@icon}';
                         text '{@text}'; link '{@link}';
                     "
                     />
                 </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:: LinksWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="links">
                     <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:: NewsWidget

   Bases: :py:obj:`onegov.org.homepage_widgets.NewsWidget`


   .. py:attribute:: news_limit
      :value: 3



   .. 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 'h5'; show_all_news_link True;
                         hide_date False"
                     />
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: EventCard

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: text
      :type:  str


   .. py:attribute:: url
      :type:  str


   .. py:attribute:: subtitle
      :type:  str


   .. py:attribute:: image_url
      :type:  str | None


   .. py:attribute:: location
      :type:  str | None


   .. py:attribute:: lead
      :type:  str


.. 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['event-cards']"
                     tal:define="with_lead True" />
                 </xsl:template>
             """

      .. raw:: html

         </details>




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


.. py:class:: PartnerWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="partners">
                     <xsl:variable name="apos">'</xsl:variable>
                     <xsl:variable name="show_title">
                         <xsl:choose>
                              <xsl:when test="@hide-title">
                                 <xsl:value-of
                                 select="'False'" />
                             </xsl:when>
                              <xsl:otherwise>
                                 <xsl:value-of select="'True'" />
                             </xsl:otherwise>
                         </xsl:choose>
                     </xsl:variable>
                     <metal:block use-macro="layout.macros['partner-cards']">
                     <xsl:attribute name="tal:define">
                     <xsl:value-of
                     select="concat(
                         'title ',
                         $apos,
                         @title,
                         $apos,
                         '; ',
                         'show_title ',
                         $show_title,
                         ';')" />
                   </xsl:attribute>
                     </metal:block>
                 </xsl:template>
             """

      .. raw:: html

         </details>




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


.. py:class:: ServicesWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="services">
                     <div class="services-panel">
                         <ul class="panel-links callout">
                             <li tal:repeat="link services_panel.links">
                                 <tal:b content="structure link(layout)" />
                             </li>
                             <xsl:for-each select="link">
                                 <li tal:define="icon '{@icon}'">
                                     <a tal:attributes="
                                         class ('h5 fa fa-' + icon) if icon
                                               else 'generic h5'
                                         ">
                                         <xsl:attribute name="href">
                                             <xsl:value-of select="@url" />
                                         </xsl:attribute>
                                         <xsl:value-of select="node()" />
                                     </a>
                                 </li>
                             </xsl:for-each>
                         </ul>
                     </div>
                 </xsl:template>
             """

      .. raw:: html

         </details>




   .. py:method:: get_service_links(layout: onegov.town6.layout.DefaultLayout) -> collections.abc.Iterator[onegov.org.elements.Link]


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


.. py:class:: ContactsAndAlbumsWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                    <xsl:template match="contacts_and_albums">
                       <div class="contacts-albums-panel">
                         <metal:block use-macro="layout.macros['panel-links']"
                            tal:define="panel contacts_and_albums_panel;
                            classes ['more-list']"
                         />
                       </div>
                    </xsl:template>
                """

      .. raw:: html

         </details>




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


.. py:class:: DirectoriesWidget

   Bases: :py:obj:`onegov.org.homepage_widgets.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-list']" />
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: FocusWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
             <xsl:template match="focus">
                 <a href="{@focus-url}" class="focus-link">
                     <div class="focus-widget card" data-aos="fade">
                         <xsl:if test="@text-on-image = 'True'">
                             <xsl:attribute name="class">focus-widget card only-title
                             </xsl:attribute>
                         </xsl:if>
                         <xsl:variable name="apos">'</xsl:variable>
                         <xsl:variable name="image_src">
                             <xsl:choose>
                                     <xsl:when test="@image-src">
                                     <xsl:value-of
                                     select="concat($apos, @image-src, $apos)" />
                                 </xsl:when>
                                     <xsl:otherwise>
                                     <xsl:value-of select="'None'" />
                                 </xsl:otherwise>
                             </xsl:choose>
                         </xsl:variable>
                         <metal:block use-macro="layout.macros['focus-panel']"
                         tal:define="image_src '{@image-src}'; title '{@title}';
                          text_on_image '{@text-on-image}'; lead '{@lead}';"
                         />
                         <xsl:choose>
                             <xsl:when test="@text-on-image">
                                 <xsl:if test="text">
                                     <div class="card-section">
                                         <xsl:for-each select="text">
                                             <p class="homepage-text">
                                                 <xsl:apply-templates select="node()"/>
                                             </p>
                                         </xsl:for-each>
                                     </div>
                                 </xsl:if>
                             </xsl:when>
                             <xsl:otherwise>
                             <div class="card-section">
                                 <h5>
                                     <xsl:choose>
                                         <xsl:when test="@title">
                                             <xsl:value-of select="@title" />
                                         </xsl:when>
                                         <xsl:otherwise>
                                             <metal:block
                                             use-macro="layout.macros['focus-title']" />
                                         </xsl:otherwise>
                                     </xsl:choose>
                                 </h5>
                                 <xsl:choose>
                                     <xsl:when test="@lead">
                                         <p><b>
                                             <xsl:value-of select="@lead" />
                                         </b></p>
                                     </xsl:when>
                                     <xsl:otherwise> </xsl:otherwise>
                                 </xsl:choose>
                                 <xsl:for-each select="text">
                                     <p class="homepage-text">
                                         <xsl:apply-templates select="node()"/>
                                     </p>
                                 </xsl:for-each>
                             </div>
                             </xsl:otherwise>
                         </xsl:choose>
                     </div>
                 </a>
             </xsl:template>
             """

      .. raw:: html

         </details>




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


.. py:class:: TestimonialsWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="testimonial">
                     <div metal:use-macro="layout.macros.testimonial"
                      tal:define="description '{@description}'; quote '{@quote}';
                      image '{@image}';
                      "
                     />
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: TestimonialSliderWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
                 <xsl:template match="testimonial_slider">
                     <div metal:use-macro="layout.macros.testimonial_slider"
                      tal:define="color '{@color}';
                      description_1 '{@description_1}';
                      quote_1 '{@quote_1}'; image_1 '{@image_1}';
                      description_2 '{@description_2}';
                      quote_2 '{@quote_2}'; image_2 '{@image_2}';
                      description_3 '{@description_3}';
                      quote_3 '{@quote_3}'; image_3 '{@image_3}';
                      "
                     />
                 </xsl:template>
             """

      .. raw:: html

         </details>




.. py:class:: JobsWidget

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

      .. raw:: html

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

      .. code-block:: python

         """
             <xsl:template match="jobs">
                 <div metal:use-macro="layout.macros['jobs-cards']"
                 tal:define="jobs_card_title '{@jobs_card_title}';
                 rss_feed '{@rss_feed}';
                 "
                 />
             </xsl:template>
             """

      .. raw:: html

         </details>




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


.. py:class:: RSSItem

   Bases: :py:obj:`NamedTuple`


   The elements inside <item> 


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: description
      :type:  str


   .. py:attribute:: guid
      :type:  str


   .. py:attribute:: pubDate
      :type:  datetime.datetime | None


.. py:class:: RSSChannel

   Bases: :py:obj:`NamedTuple`


   The elements inside <channel> 


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: link
      :type:  str


   .. py:attribute:: description
      :type:  str


   .. py:attribute:: language
      :type:  str


   .. py:attribute:: copyright
      :type:  str


   .. py:attribute:: items
      :type:  collections.abc.Iterator[RSSItem]


.. py:function:: parsed_rss(rss: bytes) -> RSSChannel