Allow user to pass extra props to components (#710)

Author: Dreamsorcerer

aiohttp_admin/routes.py

@@ -1,5 +1,6 @@
 """Setup routes for admin app."""
 
+import copy
 from pathlib import Path
 
 from aiohttp import web
@@ -29,18 +30,26 @@ def setup_resources(admin: web.Application, schema: Schema) -> None:
 
         repr_field = r.get("repr", m.primary_key)
 
-        for k, v in m.inputs.items():
-            if k not in omit_fields:
-                v["props"]["alwaysOn"] = "alwaysOn"  # Always display filter
+        # Don't modify the resource.
+        fields = copy.deepcopy(m.fields)
+        inputs = copy.deepcopy(m.inputs)
 
-        inputs = m.inputs.copy()  # Don't modify the resource.
         for name, validators in r.get("validators", {}).items():
             if not all(v[0] in _VALIDATORS for v in validators):
                 raise ValueError(f"First value in validators must be one of {_VALIDATORS}")
             inputs[name] = inputs[name].copy()
             inputs[name]["validators"] = tuple(inputs[name]["validators"]) + tuple(validators)
 
-        state = {"fields": m.fields, "inputs": inputs, "list_omit": tuple(omit_fields),
+        input_props = r.get("input_props", {})
+        for k, v in inputs.items():
+            if k not in omit_fields:
+                v["props"]["alwaysOn"] = "alwaysOn"  # Always display filter
+            v["props"].update(input_props.get(k, {}))
+
+        for name, props in r.get("field_props", {}).items():
+            fields[name]["props"].update(props)
+
+        state = {"fields": fields, "inputs": inputs, "list_omit": tuple(omit_fields),
                  "repr": repr_field, "label": r.get("label"), "icon": r.get("icon"),
                  "bulk_update": r.get("bulk_update", {})}
         admin["state"]["resources"][m.name] = state

aiohttp_admin/types.py

@@ -71,6 +71,10 @@ class _Resource(TypedDict, total=False):
     bulk_update: dict[str, dict[str, Any]]
     # Custom validators to add to inputs.
     validators: dict[str, Sequence[Sequence[Union[str, int]]]]
+    # Custom props to add to fields.
+    field_props: dict[str, dict[str, Any]]
+    # Custom props to add to inputs.
+    input_props: dict[str, dict[str, Any]]
 
 
 class Resource(_Resource):

tests/test_admin.py

@@ -103,3 +103,28 @@ def test_display_invalid() -> None:
 
     with pytest.raises(ValueError, match=r"Display includes non-existent field \('bar',\)"):
         aiohttp_admin.setup(app, schema)
+
+
+def test_extra_props() -> None:
+    app = web.Application()
+    model = DummyResource(
+        "test",
+        {"id": {"type": "TextField", "props": {"textAlign": "right", "placeholder": "foo"}}},
+        {"id": {"type": "TextInput", "props": {"resettable": False, "type": "text"},
+         "show_create": False, "validators": ()}},
+        "id")
+    schema: aiohttp_admin.Schema = {
+        "security": {"check_credentials": check_credentials},
+        "resources": ({
+            "model": model,
+            "field_props": {"id": {"textAlign": "left", "label": "Spam"}},
+            "input_props": {"id": {"type": "email", "multiline": True}}
+        },)}
+
+    admin = aiohttp_admin.setup(app, schema)
+
+    test_state = admin["state"]["resources"]["test"]
+    assert test_state["fields"]["id"]["props"] == {"textAlign": "left", "placeholder": "foo",
+                                                   "label": "Spam"}
+    assert test_state["inputs"]["id"]["props"] == {"alwaysOn": "alwaysOn", "type": "email",
+                                                   "multiline": True, "resettable": False}

tests/test_views.py

@@ -29,7 +29,7 @@ async def test_admin_view(admin_client: TestClient) -> None:
 
     r = state["resources"]["dummy"]
     assert r["list_omit"] == []
-    assert r["fields"] == {"id": {"type": "NumberField", "props": {"alwaysOn": "alwaysOn"}}}
+    assert r["fields"] == {"id": {"type": "NumberField", "props": {}}}
     assert r["inputs"] == {"id": {"type": "NumberInput", "props": {"alwaysOn": "alwaysOn"},
                                   "show_create": False, "validators": [["required"]]}}
     assert r["repr"] == "id"