django-admin-inline-controls 0.1.0__py3-none-any.whl

django_admin_inline_controls/templates/django_admin_inline_controls/footer.html

@@ -0,0 +1,99 @@
+{% load i18n %}
+{% comment %}
+  Footer below the inline: pagination or infinite-scroll status and the
+  save-inline button. Override per inline with
+  `inline_controls_footer_template`. The JS moves this element to the end
+  of the inline and relies on the data-inline-controls-* attributes.
+{% endcomment %}
+{% block footer %}
+  {% if controls.has_footer %}
+    <div class="inline-controls-footer{% if controls.mode == 'infinite' %} inline-controls-infinite{% endif %}{% block footer_classes %}{% endblock %}">
+      {% block footer_start %}{% endblock %}
+
+      {% block footer_rows %}
+        {% if controls.summary_rows %}
+          <div class="inline-controls-footer-rows" data-inline-controls-footer-rows>
+            {% for row in controls.summary_rows %}
+              {% block footer_row %}
+                <div class="inline-controls-footer-row" data-label="{{ row.label }}">
+                  <span class="inline-controls-footer-label">{{ row.label }}:</span>
+                  {% for cell in row.cells %}
+                    {% block footer_cell %}
+                      <span class="inline-controls-footer-cell" data-column="{{ cell.column }}" data-footer-key="{{ forloop.parentloop.counter0 }}:{{ cell.column }}" data-footer-row="{{ row.label }}" data-value="{{ cell.raw }}">
+                        <span class="inline-controls-footer-column">{{ cell.column_label }}</span>
+                        <span class="inline-controls-footer-value">{{ cell.value }}</span>
+                      </span>
+                    {% endblock footer_cell %}
+                  {% endfor %}
+                </div>
+              {% endblock footer_row %}
+            {% endfor %}
+          </div>
+        {% endif %}
+      {% endblock footer_rows %}
+
+      {% block pagination %}
+        {% if controls.paginator %}
+          {% if controls.mode == "infinite" %}
+            {% block infinite %}
+              {% block infinite_count %}
+                <span class="inline-controls-count">
+                  {% blocktranslate with loaded=controls.loaded_count|default:0 total=controls.total_count %}Showing {{ loaded }} of {{ total }}{% endblocktranslate %}
+                </span>
+              {% endblock infinite_count %}
+              {% block load_more %}
+                {% if controls.next_page_url %}
+                  <a href="{{ controls.next_page_url }}" class="inline-controls-load-more" data-inline-controls-more>{% block load_more_label %}{% translate "Load more" %}{% endblock %}</a>
+                {% endif %}
+              {% endblock load_more %}
+            {% endblock infinite %}
+          {% else %}
+            {% block page_links %}
+              <nav class="inline-controls-pagination" aria-label="{% translate 'Pagination' %}">
+                {% if controls.is_paginated %}
+                  {% for link in controls.page_links %}
+                    {% block page_link %}
+                      {% if link.url is None %}
+                        <span class="inline-controls-ellipsis">{{ link.number }}</span>
+                      {% elif link.current %}
+                        <span class="inline-controls-page inline-controls-current" aria-current="page">{{ link.number }}</span>
+                      {% else %}
+                        <a href="{{ link.url }}" class="inline-controls-page" data-inline-controls-nav>{{ link.number }}</a>
+                      {% endif %}
+                    {% endblock page_link %}
+                  {% endfor %}
+                {% endif %}
+              </nav>
+            {% endblock page_links %}
+            {% block result_count %}
+              <span class="inline-controls-count">
+                {% blocktranslate count counter=controls.total_count %}{{ counter }} result{% plural %}{{ counter }} results{% endblocktranslate %}
+              </span>
+            {% endblock result_count %}
+          {% endif %}
+        {% endif %}
+      {% endblock pagination %}
+
+      {% block save %}
+        {% if controls.save_url %}
+          <div class="inline-controls-save">
+            {% block save_status %}
+              <span class="inline-controls-status" role="status" aria-live="polite"></span>
+            {% endblock save_status %}
+            {% block save_button %}
+              <button type="button" class="button default" data-inline-controls-save title="{% translate 'Saves only this inline. Other changes on the page are kept but not saved.' %}">{% block save_label %}{{ controls.save_label }}{% endblock %}</button>
+            {% endblock save_button %}
+          </div>
+        {% endif %}
+      {% endblock save %}
+
+      {% block row_actions_status %}
+        {% if controls.has_row_actions %}
+          <span class="inline-controls-row-actions-status"><span class="inline-controls-status" role="status" aria-live="polite"></span></span>
+        {% endif %}
+      {% endblock row_actions_status %}
+
+      {% block footer_end %}{% endblock %}
+    </div>
+  {% endif %}
+{% endblock footer %}

