Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions src/cf_ui/primitives.py
Original file line number Diff line number Diff line change
Expand Up @@ -799,6 +799,20 @@ def validate(component: str, **axes: Any) -> str:
#: A primitive not listed here has not adopted ``attrs`` yet.
RESERVED_ATTRS: dict[str, frozenset[str]] = {
"button": frozenset({"class", "type", "href", "role", "aria-disabled", "disabled"}),
"select": frozenset({"id", "name", "class", "aria-invalid", "aria-describedby"}),
"textarea": frozenset({"id", "name", "class", "rows", "aria-invalid", "aria-describedby"}),
"form-field": frozenset(
{
"id",
"name",
"class",
"type",
"value",
"required",
"aria-invalid",
"aria-describedby",
}
),
}


Expand Down Expand Up @@ -850,6 +864,34 @@ def render_attrs(component: str, attrs: dict[str, str] | None) -> _SafeAttrs:
character set, or one that collides with a name the component
already renders.
"""
if hasattr(attrs, "as_dict"):
# A real JinjaX ``Catalog`` render reaches here with a JinjaX
# ``HTMLAttrs`` object, not the plain dict the rest of this function
# expects: JinjaX reserves the prop name ``attrs`` for its own
# extra-kwargs collector and overwrites whatever a component's own
# `{#def}` declared for it (jinjax's ``catalog.py``, unconditionally,
# for every component). ``.as_dict`` is JinjaX's own escape hatch for
# this, and cf-ui's validation/escaping below applies identically
# once it holds a plain dict.
attrs = attrs.as_dict

elif hasattr(attrs, "attrs_dict"):
# The real django-cotton compiler reaches here with cotton's own
# ``Attrs`` object, not the plain dict this function expects — and
# the same reserved-name collision as JinjaX's ``HTMLAttrs`` above,
# from the other engine: cotton unconditionally binds the context's
# ``attrs`` variable to its own bag of *every* attribute passed to
# the component tag (django_cotton/templatetags/_component.py,
# ``"attrs": component_data["attrs"]`` set last, after the
# `<c-vars attrs="{}">` default). Naive iteration (``.items()``) on
# that bag — a ``Mapping`` — would see every declared prop too
# (``name``, ``type``, ...), which then collides with
# ``RESERVED_ATTRS`` on every call, not just an explicit
# ``attrs={...}`` one. ``.attrs_dict()`` is cotton's own escape
# hatch, already filtered down to the attributes ``<c-vars>``
# excluded from string output — i.e. exactly the true passthrough.
attrs = attrs.attrs_dict()

if not attrs:
return _SafeAttrs("")

Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/bootstrap/form-field.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
<div class="mb-3 {{ class }}">
<label class="form-label" for="{{ name }}">{{ label }}</label>
<input
Expand All @@ -7,6 +8,7 @@
name="{{ name }}"
value="{{ value }}"
{% if required == "true" %}required{% endif %}
{% cf_ui_render_attrs "form-field" attrs %}
>
{% if error %}<div class="invalid-feedback d-block">{{ error }}</div>{% endif %}
</div>
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/bootstrap/select.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{% load cf_ui %}
<div class="mb-3 {{ class }}">
<label class="form-label" for="{{ name }}">{{ label }}</label>
<select
class="form-select{% if error %} is-invalid{% endif %}{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
{% cf_ui_render_attrs "select" attrs %}
>
{% for opt in options %}
<option
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/bootstrap/textarea.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{% load cf_ui %}
<div class="mb-3 {{ class }}">
<label class="form-label" for="{{ name }}">{{ label }}</label>
<textarea
class="form-control{% if error %} is-invalid{% endif %}{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
rows="{{ rows }}"
{% cf_ui_render_attrs "textarea" attrs %}
>{{ value }}</textarea>
{% if error %}<div class="invalid-feedback d-block">{{ error }}</div>{% endif %}
</div>
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/bulma/form-field.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
<div class="field {{ class }}">
<label class="label" for="{{ name }}">{{ label }}</label>
<div class="control">
Expand All @@ -8,6 +9,7 @@
name="{{ name }}"
value="{{ value }}"
{% if required == "true" %}required{% endif %}
{% cf_ui_render_attrs "form-field" attrs %}
>
</div>
{% if error %}<p class="help is-danger">{{ error }}</p>{% endif %}
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/bulma/select.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
<div class="field {{ class }}">
<label class="label" for="{{ name }}">{{ label }}</label>
<div class="control">
Expand All @@ -6,6 +7,7 @@
id="{{ name }}"
name="{{ name }}"
{% if input_class %} class="{{ input_class }}"{% endif %}
{% cf_ui_render_attrs "select" attrs %}
>
{% for opt in options %}
<option
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/bulma/textarea.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
<div class="field {{ class }}">
<label class="label" for="{{ name }}">{{ label }}</label>
<div class="control">
Expand All @@ -6,6 +7,7 @@
id="{{ name }}"
name="{{ name }}"
rows="{{ rows }}"
{% cf_ui_render_attrs "textarea" attrs %}
>{{ value }}</textarea>
</div>
{% if error %}<p class="help is-danger">{{ error }}</p>{% endif %}
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/daisy/form-field.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
<div class="form-control {{ class }}">
<label class="label" for="{{ name }}"><span class="label-text">{{ label }}</span></label>
<input
Expand All @@ -7,6 +8,7 @@
name="{{ name }}"
value="{{ value }}"
{% if required == "true" %}required{% endif %}
{% cf_ui_render_attrs "form-field" attrs %}
>
{% if error %}<span class="label-text-alt text-error">{{ error }}</span>{% endif %}
</div>
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/daisy/select.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{% load cf_ui %}
<div class="form-control {{ class }}">
<label class="label" for="{{ name }}"><span class="label-text">{{ label }}</span></label>
<select
class="select select-bordered w-full{% if error %} select-error{% endif %}{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
{% cf_ui_render_attrs "select" attrs %}
>
{% for opt in options %}
<option
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/daisy/textarea.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{% load cf_ui %}
<div class="form-control {{ class }}">
<label class="label" for="{{ name }}"><span class="label-text">{{ label }}</span></label>
<textarea
class="textarea textarea-bordered w-full{% if error %} textarea-error{% endif %}{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
rows="{{ rows }}"
{% cf_ui_render_attrs "textarea" attrs %}
>{{ value }}</textarea>
{% if error %}<span class="label-text-alt text-error">{{ error }}</span>{% endif %}
</div>
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/fomantic/form-field.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
{% comment %} Every Fomantic form rule is scoped `.ui.form .field`, so a standalone field
with no `.ui.form` ancestor is unstyled. The component carries its own, which
nests harmlessly inside a consumer's `
Expand All @@ -17,6 +18,7 @@
name="{{ name }}"
value="{{ value }}"
{% if required == "true" %}required{% endif %}
{% cf_ui_render_attrs "form-field" attrs %}
>
</div>
{% comment %} Not `<div class="ui error message">`: `.ui.form .error.message` is
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/fomantic/select.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
{% comment %} A real `<select>`, not Fomantic's `ui dropdown` widget. That widget is built
at runtime by a jQuery module cf-ui does not load, over a hidden select;
reproducing its DOM by hand would be a combobox nobody can drive. The
Expand All @@ -10,6 +11,7 @@
class="ui fluid selection dropdown{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
{% cf_ui_render_attrs "select" attrs %}
>
{% for opt in options %}
<option
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/fomantic/textarea.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
<div class="ui form {{ class }}">
<div class="field{% if error %} error{% endif %}">
<label for="{{ name }}">{{ label }}</label>
Expand All @@ -6,6 +7,7 @@
name="{{ name }}"
rows="{{ rows }}"
{% if input_class %} class="{{ input_class }}"{% endif %}
{% cf_ui_render_attrs "textarea" attrs %}
>{{ value }}</textarea>
{% if error %}<div class="ui basic red pointing prompt label">{{ error }}</div>{% endif %}
</div>
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/foundation/form-field.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
text without it renders an error nobody can see. These three classes are the
whole of what Foundation's Abide plugin does at runtime, so rendering them
server-side is a complete substitute for loading it. {% endcomment %}
{% load cf_ui %}
<div class="{{ class }}">
<label for="{{ name }}"{% if error %} class="is-invalid-label"{% endif %}>{{ label }}</label>
<input
Expand All @@ -12,6 +13,7 @@
value="{{ value }}"
{% if error %}aria-invalid="true" aria-describedby="{{ name }}-error"{% endif %}
{% if required == "true" %}required{% endif %}
{% cf_ui_render_attrs "form-field" attrs %}
>
{% if error %}
<span class="form-error is-visible" id="{{ name }}-error">{{ error }}</span>
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/foundation/select.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{% load cf_ui %}
<div class="{{ class }}">
<label for="{{ name }}"{% if error %} class="is-invalid-label"{% endif %}>{{ label }}</label>
<select
class="{% if error %}is-invalid-input{% endif %}{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
{% if error %}aria-invalid="true" aria-describedby="{{ name }}-error"{% endif %}
{% cf_ui_render_attrs "select" attrs %}
>
{% for opt in options %}
<option
Expand Down
2 changes: 2 additions & 0 deletions src/cf_ui/templates/cotton/_themes/foundation/textarea.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% load cf_ui %}
<div class="{{ class }}">
<label for="{{ name }}"{% if error %} class="is-invalid-label"{% endif %}>{{ label }}</label>
<textarea
Expand All @@ -6,6 +7,7 @@
name="{{ name }}"
rows="{{ rows }}"
{% if error %}aria-invalid="true" aria-describedby="{{ name }}-error"{% endif %}
{% cf_ui_render_attrs "textarea" attrs %}
>{{ value }}</textarea>
{% if error %}
<span class="form-error is-visible" id="{{ name }}-error">{{ error }}</span>
Expand Down
1 change: 1 addition & 0 deletions src/cf_ui/templates/cotton/cf/form-field.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
required="false"
input_class=""
class=""
attrs="{}"
/>
{% load cf_ui %}
{% cf_ui_theme_path "form-field" as cf_ui_partial %}
Expand Down
11 changes: 10 additions & 1 deletion src/cf_ui/templates/cotton/cf/select.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
<c-vars name label value="" error="" options="[]" input_class="" class="" />
<c-vars
name
label
value=""
error=""
options="[]"
input_class=""
class=""
attrs="{}"
/>
{% load cf_ui %}
{% cf_ui_theme_path "select" as cf_ui_partial %}
{% include cf_ui_partial %}
11 changes: 10 additions & 1 deletion src/cf_ui/templates/cotton/cf/textarea.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
<c-vars name label value="" error="" rows="4" input_class="" class="" />
<c-vars
name
label
value=""
error=""
rows="4"
input_class=""
class=""
attrs="{}"
/>
{% load cf_ui %}
{% cf_ui_theme_path "textarea" as cf_ui_partial %}
{% include cf_ui_partial %}
4 changes: 3 additions & 1 deletion src/cf_ui/templates/jinja/bootstrap/FormField.jinja
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{#def name, label, value="", error="", type="text", required=false, extra_class="", input_class="" #}
{#def name, label, value="", error="", type="text", required=false, extra_class="", input_class="", attrs={} #}
{% autoescape true %}
{% set value = value if value is defined else "" %}
{% set error = error if error is defined else "" %}
{% set type = type if type is defined else "text" %}
{% set required = required if required is defined else false %}
{% set extra_class = extra_class if extra_class is defined else "" %}
{% set input_class = input_class if input_class is defined else "" %}
{% set attrs = attrs if attrs is defined else {} %}
<div class="mb-3 {{ extra_class }}">
<label class="form-label" for="{{ name }}">{{ label }}</label>
<input
Expand All @@ -15,6 +16,7 @@
name="{{ name }}"
value="{{ value }}"
{% if required %} required{% endif %}
{{- cf_ui_render_attrs("form-field", attrs) }}
>
{% if error %}<div class="invalid-feedback d-block">{{ error }}</div>{% endif %}
</div>
Expand Down
4 changes: 3 additions & 1 deletion src/cf_ui/templates/jinja/bootstrap/Select.jinja
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
{#def name, label, value="", error="", options=[], extra_class="", input_class="" #}
{#def name, label, value="", error="", options=[], extra_class="", input_class="", attrs={} #}
{% autoescape true %}
{% set value = value if value is defined else "" %}
{% set error = error if error is defined else "" %}
{% set options = options if options is defined else [] %}
{% set extra_class = extra_class if extra_class is defined else "" %}
{% set input_class = input_class if input_class is defined else "" %}
{% set attrs = attrs if attrs is defined else {} %}
<div class="mb-3 {{ extra_class }}">
<label class="form-label" for="{{ name }}">{{ label }}</label>
<select
class="form-select{% if error %} is-invalid{% endif %}{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
{{- cf_ui_render_attrs("select", attrs) }}
>
{% for opt in options %}
<option
Expand Down
4 changes: 3 additions & 1 deletion src/cf_ui/templates/jinja/bootstrap/Textarea.jinja
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
{#def name, label, value="", error="", rows=4, extra_class="", input_class="" #}
{#def name, label, value="", error="", rows=4, extra_class="", input_class="", attrs={} #}
{% autoescape true %}
{% set value = value if value is defined else "" %}
{% set error = error if error is defined else "" %}
{% set rows = rows if rows is defined else 4 %}
{% set extra_class = extra_class if extra_class is defined else "" %}
{% set input_class = input_class if input_class is defined else "" %}
{% set attrs = attrs if attrs is defined else {} %}
<div class="mb-3 {{ extra_class }}">
<label class="form-label" for="{{ name }}">{{ label }}</label>
<textarea
class="form-control{% if error %} is-invalid{% endif %}{% if input_class %} {{ input_class }}{% endif %}"
id="{{ name }}"
name="{{ name }}"
rows="{{ rows }}"
{{- cf_ui_render_attrs("textarea", attrs) }}
>{{ value }}</textarea>
{% if error %}<div class="invalid-feedback d-block">{{ error }}</div>{% endif %}
</div>
Expand Down
4 changes: 3 additions & 1 deletion src/cf_ui/templates/jinja/bulma/FormField.jinja
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{#def name, label, value="", error="", type="text", required=false, extra_class="", input_class="" #}
{#def name, label, value="", error="", type="text", required=false, extra_class="", input_class="", attrs={} #}
{% autoescape true %}
{% set attrs = attrs if attrs is defined else {} %}
<div class="field {{ extra_class }}">
<label class="label" for="{{ name }}">{{ label }}</label>
<div class="control">
Expand All @@ -10,6 +11,7 @@
name="{{ name }}"
value="{{ value }}"
{% if required %} required{% endif %}
{{- cf_ui_render_attrs("form-field", attrs) }}
>
</div>
{% if error %}<p class="help is-danger">{{ error }}</p>{% endif %}
Expand Down
4 changes: 3 additions & 1 deletion src/cf_ui/templates/jinja/bulma/Select.jinja
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{#def name, label, value="", error="", options=[], extra_class="", input_class="" #}
{#def name, label, value="", error="", options=[], extra_class="", input_class="", attrs={} #}
{% autoescape true %}
{% set attrs = attrs if attrs is defined else {} %}
<div class="field {{ extra_class }}">
<label class="label" for="{{ name }}">{{ label }}</label>
<div class="control">
Expand All @@ -8,6 +9,7 @@
id="{{ name }}"
name="{{ name }}"
{% if input_class %} class="{{ input_class }}"{% endif %}
{{- cf_ui_render_attrs("select", attrs) }}
>
{% for opt in options %}
<option
Expand Down
Loading
Loading