cherrypy-foundation 1.0.0__py3-none-any.whl

cherrypy_foundation/components/Flash.jinja

@@ -0,0 +1,13 @@
+{# def messages, floating=False #}
+<div {{ attrs.render(class="flash-messages") }}>
+  {% for message, level in messages %}
+    <div class="alert alert-{{'danger' if level == 'error' else level }} alert-dismissible fade show"
+         role="alert">
+      {{ message }}
+      <button type="button"
+              class="btn-close"
+              data-bs-dismiss="alert"
+              aria-label="Close"></button>
+    </div>
+  {% endfor %}
+</div>

cherrypy_foundation/components/Icon.jinja

@@ -0,0 +1,3 @@
+{# def value #}
+{#css vendor/bootstrap-icons/bootstrap-icons.css #}
+<i {{ attrs.render(class="bi " + value) }} aria-hidden="true"></i>

cherrypy_foundation/components/LocaleSelection.jinja

@@ -0,0 +1,13 @@
+{# def header="Language selection" #}
+<li>
+  <h6 class="dropdown-header">{{ header }}</h6>
+</li>
+{% set cur_locale = get_translation().locale %}
+{% for locale in list_available_locales() %}
+  <li>
+    <button aria-pressed="{{ 'true' if cur_locale == locale else 'false' }}"
+            class="dropdown-item btn-locale{{ ' active' if cur_locale == locale else '' }}"
+            data-locale="{{ locale.language }}"
+            type="button">{{ locale.display_name.capitalize() }}</button>
+  </li>
+{% endfor %}

cherrypy_foundation/components/LocaleSelection.js

@@ -0,0 +1,26 @@
+/*
+ * Handle locale selection.
+ */
+document.addEventListener('DOMContentLoaded', function () {
+  const LOCALE_COOKIE_NAME = 'locale';
+  const ONE_YEAR = 60 * 60 * 24 * 365;
+
+  function setLocaleCookie(locale) {
+    document.cookie = `${LOCALE_COOKIE_NAME}=${locale}; path=/; max-age=${ONE_YEAR}; SameSite=Lax`;
+  }
+
+  function onLanguageClick(event) {
+    const locale = event.target.dataset.locale;
+    if (!locale) return;
+
+    setLocaleCookie(locale);
+
+    // Reload page so backend can use the new language
+    window.location.reload();
+  }
+
+  document.querySelectorAll('.btn-locale').forEach(btn => {
+    btn.addEventListener('click', onLanguageClick);
+  });
+  
+});

cherrypy_foundation/components/SideBySideMultiSelect.css

@@ -0,0 +1,25 @@
+/* Make Multi-wrapper similar to other bootstrap */
+.multi-wrapper {
+    border: 1px solid #ced4da;
+    border-radius: 0.375rem;
+    background: #ffffff;
+}
+
+.multi-wrapper .search-input,
+.multi-wrapper .non-selected-wrapper,
+.multi-wrapper .selected-wrapper {
+    background: none;
+    padding: 0.375rem 0.75rem;
+    overflow-y: auto;
+}
+
+.multi-wrapper .header {
+    padding: 1px;
+}
+
+.multi-wrapper .item {
+    padding: 1px;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+    overflow: hidden;
+}

cherrypy_foundation/components/SideBySideMultiSelect.jinja

@@ -0,0 +1,9 @@
+{# def field #}
+{# css vendor/multi/multi.css #}
+{# js vendor/multi/multi.js #}
+<select {{ attrs.render(name=field.name, class="multi", multiple=True, data_non_selected_header=_("Available") , data_selected_header=_("Selected"), data_search_placeholder=_("Filter...")) }}>
+  {% for choice in field.iter_choices() %}
+    {% set val, label, selected = choice[0:3] %}
+    <option {% if selected %}selected{% endif %} value="{{ val }}">{{ label }}</option>
+  {% endfor %}
+</select>

cherrypy_foundation/components/SideBySideMultiSelect.js

@@ -0,0 +1,9 @@
+/**
+ * DualList Widget configure with class="multi"
+ */
+jQuery(function () {
+    $('select.multi').each(function (_idx) {
+        const cfg = $(this).data();
+        $(this).multi(cfg);
+    });
+});

cherrypy_foundation/components/Typeahead.css

@@ -0,0 +1,55 @@
+/* Limit the height of the typeahead list */
+.typeahead__list {
+    max-height: 24em;
+    overflow: auto;
+}
+
+/* Fix location of spinning wheel */
+.typeahead__container.loading .typeahead__query::after,
+.typeahead__container.loading .typeahead__query::before {
+    top: 0.5rem;
+}
+
+/* Fix lense position */
+.typeahead__button button {
+    height: 100%;
+}
+
+/* Fix color for DarkMode */
+.typeahead__container button,
+.typeahead__container button.disabled,
+.typeahead__container button[disabled],
+.typeahead__container input.disabled,
+.typeahead__container input[disabled],
+.typeahead__container.hint .typeahead__field [contenteditable],
+.typeahead__container.hint .typeahead__field input,
+.typeahead__container.hint .typeahead__field textarea
+.typeahead__dropdown,
+.typeahead__field .typeahead__hint,
+.typeahead__field [contenteditable],
+.typeahead__field input,
+.typeahead__field textarea,
+.typeahead__list {
+    background-color: var(--bs-body-bg);
+}
+
+.typeahead__dropdown .typeahead__dropdown-item>a,
+.typeahead__list .typeahead__item>a,
+.typeahead__list.empty>li {
+    color: var(--bs-body-color);
+}
+
+.typeahead__dropdown .typeahead__dropdown-item>a>strong,
+.typeahead__list .typeahead__item>a>strong {
+    color: var(--bs-emphasis-color);
+}
+
+.typeahead__dropdown .typeahead__dropdown-item:not([disabled]).active>a,
+.typeahead__dropdown .typeahead__dropdown-item:not([disabled])>a:focus,
+.typeahead__dropdown .typeahead__dropdown-item:not([disabled])>a:hover,
+.typeahead__list .typeahead__item:not([disabled]).active>a,
+.typeahead__list .typeahead__item:not([disabled])>a:focus,
+.typeahead__list .typeahead__item:not([disabled])>a:hover {
+    background-color: var(--bs-tertiary-bg);
+    color: var(--bs-body-color);
+}

cherrypy_foundation/components/Typeahead.jinja

@@ -0,0 +1,106 @@
+{#def 
+accent=False, 
+async_result=False, 
+autofocus=False, 
+backdrop=False, 
+backdrop_on_focus=False, 
+blur_on_tab=True, 
+cache=False, 
+cancel_button=True, 
+compression=False, 
+correlative_template=False, 
+debug=False, 
+delay=300, 
+display=[], 
+dropdown_filter=False, 
+dynamic=False, 
+dynamic_filter=None, 
+empty_template=None, 
+filter=True, 
+generate_on_load=None, 
+group=False, 
+group_order=None, 
+group_template=None, 
+highlight=True, 
+hint=True, 
+href=None, 
+loading_animation=True, 
+matcher=None,
+max_item=8, 
+max_item_per_group=None, 
+max_length=None, 
+min_length=2, 
+multiselect=None, 
+must_select_item=False, 
+name="search", 
+offset=False, 
+order=None, 
+placeholder=None, 
+result_container=None, 
+search_on_focus=False, 
+source={}, 
+submit_button=True, 
+template=None, 
+template_value=None, 
+ttl=3600000, 
+#}
+{#css vendor/typeahead/jquery.typeahead.min.css #}
+{#js vendor/jquery/jquery.min.js, vendor/typeahead/jquery.typeahead.min.js #}
+<div class="typeahead__container">
+  <div class="typeahead__field">
+    <div class="typeahead__query">
+      <input {{ attrs.render(autocomplete="off",
+         autofocus=autofocus | tojson,
+         class="js-typeahead",
+         data_accent=accent | tojson,
+         data_async_result=async_result | tojson,
+         data_backdrop=backdrop | tojson,
+         data_backdrop_on_focus=backdrop_on_focus | tojson,
+         data_blur_on_tab=blur_on_tab | tojson,
+         data_cache=cache | tojson,
+         data_cancel_button=cancel_button | tojson,
+         data_compression=compression | tojson,
+         data_correlative_template=correlative_template | tojson,
+         data_debug=debug | tojson,
+         data_delay=delay,
+         data_display=display | tojson,
+         data_dropdown_filter=dropdown_filter | tojson,
+         data_dynamic=dynamic | tojson,
+         data_dynamic_filter=dynamic_filter | tojson,
+         data_empty_template=empty_template | tojson,
+         data_filter=filter | tojson,
+         data_generate_on_load=generate_on_load | tojson,
+         data_group=group | tojson,
+         data_group_order=group_order | tojson,
+         data_group_template=group_template | tojson,
+         data_highlight=highlight | tojson,
+         data_hint=hint | tojson,
+         data_href=href,
+         loading_animation=loading_animation | tojson,
+         data_max_item=max_item,
+         data_max_item_per_group=max_item_per_group,
+         data_max_length=max_length,
+         data_min_length=min_length,
+         data_multiselect=multiselect | tojson,
+         data_must_select_item=must_select_item | tojson,
+         data_offset=offset | tojson,
+         data_order=None,
+         data_result_container=result_container,
+         data_search_on_focus=search_on_focus | tojson,
+         data_source=source | tojson,
+         data_template=template,
+         data_template_value=template_value,
+         data_ttl=ttl,
+         name=name,
+         placeholder=placeholder or _('Search...') ,
+        ) }}>
+      </div>
+      <div class="typeahead__button">
+        {% if submit_button %}
+          <button type="submit">
+            <i class="fbi bi-search" aria-hidden="true"></i>
+          </button>
+        {% endif %}
+      </div>
+    </div>
+  </div>

cherrypy_foundation/components/Typeahead.js

@@ -0,0 +1,8 @@
+/* Initialize Typeahead */
+jQuery(function() {
+    $('.js-typeahead').each(function(_idx) {
+        const cfg = $(this).data();
+        const typeahead = $(this).typeahead(cfg);
+        $(this).data('typeahead', typeahead);
+    });
+});

cherrypy_foundation/components/__init__.py

@@ -0,0 +1,51 @@
+# Cherrypy-foundation
+# Copyright (C) 2026 IKUS Software
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+import importlib.resources
+
+import cherrypy
+
+RE_STATIC_MATCH = r"(\.js|\.css|\.png|\.woff|\.woff2|\.map)$"
+
+
+@cherrypy.config(
+    **{
+        'tools.auth.on': False,
+        'tools.auth_mfa.on': False,
+        'tools.i18n.on': False,
+        'tools.ratelimit.on': False,
+        'tools.secure_headers.on': False,
+        'tools.sessions.on': False,
+    }
+)
+class StaticMiddleware:
+
+    @cherrypy.expose
+    @cherrypy.tools.staticdir(match=RE_STATIC_MATCH, dir=str(importlib.resources.files(__package__)))
+    def default(self, *args, **kwargs):
+        """This entry point is used to serve content of /static/components/ folder and JinjaX static ressources"""
+        # Make use of JinjaX catalog
+        env = cherrypy.request.config.get('tools.jinja2.env')
+        if env is None or 'catalog' not in env.globals:
+            raise cherrypy.HTTPError(400)
+
+        # JinjaX resources could be locaed in multiple path.
+        section = cherrypy.serving.request.toolmaps['tools']['staticdir']['section']
+        jinjax_catalog = env.globals['catalog']
+        for path in jinjax_catalog.paths:
+            handled = cherrypy.lib.static.staticdir(section=section, match=RE_STATIC_MATCH, dir=path)
+            if handled:
+                return cherrypy.serving.response.body
+        raise cherrypy.HTTPError(400)

cherrypy_foundation/components/tests/test_static.py

@@ -0,0 +1,90 @@
+# CherryPy
+# Copyright (C) 2026 IKUS Software
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import importlib.resources
+
+import cherrypy
+from cherrypy.test import helper
+from parameterized import parameterized
+
+from .. import StaticMiddleware
+
+
+class Static:
+
+    components = StaticMiddleware()
+
+
+class Root:
+
+    static = Static()
+
+    @cherrypy.expose
+    def index(self):
+        return "OK"
+
+
+class StaticMiddlewareTest(helper.CPWebCase):
+    default_lang = None
+    interactive = False
+
+    @classmethod
+    def setup_server(cls):
+        cherrypy.config.update(
+            {
+                'tools.i18n.default': cls.default_lang,
+                'tools.i18n.mo_dir': importlib.resources.files(__package__) / 'locales',
+                'tools.i18n.domain': 'messages',
+            }
+        )
+        cherrypy.tree.mount(Root(), '/')
+
+    @parameterized.expand(
+        [
+            '/static/components/Datatable.css',
+            '/static/components/Datatable.js',
+            '/static/components/Field.css',
+            '/static/components/Field.js',
+            '/static/components/SideBySideMultiSelect.css',
+            '/static/components/SideBySideMultiSelect.js',
+            '/static/components/Typeahead.css',
+            '/static/components/Typeahead.js',
+            '/static/components/vendor/bootstrap5/css/bootstrap.min.css',
+            '/static/components/vendor/bootstrap5/js/bootstrap.min.js',
+            '/static/components/vendor/datatables-extensions/Buttons/css/buttons.dataTables.min.css',
+            '/static/components/vendor/datatables-extensions/Buttons/js/buttons.html5.min.js',
+            '/static/components/vendor/datatables-extensions/Buttons/js/dataTables.buttons.min.js',
+            '/static/components/vendor/datatables-extensions/FixedHeader/css/fixedHeader.dataTables.css',
+            '/static/components/vendor/datatables-extensions/FixedHeader/js/dataTables.fixedHeader.min.js',
+            '/static/components/vendor/datatables-extensions/JSZip/jszip.min.js',
+            '/static/components/vendor/datatables-extensions/pdfmake/build/pdfmake.min.js',
+            '/static/components/vendor/datatables-extensions/pdfmake/build/vfs_fonts.js',
+            '/static/components/vendor/datatables-extensions/Responsive/css/responsive.dataTables.min.css',
+            '/static/components/vendor/datatables-extensions/Responsive/js/dataTables.responsive.min.js',
+            '/static/components/vendor/datatables-extensions/rowgroup/css/rowGroup.dataTables.min.css',
+            '/static/components/vendor/datatables-extensions/rowgroup/js/dataTables.rowGroup.js',
+            '/static/components/vendor/datatables/css/dataTables.dataTables.css',
+            '/static/components/vendor/datatables/js/dataTables.min.js',
+            '/static/components/vendor/jquery/jquery.min.js',
+            '/static/components/vendor/popper/popper.min.js',
+            '/static/components/vendor/typeahead/jquery.typeahead.min.css',
+            '/static/components/vendor/typeahead/jquery.typeahead.min.js',
+            '/static/components/vendor/typeahead/jquery.typeahead.min.js',
+        ]
+    )
+    def test_static(self, url):
+        self.getPage(url)
+        self.assertStatus(200)