django_admin_inline_controls/templates/django_admin_inline_controls/inline.html

@@ -0,0 +1,34 @@
+{% comment %}
+  Wrapper around the inline's own template. Override per inline with
+  `inline_controls_template` (e.g. a template that extends this one).
+  The JS relies on the id, the data-inline-controls attribute and the
+  inline-controls-* classes: keep them when overriding blocks.
+{% endcomment %}
+{% load inline_controls %}
+{% with controls=inline_admin_formset.formset.inline_controls opts=inline_admin_formset.opts %}
+  {% if controls %}
+    {% block container %}
+      <div class="inline-controls{% block container_classes %}{% endblock %}" id="{{ controls.container_id }}" data-inline-controls="{{ controls.config_json }}"{% block container_attrs %}{% endblock %}>
+        {% block before_toolbar %}{% endblock %}
+        {% block toolbar %}
+          {% include opts.inline_controls_toolbar_template %}
+        {% endblock toolbar %}
+        {% block before_inline %}{% endblock %}
+        {% block inline %}
+          {# The inline's own template, with the footer rows as its <tfoot>. #}
+          {% inline_controls_render_inline opts.inline_controls_inner_template %}
+        {% endblock inline %}
+        {% block after_inline %}{% endblock %}
+        {% block footer %}
+          {% include opts.inline_controls_footer_template %}
+        {% endblock footer %}
+        {% block after_footer %}{% endblock %}
+      </div>
+    {% endblock container %}
+  {% else %}
+    {% block inline_without_controls %}
+      {# The add view: the footer rows' <tfoot> has no values yet. #}
+      {% inline_controls_render_inline opts.inline_controls_inner_template %}
+    {% endblock inline_without_controls %}
+  {% endif %}
+{% endwith %}

django_admin_inline_controls/templates/django_admin_inline_controls/inline_response.html

@@ -0,0 +1,14 @@
+{% comment %}
+  Response of the save-inline and action endpoints: the re-rendered inline
+  plus its status. The JS reads the id and the data-status/data-message
+  attributes.
+{% endcomment %}
+{% block response %}
+  <div id="{{ prefix }}-inline-controls-response" data-status="{{ status }}" data-message="{{ message }}">
+    {% block inlines %}
+      {% for inline_admin_formset in inline_admin_formsets %}
+        {% include inline_admin_formset.opts.template %}
+      {% endfor %}
+    {% endblock inlines %}
+  </div>
+{% endblock response %}

django_admin_inline_controls/templates/django_admin_inline_controls/row_actions.html

@@ -0,0 +1,19 @@
+{% comment %}
+  The action buttons of one saved row (`obj`), in the inline's "Actions"
+  column. Each action has `name`, `label`, `css_classes`, `attrs`,
+  `confirmation` and, for "view", `url`. The JS relies on the
+  data-inline-controls-row-action* attributes. Shown once the JS is ready.
+{% endcomment %}
+{% block row_actions %}
+  <span class="inline-controls-row-actions" data-inline-controls-row-actions hidden>
+    {% for action in actions %}
+      {% block row_action %}
+        {% if action.url %}
+          <a href="{{ action.url }}" role="button" class="button inline-controls-row-action {{ action.css_classes }}" data-inline-controls-row-link="{{ action.name }}" {{ action.attrs }}>{{ action.label }}</a>
+        {% else %}
+          <button type="button" class="button inline-controls-row-action {{ action.css_classes }}" data-inline-controls-row-action="{{ action.name }}" data-pk="{{ obj.pk }}"{% if action.confirmation %} data-confirmation="{{ action.confirmation }}"{% endif %} {{ action.attrs }}>{{ action.label }}</button>
+        {% endif %}
+      {% endblock row_action %}
+    {% endfor %}
+  </span>
+{% endblock row_actions %}

django_admin_inline_controls/templates/django_admin_inline_controls/tfoot.html

@@ -0,0 +1,36 @@
+{% comment %}
+  The footer rows as the <tfoot> of a tabular inline's table, one cell per
+  column. Rendered by the server, no JS. Override per inline with
+  `inline_footer_tfoot_template` (e.g. a template that extends this one);
+  format the values with `format_inline_footer_value()`.
+  data-footer-key / data-footer-row / data-column / data-value (the number,
+  unformatted) are there for the page's own JS.
+{% endcomment %}
+{% block tfoot %}
+  <tfoot class="inline-controls-tfoot">
+    {% for row in tfoot_rows %}
+      {% block tfoot_row %}
+        <tr class="inline-controls-tfoot-row" data-footer-row="{{ row.label }}">
+          {% if row.label_colspan %}
+            <th scope="row" colspan="{{ row.label_colspan }}">
+              {% block tfoot_label %}<span class="inline-controls-footer-label">{{ row.label }}</span>{% endblock %}
+            </th>
+          {% endif %}
+          {% for slot in row.cells %}
+            {% block tfoot_cell %}
+              {% if slot.cell %}
+                <td class="inline-controls-footer-value field-{{ slot.cell.column }}">
+                  {% if slot.label_here %}<span class="inline-controls-footer-label">{{ row.label }}</span>{% endif %}
+                  <span class="inline-controls-footer-number" data-footer-key="{{ slot.key }}" data-footer-row="{{ row.label }}" data-column="{{ slot.cell.column }}" data-value="{{ slot.cell.raw }}">{% block tfoot_value %}{{ slot.cell.value }}{% endblock %}</span>
+                </td>
+              {% else %}
+                <td></td>
+              {% endif %}
+            {% endblock tfoot_cell %}
+          {% endfor %}
+          {% if row.trailing %}<td colspan="{{ row.trailing }}"></td>{% endif %}
+        </tr>
+      {% endblock tfoot_row %}
+    {% endfor %}
+  </tfoot>
+{% endblock tfoot %}

django_admin_inline_controls/templates/django_admin_inline_controls/toolbar.html

@@ -0,0 +1,93 @@
+{% load i18n %}
+{% comment %}
+  Toolbar above the inline: actions, filters and (for stacked inlines, or
+  columns without a header) sort links. Override per inline with
+  `inline_controls_toolbar_template`. The JS moves this element under the
+  inline's heading and relies on the data-inline-controls-* attributes.
+{% endcomment %}
+{% block toolbar %}
+  {% if controls.has_toolbar %}
+    <div class="inline-controls-toolbar{% block toolbar_classes %}{% endblock %}">
+      {% block toolbar_start %}{% endblock %}
+
+      {% block actions %}
+        {% if controls.bulk_actions %}
+          <div class="inline-controls-actions">
+            {% block action_menu %}
+              <label>
+                {% block action_label %}{% translate "Action:" %}{% endblock %}
+                <select name="action" form="{{ controls.actions_form_id }}" data-inline-controls-action>
+                  {% block action_empty_option %}<option value="">---------</option>{% endblock %}
+                  {% for action in controls.bulk_actions %}
+                    {% block action_option %}<option value="{{ action.name }}">{{ action.description }}</option>{% endblock %}
+                  {% endfor %}
+                </select>
+              </label>
+            {% endblock action_menu %}
+            {% block action_button %}
+              <button type="button" class="button" data-inline-controls-run title="{% translate 'Run the selected action' %}">{% block action_button_label %}{% translate "Go" %}{% endblock %}</button>
+            {% endblock action_button %}
+            {% block action_selection %}
+              <span class="inline-controls-selection" data-inline-controls-selection></span>
+              <a href="#" class="inline-controls-select-across" data-inline-controls-select-across hidden></a>
+            {% endblock action_selection %}
+            {% block action_status %}
+              <span class="inline-controls-status" role="status" aria-live="polite"></span>
+            {% endblock action_status %}
+          </div>
+        {% endif %}
+      {% endblock actions %}
+
+      {% block filters %}
+        {% if controls.filter_form %}
+          <div class="inline-controls-filters" role="search">
+            {% block filter_fields %}
+              {% for field in controls.filter_form %}
+                {% block filter_field %}
+                  <div class="inline-controls-filter{% if field.errors %} errors{% endif %}">
+                    {{ field.label_tag }}
+                    {{ field }}
+                    {{ field.errors }}
+                  </div>
+                {% endblock filter_field %}
+              {% endfor %}
+            {% endblock filter_fields %}
+            {% block filter_buttons %}
+              <div class="inline-controls-filter-buttons">
+                {% block filter_apply_button %}
+                  <button type="button" class="button" data-inline-controls-apply>{% block filter_apply_label %}{% translate "Filter" %}{% endblock %}</button>
+                {% endblock filter_apply_button %}
+                {% block filter_clear_button %}
+                  {% if controls.is_filtered %}
+                    <button type="button" class="button" data-inline-controls-clear>{% block filter_clear_label %}{% translate "Clear" %}{% endblock %}</button>
+                  {% endif %}
+                {% endblock filter_clear_button %}
+              </div>
+            {% endblock filter_buttons %}
+          </div>
+        {% endif %}
+      {% endblock filters %}
+
+      {% block ordering %}
+        {% if controls.ordering_columns %}
+          <div class="inline-controls-ordering">
+            {% block ordering_label %}<span class="inline-controls-ordering-label">{% translate "Sort by:" %}</span>{% endblock %}
+            {% for column in controls.ordering_columns %}
+              {% block ordering_column %}
+                <span class="inline-controls-sort{% if column.direction %} inline-controls-{{ column.direction }}{% endif %}">
+                  <a href="{{ column.toggle_url }}" class="inline-controls-sort-toggle" data-inline-controls-nav title="{% translate 'Toggle sorting' %}">{{ column.label }}</a>
+                  {% if column.priority %}
+                    <span class="inline-controls-sort-priority">{{ column.priority }}</span>
+                    <a href="{{ column.remove_url }}" class="inline-controls-sort-remove" data-inline-controls-nav title="{% translate 'Remove from sorting' %}">&times;</a>
+                  {% endif %}
+                </span>
+              {% endblock ordering_column %}
+            {% endfor %}
+          </div>
+        {% endif %}
+      {% endblock ordering %}
+
+      {% block toolbar_end %}{% endblock %}
+    </div>
+  {% endif %}
+{% endblock toolbar %}

django_admin_inline_controls/templatetags/inline_controls.py

@@ -0,0 +1,72 @@
+"""Server-side rendering of the footer rows inside the inline's own table."""
+
+from __future__ import annotations
+
+import re
+
+from django import template
+from django.utils.safestring import SafeString, mark_safe
+
+from django_admin_inline_controls.controls import empty_footer_rows, layout_tfoot_rows
+
+register = template.Library()
+
+
+def _header_columns(html: str) -> tuple[dict[str, int], int]:
+    """Position of each field's column in the table's header row (its
+    ``th.column-<name>``), and the row's width, as rendered: the leading
+    columns (Django's narrow "original" one) and the trailing ones vary with
+    the Django version, the theme and the delete permission. Hidden headers
+    take no room."""
+    head = re.search(r"<thead.*?</thead>", html, re.S)
+    positions: dict[str, int] = {}
+    width = 0
+    for attrs in re.findall(r"<th\b([^>]*)>", head.group() if head else ""):
+        classes = re.search(r'class="([^"]*)"', attrs)
+        names = classes.group(1).split() if classes else []
+        if "hidden" in names:
+            continue
+        for name in names:
+            if name.startswith("column-"):
+                positions.setdefault(name.removeprefix("column-"), width)
+        span = re.search(r'colspan="(\d+)"', attrs)
+        width += int(span.group(1)) if span else 1
+    return positions, width
+
+
+@register.simple_tag(takes_context=True)
+def inline_controls_render_inline(
+    context: template.Context, template_name: str
+) -> SafeString:
+    """Render the inline's template (Django's, a theme's or your own) and, if
+    it has a table, insert the footer rows as its <tfoot> — no JS, and no
+    copy of Django's template to keep in sync."""
+    engine = context.template.engine  # type: ignore[union-attr]
+    html = engine.get_template(template_name).render(context)
+    controls = context.get("controls")
+    formset = context["inline_admin_formset"]
+    if not formset.opts.inline_footer_tfoot:
+        return mark_safe(html)
+    if controls:
+        footer_rows = controls.footer_rows
+    else:
+        # The add view: the rows' structure, without values.
+        request = getattr(formset.formset, "inline_controls_request", None)
+        footer_rows = empty_footer_rows(formset.opts, request)
+    # Last in the table: if it has its own <tfoot> (Unfold's "Add another"),
+    # that one stays the table's footer and these rows show above it.
+    position = html.rfind("</table>")
+    rows = (
+        layout_tfoot_rows(footer_rows, *_header_columns(html))
+        if footer_rows and position != -1
+        else None
+    )
+    if not rows:
+        return mark_safe(html)
+    with context.push(tfoot_rows=rows):
+        tfoot = engine.get_template(formset.opts.inline_footer_tfoot_template).render(
+            context
+        )
+    if controls:
+        controls.tfoot_rendered = True
+    return mark_safe(html[:position] + tfoot + html[position:])

django_admin_inline_controls/types.py

@@ -0,0 +1,40 @@
+"""Type aliases used across the package."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping, Sequence
+from typing import TYPE_CHECKING, Any, TypeAlias
+
+from django.db.models import QuerySet
+from django.db.models.expressions import BaseExpression
+from django.forms import Form
+
+if TYPE_CHECKING:
+    from django_admin_inline_controls.mixins import InlineActionSpec
+
+#: How a column is ordered: a field path, an ORM expression or an explicit
+#: ``(ascending, descending)`` pair.
+OrderingValue: TypeAlias = str | BaseExpression | tuple[Any, Any]
+#: ``inline_ordering_fields``: column names, or ``{column: OrderingValue}``.
+OrderingFields: TypeAlias = Sequence[str] | Mapping[str, OrderingValue]
+#: The current ordering: ``(column, descending)`` pairs, primary first.
+Ordering: TypeAlias = list[tuple[str, bool]]
+#: What filtering returns: the bound filter form (if any) and the queryset.
+FilterResult: TypeAlias = tuple[Form | None, QuerySet]
+#: ``inline_controls_selectors``: CSS selector(s) per key, tried in order.
+Selectors: TypeAlias = Mapping[str, str | Sequence[str]]
+#: ``inline_footer_rows``: ``(label, {column: value})`` pairs, a value being
+#: an aggregate (``Sum("pages")``), a ``callable(queryset)`` or a constant.
+FooterRows: TypeAlias = Sequence[tuple[Any, Mapping[str, Any]]]
+#: Actions available to a user, keyed by name.
+InlineActions: TypeAlias = "dict[str, InlineActionSpec]"
+
+__all__ = [
+    "FilterResult",
+    "FooterRows",
+    "InlineActions",
+    "Ordering",
+    "OrderingFields",
+    "OrderingValue",
+    "Selectors",
+]