Compare commits
46
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0450f8ecd6 | ||
|
|
19c574edb0 | ||
|
|
e78ec14e2e | ||
|
|
fb3ef7d2b9 | ||
|
|
49ac96b487 | ||
|
|
214c80663e | ||
|
|
84caee9f72 | ||
|
|
c992d7f3b9 | ||
|
|
17bfb4a3f7 | ||
|
|
15b8923e60 | ||
|
|
354244f755 | ||
|
|
3e2fa4a419 | ||
|
|
50546ecf22 | ||
|
|
99d62ef748 | ||
|
|
68452681f8 | ||
|
|
0cc4f52816 | ||
|
|
eb13ab0b5e | ||
|
|
fa49164143 | ||
|
|
cf3c773f86 | ||
|
|
4b54c25943 | ||
|
|
e7645d1ba5 | ||
|
|
29b5f85952 | ||
|
|
c077c27720 | ||
|
|
e2fc7a8f15 | ||
|
|
355a5a841c | ||
|
|
96deab7d58 | ||
|
|
e9886361d2 | ||
|
|
8ebe461435 | ||
|
|
2002529137 | ||
|
|
bd7c8593d9 | ||
|
|
0c414680fd | ||
|
|
e211e1376d | ||
|
|
74418ca6b9 | ||
|
|
5df8c93420 | ||
|
|
ebf9c12446 | ||
|
|
ca4ddd2b12 | ||
|
|
dff3e210ab | ||
|
|
37bbda1da1 | ||
|
|
a37da15008 | ||
|
|
cff3854e63 | ||
|
|
1bb3e0360f | ||
|
|
4e4b30e812 | ||
|
|
0e177ca2ec | ||
|
|
367a07c15d | ||
|
|
983a581555 | ||
|
|
b34feb8e98 |
No files matched your search
+67
-7
@@ -41,6 +41,14 @@ from .data_loader import get_data_info as get_db_info
|
||||
from . import flags
|
||||
from .places import build_place_index, build_place_registry, places_for_urn
|
||||
from .schemas import METRIC_DEFINITIONS, PHASE_GROUPS, RANKING_COLUMNS, SCHOOL_COLUMNS
|
||||
from .school_groups import (
|
||||
FAITH_GROUPS,
|
||||
FAITH_KEYS,
|
||||
TYPE_GROUPS,
|
||||
faith_groups_for,
|
||||
type_group_for,
|
||||
type_group_key,
|
||||
)
|
||||
from .nearby_schools import select_nearby
|
||||
from .utils import clean_for_json, convert_to_native
|
||||
|
||||
@@ -608,6 +616,15 @@ def verify_admin_api_key(x_api_key: str = Header(None)) -> bool:
|
||||
|
||||
|
||||
# Input validation helpers
|
||||
def _names_in_group(names: pd.Series, in_group) -> set:
|
||||
"""The distinct names in a column that a group predicate accepts.
|
||||
|
||||
Evaluated once per distinct name rather than per row, so a filter over
|
||||
every school costs a few dozen lookups.
|
||||
"""
|
||||
return {n for n in names.dropna().unique() if in_group(n)}
|
||||
|
||||
|
||||
def sanitize_search_input(value: Optional[str], max_length: int = 100) -> Optional[str]:
|
||||
"""Sanitize search input to prevent injection attacks."""
|
||||
if value is None:
|
||||
@@ -736,7 +753,7 @@ async def get_schools(
|
||||
None, description="Filter by local authority", max_length=100
|
||||
),
|
||||
school_type: Optional[str] = Query(None, description="Filter by school type", max_length=100),
|
||||
phase: Optional[str] = Query(None, description="Filter by phase: primary, secondary, all-through", max_length=50),
|
||||
phase: Optional[str] = Query(None, description="Filter by phase: primary or secondary (grouped), or any GIAS phase name (exact)", max_length=50),
|
||||
postcode: Optional[str] = Query(None, description="Search near postcode", max_length=10),
|
||||
radius: float = Query(5.0, ge=0.1, le=5, description="Search radius in miles"),
|
||||
page: int = Query(1, ge=1, le=1000, description="Page number"),
|
||||
@@ -744,6 +761,7 @@ async def get_schools(
|
||||
gender: Optional[str] = Query(None, description="Filter by gender (Mixed/Boys/Girls)", max_length=50),
|
||||
admissions_policy: Optional[str] = Query(None, description="Filter by admissions policy", max_length=100),
|
||||
has_sixth_form: Optional[str] = Query(None, description="Filter by sixth form presence: yes/no", max_length=3),
|
||||
faith: Optional[str] = Query(None, description="Filter by faith group key", max_length=40),
|
||||
):
|
||||
"""
|
||||
Get list of schools with pagination.
|
||||
@@ -756,6 +774,7 @@ async def get_schools(
|
||||
local_authority = sanitize_search_input(local_authority)
|
||||
school_type = sanitize_search_input(school_type)
|
||||
phase = sanitize_search_input(phase)
|
||||
faith = sanitize_search_input(faith)
|
||||
postcode = validate_postcode(postcode)
|
||||
|
||||
# Load the pre-computed latest-year snapshot (cached after first request / startup).
|
||||
@@ -771,11 +790,13 @@ async def get_schools(
|
||||
|
||||
# Phase filter — uses PHASE_GROUPS so all-through/middle schools appear
|
||||
# in the correct phase(s) rather than being invisible to both filters.
|
||||
# Any other GIAS phase (nursery, 16 plus, middle deemed ...) is an exact
|
||||
# match. It must never fall through to no filter: the search page offers
|
||||
# every phase, and "Nursery" used to return the whole result set.
|
||||
if phase:
|
||||
phase_lower = phase.lower().replace("_", "-")
|
||||
allowed = PHASE_GROUPS.get(phase_lower)
|
||||
if allowed:
|
||||
df_latest = df_latest[df_latest["phase"].str.lower().isin(allowed)]
|
||||
allowed = PHASE_GROUPS.get(phase_lower, {phase_lower})
|
||||
df_latest = df_latest[df_latest["phase"].fillna("").str.lower().isin(allowed)]
|
||||
|
||||
# Secondary-specific filters (after phase filter)
|
||||
if gender:
|
||||
@@ -794,6 +815,22 @@ async def get_schools(
|
||||
flag = df_latest["age_range"].str.contains("18", na=False)
|
||||
df_latest = df_latest[flag if has_sixth_form == "yes" else ~flag]
|
||||
|
||||
# Faith group (backend/school_groups.py). A joint school is in every faith
|
||||
# its label names; a missing religious character is "none". An unknown key
|
||||
# matches nothing rather than being ignored, so a typo cannot show all.
|
||||
if faith:
|
||||
faith_key = faith.lower()
|
||||
if faith_key in FAITH_KEYS and "religious_denomination" in df_latest.columns:
|
||||
column = df_latest["religious_denomination"]
|
||||
matches = column.isin(_names_in_group(column, lambda n: faith_key in faith_groups_for(n)))
|
||||
# _names_in_group skips missing names; a missing religious
|
||||
# character is "No religious character".
|
||||
if faith_key == "none":
|
||||
matches = matches | column.isna()
|
||||
df_latest = df_latest[matches]
|
||||
else:
|
||||
df_latest = df_latest.iloc[0:0]
|
||||
|
||||
# Include key result metrics for display on cards
|
||||
location_cols = ["latitude", "longitude"]
|
||||
result_cols = [
|
||||
@@ -881,10 +918,17 @@ async def get_schools(
|
||||
schools_df["local_authority"].str.lower() == local_authority.lower()
|
||||
]
|
||||
|
||||
# A type group key (backend/school_groups.py), old keys included, or for
|
||||
# an old link a raw GIAS type label, matched exactly as before.
|
||||
if school_type:
|
||||
schools_df = schools_df[
|
||||
schools_df["school_type"].str.lower() == school_type.lower()
|
||||
]
|
||||
type_key = type_group_key(school_type)
|
||||
if type_key:
|
||||
column = schools_df["school_type"]
|
||||
schools_df = schools_df[
|
||||
column.isin(_names_in_group(column, lambda n: type_group_for(n) == type_key))
|
||||
]
|
||||
else:
|
||||
schools_df = schools_df[schools_df["school_type"].str.lower() == school_type.lower()]
|
||||
|
||||
# Compute result-scoped filter values (before pagination).
|
||||
# Gender and admissions are secondary-only filters — scope them to schools
|
||||
@@ -1159,6 +1203,8 @@ async def get_filter_options(request: Request):
|
||||
"local_authorities": [],
|
||||
"school_types": [],
|
||||
"years": [],
|
||||
"school_type_groups": [],
|
||||
"faiths": [],
|
||||
}
|
||||
|
||||
# Phases: return values from data, ordered sensibly
|
||||
@@ -1168,6 +1214,18 @@ async def get_filter_options(request: Request):
|
||||
genders = clean_filter_values(secondary_df["gender"]) if "gender" in secondary_df.columns else []
|
||||
admissions_policies = clean_filter_values(secondary_df["admissions_policy"]) if "admissions_policy" in secondary_df.columns else []
|
||||
|
||||
def offered(groups, present):
|
||||
return [{"value": key, "label": label} for key, label, _ in groups if key in present]
|
||||
|
||||
type_groups_present = (
|
||||
{type_group_for(n) for n in df["school_type"].dropna().unique()} - {None}
|
||||
if "school_type" in df.columns else set()
|
||||
)
|
||||
faiths_present = (
|
||||
{f for n in df["religious_denomination"].unique() for f in faith_groups_for(n)}
|
||||
if "religious_denomination" in df.columns else set()
|
||||
)
|
||||
|
||||
return {
|
||||
"local_authorities": clean_filter_values(df["local_authority"]) if "local_authority" in df.columns else [],
|
||||
"school_types": clean_filter_values(df["school_type"]) if "school_type" in df.columns else [],
|
||||
@@ -1175,6 +1233,8 @@ async def get_filter_options(request: Request):
|
||||
"phases": phases,
|
||||
"genders": genders,
|
||||
"admissions_policies": admissions_policies,
|
||||
"school_type_groups": offered(TYPE_GROUPS, type_groups_present),
|
||||
"faiths": offered(FAITH_GROUPS, faiths_present),
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
"""Parent-facing groups over GIAS establishment types and religious characters.
|
||||
|
||||
The 34 GIAS establishment types describe governance and funding, which for a
|
||||
mainstream state school barely changes what a parent experiences. The search
|
||||
filter offers five groups a parent recognises instead, and a faith filter in
|
||||
place of the faith signal that "Voluntary aided" and "Voluntary controlled"
|
||||
only half carry. See
|
||||
docs/superpowers/specs/2026-10-02-school-type-groups-and-faith-filter-design.md.
|
||||
|
||||
Groups are defined over GIAS codes and looked up by the translated name,
|
||||
because the DataFrame the API filters carries names only: the codes are
|
||||
replaced at load (data_loader.translate_gias_code_columns), the legacy-name
|
||||
mart fallback never had them, and test fixtures are written in names.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import pandas as pd
|
||||
|
||||
from .gias_codes import RELIGIOUS_CHARACTER, SCHOOL_TYPE
|
||||
|
||||
# (key, label, GIAS TypeOfEstablishment codes), in the order shown.
|
||||
TYPE_GROUPS: tuple[tuple[str, str, frozenset[int]], ...] = (
|
||||
# Every mainstream state school, academy or council-run: Academy sponsor
|
||||
# led, Academy converter, Free schools, University technical college,
|
||||
# Studio schools, City technology college, Community, Voluntary aided,
|
||||
# Voluntary controlled, Foundation, LA nursery. Academy against council-run
|
||||
# was two near-halves of one pool, and did not follow the difference a
|
||||
# parent feels most, admissions: voluntary aided and foundation schools
|
||||
# set their own, as academies do. Faith, which voluntary aided mostly
|
||||
# meant, has its own filter.
|
||||
("state", "State school (free)",
|
||||
frozenset({28, 34, 35, 40, 41, 6, 1, 2, 3, 5, 15})),
|
||||
("independent", "Independent (fee-paying)", frozenset({11})),
|
||||
# Every special type, independent ones included (usually funded by the
|
||||
# council through an EHCP, so SEND provision to a parent, not private
|
||||
# school), and Special post 16 institutions.
|
||||
("special", "Special school (SEND)", frozenset({7, 8, 10, 12, 32, 33, 36, 44})),
|
||||
# Further education, Sixth form centres, the 16-19 academies and free schools.
|
||||
("post16", "Sixth form or college", frozenset({18, 31, 39, 45, 46})),
|
||||
# Pupil referral units and AP academies and free schools. Last: parents do
|
||||
# not apply to these; the local authority places children there.
|
||||
("alternative", "Alternative provision", frozenset({14, 38, 42, 43})),
|
||||
)
|
||||
|
||||
# In no group, so reachable only under "Any school type": Secure units,
|
||||
# Miscellaneous, Higher education institutions, Online provider, Institution
|
||||
# funded by other government department, Academy secure 16 to 19.
|
||||
UNOFFERED_TYPE_CODES: frozenset[int] = frozenset({24, 27, 29, 49, 56, 57})
|
||||
|
||||
# (key, label, GIAS ReligiousCharacter codes), in the order shown. A joint
|
||||
# school is in every faith its label names; a generic "Christian" beside a
|
||||
# named church adds nothing.
|
||||
FAITH_GROUPS: tuple[tuple[str, str, frozenset[int]], ...] = (
|
||||
# Does not apply, None, and 99 (a blank label).
|
||||
("none", "No religious character", frozenset({0, 6, 99})),
|
||||
("church_of_england", "Church of England",
|
||||
frozenset({2, 9, 10, 11, 12, 13, 19, 20, 30, 31, 32, 33, 34, 41, 48})),
|
||||
("roman_catholic", "Roman Catholic", frozenset({3, 11, 13, 35, 48})),
|
||||
# 28 "Inter- / non- denominational" is how GIAS files Christian schools
|
||||
# tied to no one church.
|
||||
("other_christian", "Other Christian",
|
||||
frozenset({4, 8, 9, 10, 12, 14, 15, 16, 17, 18, 19, 22, 26, 28, 30, 33,
|
||||
37, 38, 39, 40, 41, 44, 45, 46, 47})),
|
||||
("jewish", "Jewish", frozenset({5, 36, 43})),
|
||||
("muslim", "Muslim", frozenset({7, 42, 49})),
|
||||
("other_faith", "Other faith", frozenset({21, 24, 25, 29})),
|
||||
)
|
||||
|
||||
TYPE_GROUP_KEYS: frozenset[str] = frozenset(k for k, _, _ in TYPE_GROUPS)
|
||||
|
||||
# Keys a group was offered under before, so their links keep working: "state"
|
||||
# was "academy" and "council" until 2026-10-02.
|
||||
TYPE_GROUP_ALIASES: dict[str, str] = {"academy": "state", "council": "state"}
|
||||
FAITH_KEYS: frozenset[str] = frozenset(k for k, _, _ in FAITH_GROUPS)
|
||||
|
||||
|
||||
def _key(name: str) -> str:
|
||||
return name.strip().lower()
|
||||
|
||||
|
||||
_TYPE_GROUP_BY_NAME: dict[str, str] = {
|
||||
_key(SCHOOL_TYPE[code]): key
|
||||
for key, _, codes in TYPE_GROUPS
|
||||
for code in codes
|
||||
if code in SCHOOL_TYPE
|
||||
}
|
||||
|
||||
_FAITHS_BY_NAME: dict[str, tuple[str, ...]] = {}
|
||||
for _faith, _, _codes in FAITH_GROUPS:
|
||||
for _code in sorted(_codes):
|
||||
if _code in RELIGIOUS_CHARACTER:
|
||||
_name = _key(RELIGIOUS_CHARACTER[_code])
|
||||
_FAITHS_BY_NAME[_name] = _FAITHS_BY_NAME.get(_name, ()) + (_faith,)
|
||||
|
||||
|
||||
def type_group_key(value: str) -> Optional[str]:
|
||||
"""The type group a school_type URL value names, old keys included, or
|
||||
None when it names no group (an old link's raw GIAS type)."""
|
||||
v = value.strip().lower()
|
||||
v = TYPE_GROUP_ALIASES.get(v, v)
|
||||
return v if v in TYPE_GROUP_KEYS else None
|
||||
|
||||
|
||||
def type_group_for(name: object) -> Optional[str]:
|
||||
"""The type group of a GIAS establishment type name, or None."""
|
||||
if not isinstance(name, str):
|
||||
return None
|
||||
return _TYPE_GROUP_BY_NAME.get(_key(name))
|
||||
|
||||
|
||||
def faith_groups_for(name: object) -> tuple[str, ...]:
|
||||
"""The faith groups of a GIAS religious character name.
|
||||
|
||||
A missing or blank name is "No religious character". A name the
|
||||
dictionary does not know has no faith, so it matches no faith option.
|
||||
"""
|
||||
if not isinstance(name, str):
|
||||
return ("none",) if name is None or pd.isna(name) else ()
|
||||
return _FAITHS_BY_NAME.get(_key(name), ())
|
||||
@@ -0,0 +1,84 @@
|
||||
"""The /api/schools phase filter.
|
||||
|
||||
The search page offers every GIAS phase, but the filter only knew the three
|
||||
grouped ones (primary, secondary, all-through). Anything else — nursery,
|
||||
16 plus, the middle-deemed phases — fell through to no filter at all, so
|
||||
"Nursery" returned the whole result set, mostly primaries.
|
||||
"""
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
PHASES = {
|
||||
100001: "Nursery",
|
||||
100002: "Primary",
|
||||
100003: "Middle deemed primary",
|
||||
100004: "Secondary",
|
||||
100005: "Middle deemed secondary",
|
||||
100006: "16 plus",
|
||||
100007: "All-through",
|
||||
}
|
||||
|
||||
|
||||
def _schools_df() -> pd.DataFrame:
|
||||
base = {
|
||||
"local_authority": "Testshire",
|
||||
"school_type": "Academy",
|
||||
"address": "1 Test Street",
|
||||
"town": "Testtown",
|
||||
"postcode": "TS1 1AA",
|
||||
"religious_denomination": None,
|
||||
"age_range": "4-11",
|
||||
"has_sixth_form": None,
|
||||
"gender": "Mixed",
|
||||
"admissions_policy": None,
|
||||
"ofsted_grade": np.nan,
|
||||
"ofsted_date": None,
|
||||
"ofsted_framework": None,
|
||||
"latitude": 51.5,
|
||||
"longitude": -0.1,
|
||||
"year": 202425,
|
||||
"total_pupils": 300,
|
||||
"rwm_expected_pct": np.nan,
|
||||
"attainment_8_score": np.nan,
|
||||
}
|
||||
return pd.DataFrame([
|
||||
{**base, "urn": urn, "school_name": f"{phase} School", "phase": phase}
|
||||
for urn, phase in PHASES.items()
|
||||
])
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
def client(monkeypatch):
|
||||
from backend import app as app_module
|
||||
|
||||
monkeypatch.setattr(app_module, "load_latest_school_data", _schools_df)
|
||||
monkeypatch.setattr(app_module, "load_school_data", _schools_df)
|
||||
return TestClient(app_module.app, raise_server_exceptions=False)
|
||||
|
||||
|
||||
def _urns(client, phase):
|
||||
resp = client.get("/api/schools", params={"phase": phase})
|
||||
assert resp.status_code == 200, resp.text
|
||||
return sorted(s["urn"] for s in resp.json()["schools"])
|
||||
|
||||
|
||||
@pytest.mark.parametrize("phase, urn", [
|
||||
("nursery", 100001),
|
||||
("16 plus", 100006),
|
||||
("middle deemed primary", 100003),
|
||||
("middle deemed secondary", 100005),
|
||||
])
|
||||
def test_an_ungrouped_phase_matches_exactly(client, phase, urn):
|
||||
assert _urns(client, phase) == [urn]
|
||||
|
||||
|
||||
def test_grouped_phases_still_take_in_their_related_phases(client):
|
||||
assert _urns(client, "primary") == [100002, 100003, 100007]
|
||||
assert _urns(client, "secondary") == [100004, 100005, 100006, 100007]
|
||||
|
||||
|
||||
def test_an_unknown_phase_returns_nothing_rather_than_everything(client):
|
||||
assert _urns(client, "kindergarten") == []
|
||||
@@ -0,0 +1,112 @@
|
||||
"""Parent-facing groups over GIAS establishment types and religious characters.
|
||||
|
||||
Every GIAS code must be accounted for, so a new DfE code fails here instead of
|
||||
silently vanishing from the filter.
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import numpy as np
|
||||
import pytest
|
||||
import yaml
|
||||
|
||||
from backend.gias_codes import RELIGIOUS_CHARACTER, SCHOOL_TYPE
|
||||
from backend.school_groups import (
|
||||
FAITH_GROUPS,
|
||||
TYPE_GROUPS,
|
||||
UNOFFERED_TYPE_CODES,
|
||||
faith_groups_for,
|
||||
type_group_for,
|
||||
type_group_key,
|
||||
)
|
||||
|
||||
DBT_PROJECT = Path(__file__).resolve().parents[2] / "pipeline" / "transform" / "dbt_project.yml"
|
||||
|
||||
|
||||
def _non_england_codes() -> set[int]:
|
||||
return set(yaml.safe_load(DBT_PROJECT.read_text())["vars"]["non_england_school_type_codes"])
|
||||
|
||||
|
||||
def test_every_type_code_is_in_exactly_one_place():
|
||||
places = [codes for _, _, codes in TYPE_GROUPS] + [UNOFFERED_TYPE_CODES, _non_england_codes()]
|
||||
for code in SCHOOL_TYPE:
|
||||
homes = sum(code in p for p in places)
|
||||
assert homes == 1, f"type code {code} ({SCHOOL_TYPE[code]}) is in {homes} places"
|
||||
|
||||
|
||||
def test_every_religion_code_has_a_faith():
|
||||
for code, name in RELIGIOUS_CHARACTER.items():
|
||||
assert any(code in codes for _, _, codes in FAITH_GROUPS), f"{code} {name!r}"
|
||||
|
||||
|
||||
def test_type_groups_in_display_order():
|
||||
assert [k for k, _, _ in TYPE_GROUPS] == [
|
||||
"state", "independent", "special", "post16", "alternative"]
|
||||
|
||||
|
||||
def test_faiths_in_display_order():
|
||||
assert [k for k, _, _ in FAITH_GROUPS] == [
|
||||
"none", "church_of_england", "roman_catholic", "other_christian",
|
||||
"jewish", "muslim", "other_faith"]
|
||||
|
||||
|
||||
@pytest.mark.parametrize("name, group", [
|
||||
("Academy converter", "state"),
|
||||
("University technical college", "state"),
|
||||
("Voluntary aided school", "state"),
|
||||
("Local authority nursery school", "state"),
|
||||
("Other independent school", "independent"),
|
||||
("Other independent special school", "special"),
|
||||
("Special post 16 institution", "special"),
|
||||
("Further education", "post16"),
|
||||
("Pupil referral unit", "alternative"),
|
||||
("academy CONVERTER", "state"),
|
||||
])
|
||||
def test_type_group_by_name(name, group):
|
||||
assert type_group_for(name) == group
|
||||
|
||||
|
||||
@pytest.mark.parametrize("value, key", [
|
||||
("state", "state"),
|
||||
("Special", "special"),
|
||||
# The two state groups that preceded "state", kept so their links still work.
|
||||
("academy", "state"),
|
||||
("Council", "state"),
|
||||
("Community school", None),
|
||||
("", None),
|
||||
])
|
||||
def test_type_group_key_resolves_keys_and_old_keys(value, key):
|
||||
assert type_group_key(value) == key
|
||||
|
||||
|
||||
@pytest.mark.parametrize("name", [
|
||||
"Higher education institutions", "Miscellaneous", "Unknown (9999)", "Academy", "", None, np.nan,
|
||||
])
|
||||
def test_unoffered_or_unknown_types_have_no_group(name):
|
||||
assert type_group_for(name) is None
|
||||
|
||||
|
||||
@pytest.mark.parametrize("name, faiths", [
|
||||
("Roman Catholic/Church of England", ("church_of_england", "roman_catholic")),
|
||||
("Roman Catholic/Anglican", ("church_of_england", "roman_catholic")),
|
||||
("Church of England/Methodist", ("church_of_england", "other_christian")),
|
||||
("Church of England/Christian", ("church_of_england",)),
|
||||
("Catholic", ("roman_catholic",)),
|
||||
("Inter- / non- denominational", ("other_christian",)),
|
||||
("Orthodox Jewish", ("jewish",)),
|
||||
("Sunni Deobandi", ("muslim",)),
|
||||
("Hindu", ("other_faith",)),
|
||||
("Does not apply", ("none",)),
|
||||
("None", ("none",)),
|
||||
])
|
||||
def test_faiths_by_name(name, faiths):
|
||||
assert faith_groups_for(name) == faiths
|
||||
|
||||
|
||||
@pytest.mark.parametrize("missing", [None, np.nan, "", " "])
|
||||
def test_a_missing_religion_is_no_religious_character(missing):
|
||||
assert faith_groups_for(missing) == ("none",)
|
||||
|
||||
|
||||
def test_an_unknown_religion_has_no_faith():
|
||||
assert faith_groups_for("Unknown (77)") == ()
|
||||
@@ -0,0 +1,100 @@
|
||||
"""/api/schools school-type groups and faith filter, and their /api/filters lists."""
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
# urn -> (GIAS school type, GIAS religious character)
|
||||
SCHOOLS = {
|
||||
100001: ("Community school", "Does not apply"),
|
||||
100002: ("Voluntary aided school", "Roman Catholic"),
|
||||
100003: ("Academy converter", "Roman Catholic/Church of England"),
|
||||
100004: ("Community special school", None),
|
||||
100005: ("Academy special converter", "Church of England"),
|
||||
100006: ("Other independent school", "Jewish"),
|
||||
100007: ("Miscellaneous", ""),
|
||||
}
|
||||
|
||||
|
||||
def _schools_df() -> pd.DataFrame:
|
||||
base = {
|
||||
"local_authority": "Testshire", "address": "1 Test Street", "town": "Testtown",
|
||||
"postcode": "TS1 1AA", "age_range": "4-11", "has_sixth_form": None,
|
||||
"gender": "Mixed", "admissions_policy": None, "ofsted_grade": np.nan,
|
||||
"ofsted_date": None, "ofsted_framework": None, "latitude": 51.5,
|
||||
"longitude": -0.1, "year": 202425, "total_pupils": 300,
|
||||
"rwm_expected_pct": np.nan, "attainment_8_score": np.nan, "phase": "Primary",
|
||||
}
|
||||
return pd.DataFrame([
|
||||
{**base, "urn": urn, "school_name": f"School {urn}",
|
||||
"school_type": t, "religious_denomination": r}
|
||||
for urn, (t, r) in SCHOOLS.items()
|
||||
])
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
def client(monkeypatch):
|
||||
from backend import app as app_module
|
||||
|
||||
monkeypatch.setattr(app_module, "load_latest_school_data", _schools_df)
|
||||
monkeypatch.setattr(app_module, "load_school_data", _schools_df)
|
||||
return TestClient(app_module.app, raise_server_exceptions=False)
|
||||
|
||||
|
||||
def _urns(client, **params):
|
||||
resp = client.get("/api/schools", params={"page_size": 50, **params})
|
||||
assert resp.status_code == 200, resp.text
|
||||
return sorted(s["urn"] for s in resp.json()["schools"])
|
||||
|
||||
|
||||
@pytest.mark.parametrize("key, urns", [
|
||||
("state", [100001, 100002, 100003]),
|
||||
("academy", [100001, 100002, 100003]),
|
||||
("council", [100001, 100002, 100003]),
|
||||
("special", [100004, 100005]),
|
||||
("independent", [100006]),
|
||||
("Special", [100004, 100005]),
|
||||
])
|
||||
def test_a_type_group_key_filters_to_its_group(client, key, urns):
|
||||
assert _urns(client, school_type=key) == urns
|
||||
|
||||
|
||||
def test_a_raw_type_label_still_filters_exactly(client):
|
||||
assert _urns(client, school_type="Community school") == [100001]
|
||||
|
||||
|
||||
@pytest.mark.parametrize("key, urns", [
|
||||
("roman_catholic", [100002, 100003]),
|
||||
("church_of_england", [100003, 100005]),
|
||||
("none", [100001, 100004, 100007]),
|
||||
("jewish", [100006]),
|
||||
("Roman_Catholic", [100002, 100003]),
|
||||
])
|
||||
def test_faith_filters_to_its_group_joint_schools_included(client, key, urns):
|
||||
assert _urns(client, faith=key) == urns
|
||||
|
||||
|
||||
def test_an_unknown_faith_returns_nothing(client):
|
||||
assert _urns(client, faith="nonsense") == []
|
||||
|
||||
|
||||
def test_type_and_faith_combine(client):
|
||||
assert _urns(client, school_type="special", faith="church_of_england") == [100005]
|
||||
|
||||
|
||||
def test_filters_lists_only_groups_present_in_order(client):
|
||||
body = client.get("/api/filters").json()
|
||||
assert body["school_type_groups"] == [
|
||||
{"value": "state", "label": "State school (free)"},
|
||||
{"value": "independent", "label": "Independent (fee-paying)"},
|
||||
{"value": "special", "label": "Special school (SEND)"},
|
||||
]
|
||||
assert body["faiths"] == [
|
||||
{"value": "none", "label": "No religious character"},
|
||||
{"value": "church_of_england", "label": "Church of England"},
|
||||
{"value": "roman_catholic", "label": "Roman Catholic"},
|
||||
{"value": "jewish", "label": "Jewish"},
|
||||
]
|
||||
# The raw list is still there for anything that reads it.
|
||||
assert "Community school" in body["school_types"]
|
||||
@@ -44,6 +44,7 @@ Their previous implementations remain recoverable from Git history.
|
||||
| `nextjs-app/components/SchoolCard.tsx` and its CSS | Imported by its own tests, not application code. HomeView uses SchoolRow/SecondarySchoolRow. | Decide whether to retire the card design; if removed, remove its dedicated tests as well. Passing tests do not establish runtime use. |
|
||||
| `backend/database.py: get_db`, `get_db_session` | No remaining callers after removing the importer. Current code creates SessionLocal directly. | Either adopt these helpers during session-lifecycle cleanup or remove them; do not rewrite active sessions in a documentation change. |
|
||||
| `backend/schemas.py: COLUMN_MAPPINGS`, `NULL_VALUES`, `LA_CODE_TO_NAME` | No remaining Python consumers found after importer removal. Other constants in this module are active. | Remove individual constants after checking external data utilities; retain the module. |
|
||||
| `backend/app.py: result_filters` keys `school_types`, `phases`, `genders`, `admissions_policies` | Since 2026-10-02 FilterBar offers these from `/api/filters`, because options scoped to the results left only the chosen value on offer. Only `local_authorities` is still read. | Stop computing the four keys in a focused API change; keep `local_authorities`. |
|
||||
| `backend/config.py: data_dir`, `max_page_size`, `rate_limit_burst` | No active consumers found. `default_page_size` appears only in a branch that expects None, although the route supplies a concrete default. | Reconcile settings with route validation in a focused API change. |
|
||||
|
||||
## Legacy/manual paths requiring operational verification
|
||||
|
||||
@@ -0,0 +1,911 @@
|
||||
# School Type Groups and a Faith Filter Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Replace the School type filter's 34 GIAS types with six parent-facing groups, and add a Faith filter with eight options.
|
||||
|
||||
**Architecture:** A new backend module `backend/school_groups.py` holds both groupings as GIAS code sets and exposes lookups by the translated *name* (the DataFrame the API filters only carries names). `/api/schools` accepts a group key for `school_type` and a new `faith` key; `/api/filters` gains `school_type_groups` and `faiths` as `{value, label}` lists. The frontend's FilterBar reads those lists for its School type select and a new Faith select.
|
||||
|
||||
**Tech Stack:** FastAPI + pandas (backend, pytest via uv), Next.js 15 / React (frontend, Jest + Testing Library), Playwright (E2E against staging).
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-10-02-school-type-groups-and-faith-filter-design.md`
|
||||
|
||||
## Global Constraints
|
||||
|
||||
- Type group keys, labels and order, verbatim: `academy` "State school: academy or free school", `council` "State school: council-run", `independent` "Independent (fee-paying)", `special` "Special school (SEND)", `post16` "Sixth form or college", `alternative` "Alternative provision".
|
||||
- Faith keys, labels and order, verbatim: `none` "No religious character", `church_of_england` "Church of England", `roman_catholic` "Roman Catholic", `other_christian` "Other Christian", `jewish` "Jewish", `muslim` "Muslim", `other_faith` "Other faith".
|
||||
- Select defaults, verbatim: "Any school type", "Any faith or none". Faith select `aria-label="Faith"`.
|
||||
- `/api/filters` keeps `school_types` (raw list) unchanged; the new keys are additions.
|
||||
- An old raw-label `school_type` value (e.g. `Community school`) still filters by that label exactly.
|
||||
- An unknown `faith` key returns no schools.
|
||||
- Do not change `backend/gias_codes.py` or `pipeline/scripts/gias_codes.py` (their parity is tested).
|
||||
- No copy may use an em dash (`__tests__/components/noEmDashCopy.test.ts`).
|
||||
- Backend tests run from the repo root with: `uv run --with-requirements requirements.txt --with pytest --with "httpx==0.27.0" python -m pytest backend/tests -q`
|
||||
- Frontend checks run from `nextjs-app/`: `npx jest` and `npx tsc --noEmit`.
|
||||
- Do not start a local server. E2E journeys are verified against staging after merge.
|
||||
|
||||
## Review Focus
|
||||
|
||||
- A school whose `religious_denomination` is `None`/NaN or `""` (GIAS code 99) must count as "No religious character", not drop out of every faith option. Pinned in Task 1.
|
||||
- A type or religion label the dictionaries do not know (e.g. `"Unknown (9999)"`, or a test fixture's `"Academy"`) must map to no group without raising. Pinned in Task 1.
|
||||
- `/api/filters` returning no `school_type_groups`/`faiths` (API failed, or an older backend) must leave the selects out rather than render "Any…" alone. Pinned in Task 3.
|
||||
- An old bookmarked URL with `school_type=Community+school` must still return community schools and show a chip with its raw label. Pinned in Tasks 2 and 3.
|
||||
- Mixed case in a key (`?faith=Roman_Catholic`, `?school_type=Special`) must still match. Pinned in Task 2.
|
||||
|
||||
---
|
||||
|
||||
## File Structure
|
||||
|
||||
| File | Responsibility |
|
||||
|---|---|
|
||||
| `backend/school_groups.py` (new) | The two groupings as code sets, and name-based lookups. Nothing else. |
|
||||
| `backend/tests/test_school_groups.py` (new) | Coverage of every GIAS code, joint faiths, unknown/blank names. |
|
||||
| `backend/app.py` (modify) | `faith` param; group-key branch for `school_type`; two new `/api/filters` keys. |
|
||||
| `backend/tests/test_type_and_faith_filters.py` (new) | API behaviour of both filters and the new `/api/filters` keys. |
|
||||
| `nextjs-app/lib/types.ts` (modify) | `FilterOption`; optional `school_type_groups`/`faiths` on `Filters`; `faith` on `SchoolSearchParams`. |
|
||||
| `nextjs-app/app/(frontend)/page.tsx` (modify) | Read and forward `faith`. |
|
||||
| `nextjs-app/components/FilterBar.tsx` (modify) | Grouped School type options; Faith select; chips, counts, analytics. |
|
||||
| `nextjs-app/__tests__/components/FilterBarTypeFaith.test.tsx` (new) | Frontend behaviour of both selects. |
|
||||
| Existing FilterBar tests (modify) | Fixtures move from raw types to groups. |
|
||||
| `e2e/tests/journeys.spec.ts` (modify) | A journey for both filters. |
|
||||
| Spec (modify) | Architecture section: grouping is by name at filter time. |
|
||||
|
||||
---
|
||||
|
||||
### Task 1: The groupings module
|
||||
|
||||
**Files:**
|
||||
- Create: `backend/school_groups.py`
|
||||
- Test: `backend/tests/test_school_groups.py`
|
||||
- Modify: `docs/superpowers/specs/2026-10-02-school-type-groups-and-faith-filter-design.md` (Architecture)
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: `backend.gias_codes.SCHOOL_TYPE: dict[int, str]`, `backend.gias_codes.RELIGIOUS_CHARACTER: dict[int, str]` (code 99 maps to `""`).
|
||||
- Produces:
|
||||
- `TYPE_GROUPS: tuple[tuple[str, str, frozenset[int]], ...]` (key, label, codes), in display order
|
||||
- `UNOFFERED_TYPE_CODES: frozenset[int]`
|
||||
- `FAITH_GROUPS: tuple[tuple[str, str, frozenset[int]], ...]`, in display order
|
||||
- `TYPE_GROUP_KEYS: frozenset[str]`, `FAITH_KEYS: frozenset[str]`
|
||||
- `type_group_for(name: object) -> str | None`
|
||||
- `faith_groups_for(name: object) -> tuple[str, ...]`
|
||||
|
||||
- [ ] **Step 1: Write the failing tests**
|
||||
|
||||
Create `backend/tests/test_school_groups.py`:
|
||||
|
||||
```python
|
||||
"""Parent-facing groups over GIAS establishment types and religious characters.
|
||||
|
||||
Every GIAS code must be accounted for, so a new DfE code fails here instead of
|
||||
silently vanishing from the filter.
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import numpy as np
|
||||
import pytest
|
||||
import yaml
|
||||
|
||||
from backend.gias_codes import RELIGIOUS_CHARACTER, SCHOOL_TYPE
|
||||
from backend.school_groups import (
|
||||
FAITH_GROUPS,
|
||||
TYPE_GROUPS,
|
||||
UNOFFERED_TYPE_CODES,
|
||||
faith_groups_for,
|
||||
type_group_for,
|
||||
)
|
||||
|
||||
DBT_PROJECT = Path(__file__).resolve().parents[2] / "pipeline" / "transform" / "dbt_project.yml"
|
||||
|
||||
|
||||
def _non_england_codes() -> set[int]:
|
||||
return set(yaml.safe_load(DBT_PROJECT.read_text())["vars"]["non_england_school_type_codes"])
|
||||
|
||||
|
||||
def test_every_type_code_is_in_exactly_one_place():
|
||||
places = [codes for _, _, codes in TYPE_GROUPS] + [UNOFFERED_TYPE_CODES, _non_england_codes()]
|
||||
for code in SCHOOL_TYPE:
|
||||
homes = sum(code in p for p in places)
|
||||
assert homes == 1, f"type code {code} ({SCHOOL_TYPE[code]}) is in {homes} places"
|
||||
|
||||
|
||||
def test_every_religion_code_has_a_faith():
|
||||
for code, name in RELIGIOUS_CHARACTER.items():
|
||||
assert any(code in codes for _, _, codes in FAITH_GROUPS), f"{code} {name!r}"
|
||||
|
||||
|
||||
def test_type_groups_in_display_order():
|
||||
assert [k for k, _, _ in TYPE_GROUPS] == [
|
||||
"academy", "council", "independent", "special", "post16", "alternative"]
|
||||
|
||||
|
||||
def test_faiths_in_display_order():
|
||||
assert [k for k, _, _ in FAITH_GROUPS] == [
|
||||
"none", "church_of_england", "roman_catholic", "other_christian",
|
||||
"jewish", "muslim", "other_faith"]
|
||||
|
||||
|
||||
@pytest.mark.parametrize("name, group", [
|
||||
("Academy converter", "academy"),
|
||||
("University technical college", "academy"),
|
||||
("Voluntary aided school", "council"),
|
||||
("Local authority nursery school", "council"),
|
||||
("Other independent school", "independent"),
|
||||
("Other independent special school", "special"),
|
||||
("Special post 16 institution", "special"),
|
||||
("Further education", "post16"),
|
||||
("Pupil referral unit", "alternative"),
|
||||
("academy CONVERTER", "academy"),
|
||||
])
|
||||
def test_type_group_by_name(name, group):
|
||||
assert type_group_for(name) == group
|
||||
|
||||
|
||||
@pytest.mark.parametrize("name", [
|
||||
"Higher education institutions", "Miscellaneous", "Unknown (9999)", "Academy", "", None, np.nan,
|
||||
])
|
||||
def test_unoffered_or_unknown_types_have_no_group(name):
|
||||
assert type_group_for(name) is None
|
||||
|
||||
|
||||
@pytest.mark.parametrize("name, faiths", [
|
||||
("Roman Catholic/Church of England", ("church_of_england", "roman_catholic")),
|
||||
("Roman Catholic/Anglican", ("church_of_england", "roman_catholic")),
|
||||
("Church of England/Methodist", ("church_of_england", "other_christian")),
|
||||
("Church of England/Christian", ("church_of_england",)),
|
||||
("Catholic", ("roman_catholic",)),
|
||||
("Inter- / non- denominational", ("other_christian",)),
|
||||
("Orthodox Jewish", ("jewish",)),
|
||||
("Sunni Deobandi", ("muslim",)),
|
||||
("Hindu", ("other_faith",)),
|
||||
("Does not apply", ("none",)),
|
||||
("None", ("none",)),
|
||||
])
|
||||
def test_faiths_by_name(name, faiths):
|
||||
assert faith_groups_for(name) == faiths
|
||||
|
||||
|
||||
@pytest.mark.parametrize("missing", [None, np.nan, "", " "])
|
||||
def test_a_missing_religion_is_no_religious_character(missing):
|
||||
assert faith_groups_for(missing) == ("none",)
|
||||
|
||||
|
||||
def test_an_unknown_religion_has_no_faith():
|
||||
assert faith_groups_for("Unknown (77)") == ()
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run them to see them fail**
|
||||
|
||||
Run: `uv run --with-requirements requirements.txt --with pytest --with "httpx==0.27.0" python -m pytest backend/tests/test_school_groups.py -q`
|
||||
Expected: collection error, `ModuleNotFoundError: No module named 'backend.school_groups'`.
|
||||
|
||||
- [ ] **Step 3: Write the module**
|
||||
|
||||
Create `backend/school_groups.py`:
|
||||
|
||||
```python
|
||||
"""Parent-facing groups over GIAS establishment types and religious characters.
|
||||
|
||||
The 34 GIAS establishment types describe governance and funding, which for a
|
||||
mainstream state school barely changes what a parent experiences. The search
|
||||
filter offers six groups a parent recognises instead, and a faith filter in
|
||||
place of the faith signal that "Voluntary aided" and "Voluntary controlled"
|
||||
only half carry. See
|
||||
docs/superpowers/specs/2026-10-02-school-type-groups-and-faith-filter-design.md.
|
||||
|
||||
Groups are defined over GIAS codes and looked up by the translated name,
|
||||
because the DataFrame the API filters carries names only: the codes are
|
||||
replaced at load (data_loader.translate_gias_code_columns), the legacy-name
|
||||
mart fallback never had them, and test fixtures are written in names.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import pandas as pd
|
||||
|
||||
from .gias_codes import RELIGIOUS_CHARACTER, SCHOOL_TYPE
|
||||
|
||||
# (key, label, GIAS TypeOfEstablishment codes), in the order shown.
|
||||
TYPE_GROUPS: tuple[tuple[str, str, frozenset[int]], ...] = (
|
||||
# Academy sponsor led, Academy converter, Free schools, University technical
|
||||
# college, Studio schools, City technology college. UTCs and studio schools
|
||||
# are legally academies, and a family considering one searches by name.
|
||||
("academy", "State school: academy or free school", frozenset({28, 34, 35, 40, 41, 6})),
|
||||
# Community, Voluntary aided, Voluntary controlled, Foundation, LA nursery.
|
||||
("council", "State school: council-run", frozenset({1, 2, 3, 5, 15})),
|
||||
("independent", "Independent (fee-paying)", frozenset({11})),
|
||||
# Every special type, independent ones included (usually funded by the
|
||||
# council through an EHCP, so SEND provision to a parent, not private
|
||||
# school), and Special post 16 institutions.
|
||||
("special", "Special school (SEND)", frozenset({7, 8, 10, 12, 32, 33, 36, 44})),
|
||||
# Further education, Sixth form centres, the 16-19 academies and free schools.
|
||||
("post16", "Sixth form or college", frozenset({18, 31, 39, 45, 46})),
|
||||
# Pupil referral units and AP academies and free schools. Last: parents do
|
||||
# not apply to these; the local authority places children there.
|
||||
("alternative", "Alternative provision", frozenset({14, 38, 42, 43})),
|
||||
)
|
||||
|
||||
# In no group, so reachable only under "Any school type": Secure units,
|
||||
# Miscellaneous, Higher education institutions, Online provider, Institution
|
||||
# funded by other government department, Academy secure 16 to 19.
|
||||
UNOFFERED_TYPE_CODES: frozenset[int] = frozenset({24, 27, 29, 49, 56, 57})
|
||||
|
||||
# (key, label, GIAS ReligiousCharacter codes), in the order shown. A joint
|
||||
# school is in every faith its label names; a generic "Christian" beside a
|
||||
# named church adds nothing.
|
||||
FAITH_GROUPS: tuple[tuple[str, str, frozenset[int]], ...] = (
|
||||
# Does not apply, None, and 99 (a blank label).
|
||||
("none", "No religious character", frozenset({0, 6, 99})),
|
||||
("church_of_england", "Church of England",
|
||||
frozenset({2, 9, 10, 11, 12, 13, 19, 20, 30, 31, 32, 33, 34, 41, 48})),
|
||||
("roman_catholic", "Roman Catholic", frozenset({3, 11, 13, 35, 48})),
|
||||
# 28 "Inter- / non- denominational" is how GIAS files Christian schools
|
||||
# tied to no one church.
|
||||
("other_christian", "Other Christian",
|
||||
frozenset({4, 8, 9, 10, 12, 14, 15, 16, 17, 18, 19, 22, 26, 28, 30, 33,
|
||||
37, 38, 39, 40, 41, 44, 45, 46, 47})),
|
||||
("jewish", "Jewish", frozenset({5, 36, 43})),
|
||||
("muslim", "Muslim", frozenset({7, 42, 49})),
|
||||
("other_faith", "Other faith", frozenset({21, 24, 25, 29})),
|
||||
)
|
||||
|
||||
TYPE_GROUP_KEYS: frozenset[str] = frozenset(k for k, _, _ in TYPE_GROUPS)
|
||||
FAITH_KEYS: frozenset[str] = frozenset(k for k, _, _ in FAITH_GROUPS)
|
||||
|
||||
|
||||
def _key(name: str) -> str:
|
||||
return name.strip().lower()
|
||||
|
||||
|
||||
_TYPE_GROUP_BY_NAME: dict[str, str] = {
|
||||
_key(SCHOOL_TYPE[code]): key
|
||||
for key, _, codes in TYPE_GROUPS
|
||||
for code in codes
|
||||
if code in SCHOOL_TYPE
|
||||
}
|
||||
|
||||
_FAITHS_BY_NAME: dict[str, tuple[str, ...]] = {}
|
||||
for _faith, _, _codes in FAITH_GROUPS:
|
||||
for _code in sorted(_codes):
|
||||
if _code in RELIGIOUS_CHARACTER:
|
||||
_name = _key(RELIGIOUS_CHARACTER[_code])
|
||||
_FAITHS_BY_NAME[_name] = _FAITHS_BY_NAME.get(_name, ()) + (_faith,)
|
||||
|
||||
|
||||
def type_group_for(name: object) -> Optional[str]:
|
||||
"""The type group of a GIAS establishment type name, or None."""
|
||||
if not isinstance(name, str):
|
||||
return None
|
||||
return _TYPE_GROUP_BY_NAME.get(_key(name))
|
||||
|
||||
|
||||
def faith_groups_for(name: object) -> tuple[str, ...]:
|
||||
"""The faith groups of a GIAS religious character name.
|
||||
|
||||
A missing or blank name is "No religious character". A name the
|
||||
dictionary does not know has no faith, so it matches no faith option.
|
||||
"""
|
||||
if not isinstance(name, str):
|
||||
return ("none",) if name is None or pd.isna(name) else ()
|
||||
return _FAITHS_BY_NAME.get(_key(name), ())
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run the tests to see them pass**
|
||||
|
||||
Run: `uv run --with-requirements requirements.txt --with pytest --with "httpx==0.27.0" python -m pytest backend/tests/test_school_groups.py -q`
|
||||
Expected: all pass.
|
||||
|
||||
- [ ] **Step 5: Correct the spec's architecture**
|
||||
|
||||
In the spec, replace the `### backend/data_loader.py` subsection with:
|
||||
|
||||
```markdown
|
||||
### Grouping by name, at filter time
|
||||
|
||||
The groups are defined over codes but looked up by the translated name
|
||||
(`type_group_for(name)`, `faith_groups_for(name)`), when `/api/schools` and
|
||||
`/api/filters` filter. The DataFrame those endpoints read carries names only:
|
||||
`translate_gias_code_columns` replaces the codes at load, the legacy-name
|
||||
mart fallback never had codes, and the API test fixtures are written in
|
||||
names. The names come from the same dictionaries, so the lookup is exact.
|
||||
`data_loader.py` is unchanged.
|
||||
```
|
||||
|
||||
and in `### backend/school_groups.py (new)` replace the `type_group_for(code)` / `faith_groups_for(code)` bullet with `type_group_for(name) -> str | None` and `faith_groups_for(name) -> tuple[str, ...]` (a missing or blank name gives `("none",)`).
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add backend/school_groups.py backend/tests/test_school_groups.py docs/superpowers/specs/2026-10-02-school-type-groups-and-faith-filter-design.md
|
||||
git commit -m "feat(api): group GIAS school types and religions for parents"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 2: The API filters
|
||||
|
||||
**Files:**
|
||||
- Modify: `backend/app.py` (imports near line 43; `get_schools` params ~738-747, sanitising ~755-759, secondary filters ~782-786, `school_type` filter ~886-889; `get_filter_options` ~1155-1180)
|
||||
- Test: `backend/tests/test_type_and_faith_filters.py`
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: from Task 1, `TYPE_GROUPS`, `FAITH_GROUPS`, `TYPE_GROUP_KEYS`, `FAITH_KEYS`, `type_group_for`, `faith_groups_for`.
|
||||
- Produces:
|
||||
- `GET /api/schools?school_type=<group key | raw label>&faith=<faith key>`
|
||||
- `GET /api/filters` adds `"school_type_groups": [{"value": str, "label": str}]` and `"faiths": [{"value": str, "label": str}]`, in group order, groups with no school left out.
|
||||
|
||||
- [ ] **Step 1: Write the failing tests**
|
||||
|
||||
Create `backend/tests/test_type_and_faith_filters.py`:
|
||||
|
||||
```python
|
||||
"""/api/schools school-type groups and faith filter, and their /api/filters lists."""
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
# urn -> (GIAS school type, GIAS religious character)
|
||||
SCHOOLS = {
|
||||
100001: ("Community school", "Does not apply"),
|
||||
100002: ("Voluntary aided school", "Roman Catholic"),
|
||||
100003: ("Academy converter", "Roman Catholic/Church of England"),
|
||||
100004: ("Community special school", None),
|
||||
100005: ("Academy special converter", "Church of England"),
|
||||
100006: ("Other independent school", "Jewish"),
|
||||
100007: ("Miscellaneous", ""),
|
||||
}
|
||||
|
||||
|
||||
def _schools_df() -> pd.DataFrame:
|
||||
base = {
|
||||
"local_authority": "Testshire", "address": "1 Test Street", "town": "Testtown",
|
||||
"postcode": "TS1 1AA", "age_range": "4-11", "has_sixth_form": None,
|
||||
"gender": "Mixed", "admissions_policy": None, "ofsted_grade": np.nan,
|
||||
"ofsted_date": None, "ofsted_framework": None, "latitude": 51.5,
|
||||
"longitude": -0.1, "year": 202425, "total_pupils": 300,
|
||||
"rwm_expected_pct": np.nan, "attainment_8_score": np.nan, "phase": "Primary",
|
||||
}
|
||||
return pd.DataFrame([
|
||||
{**base, "urn": urn, "school_name": f"School {urn}",
|
||||
"school_type": t, "religious_denomination": r}
|
||||
for urn, (t, r) in SCHOOLS.items()
|
||||
])
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
def client(monkeypatch):
|
||||
from backend import app as app_module
|
||||
|
||||
monkeypatch.setattr(app_module, "load_latest_school_data", _schools_df)
|
||||
monkeypatch.setattr(app_module, "load_school_data", _schools_df)
|
||||
return TestClient(app_module.app, raise_server_exceptions=False)
|
||||
|
||||
|
||||
def _urns(client, **params):
|
||||
resp = client.get("/api/schools", params={"page_size": 50, **params})
|
||||
assert resp.status_code == 200, resp.text
|
||||
return sorted(s["urn"] for s in resp.json()["schools"])
|
||||
|
||||
|
||||
@pytest.mark.parametrize("key, urns", [
|
||||
("council", [100001, 100002]),
|
||||
("academy", [100003]),
|
||||
("special", [100004, 100005]),
|
||||
("independent", [100006]),
|
||||
("Special", [100004, 100005]),
|
||||
])
|
||||
def test_a_type_group_key_filters_to_its_group(client, key, urns):
|
||||
assert _urns(client, school_type=key) == urns
|
||||
|
||||
|
||||
def test_a_raw_type_label_still_filters_exactly(client):
|
||||
assert _urns(client, school_type="Community school") == [100001]
|
||||
|
||||
|
||||
@pytest.mark.parametrize("key, urns", [
|
||||
("roman_catholic", [100002, 100003]),
|
||||
("church_of_england", [100003, 100005]),
|
||||
("none", [100001, 100004, 100007]),
|
||||
("jewish", [100006]),
|
||||
("Roman_Catholic", [100002, 100003]),
|
||||
])
|
||||
def test_faith_filters_to_its_group_joint_schools_included(client, key, urns):
|
||||
assert _urns(client, faith=key) == urns
|
||||
|
||||
|
||||
def test_an_unknown_faith_returns_nothing(client):
|
||||
assert _urns(client, faith="nonsense") == []
|
||||
|
||||
|
||||
def test_type_and_faith_combine(client):
|
||||
assert _urns(client, school_type="special", faith="church_of_england") == [100005]
|
||||
|
||||
|
||||
def test_filters_lists_only_groups_present_in_order(client):
|
||||
body = client.get("/api/filters").json()
|
||||
assert body["school_type_groups"] == [
|
||||
{"value": "academy", "label": "State school: academy or free school"},
|
||||
{"value": "council", "label": "State school: council-run"},
|
||||
{"value": "independent", "label": "Independent (fee-paying)"},
|
||||
{"value": "special", "label": "Special school (SEND)"},
|
||||
]
|
||||
assert body["faiths"] == [
|
||||
{"value": "none", "label": "No religious character"},
|
||||
{"value": "church_of_england", "label": "Church of England"},
|
||||
{"value": "roman_catholic", "label": "Roman Catholic"},
|
||||
{"value": "jewish", "label": "Jewish"},
|
||||
]
|
||||
# The raw list is still there for anything that reads it.
|
||||
assert "Community school" in body["school_types"]
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run them to see them fail**
|
||||
|
||||
Run: `uv run --with-requirements requirements.txt --with pytest --with "httpx==0.27.0" python -m pytest backend/tests/test_type_and_faith_filters.py -q`
|
||||
Expected: the group-key, faith and `/api/filters` tests fail (`KeyError: 'school_type_groups'`, empty URN lists); `test_a_raw_type_label_still_filters_exactly` passes.
|
||||
|
||||
- [ ] **Step 3: Implement**
|
||||
|
||||
In `backend/app.py`, add beside the other local imports (after the `from .schemas import ...` line):
|
||||
|
||||
```python
|
||||
from .school_groups import (
|
||||
FAITH_GROUPS,
|
||||
FAITH_KEYS,
|
||||
TYPE_GROUP_KEYS,
|
||||
TYPE_GROUPS,
|
||||
faith_groups_for,
|
||||
type_group_for,
|
||||
)
|
||||
```
|
||||
|
||||
Add a helper just above `def sanitize_search_input`:
|
||||
|
||||
```python
|
||||
def _names_in_group(names: pd.Series, in_group) -> set:
|
||||
"""The distinct names in a column that a group predicate accepts.
|
||||
|
||||
Evaluated once per distinct name rather than per row, so a filter over
|
||||
every school costs a few dozen lookups.
|
||||
"""
|
||||
return {n for n in names.dropna().unique() if in_group(n)}
|
||||
```
|
||||
|
||||
In `get_schools`, add the parameter after `has_sixth_form`:
|
||||
|
||||
```python
|
||||
faith: Optional[str] = Query(None, description="Filter by faith group key", max_length=40),
|
||||
```
|
||||
|
||||
and after `phase = sanitize_search_input(phase)`:
|
||||
|
||||
```python
|
||||
faith = sanitize_search_input(faith)
|
||||
```
|
||||
|
||||
After the `has_sixth_form` filter block (the one ending `df_latest = df_latest[flag if has_sixth_form == "yes" else ~flag]`), add:
|
||||
|
||||
```python
|
||||
# Faith group (backend/school_groups.py). A joint school is in every faith
|
||||
# its label names; a missing religious character is "none". An unknown key
|
||||
# matches nothing rather than being ignored, so a typo cannot show all.
|
||||
if faith:
|
||||
faith_key = faith.lower()
|
||||
if faith_key in FAITH_KEYS and "religious_denomination" in df_latest.columns:
|
||||
column = df_latest["religious_denomination"]
|
||||
matches = column.isin(_names_in_group(column, lambda n: faith_key in faith_groups_for(n)))
|
||||
# _names_in_group skips missing names; a missing religious
|
||||
# character is "No religious character".
|
||||
if faith_key == "none":
|
||||
matches = matches | column.isna()
|
||||
df_latest = df_latest[matches]
|
||||
else:
|
||||
df_latest = df_latest.iloc[0:0]
|
||||
```
|
||||
|
||||
Replace the existing `school_type` filter:
|
||||
|
||||
```python
|
||||
if school_type:
|
||||
schools_df = schools_df[
|
||||
schools_df["school_type"].str.lower() == school_type.lower()
|
||||
]
|
||||
```
|
||||
|
||||
with:
|
||||
|
||||
```python
|
||||
# A type group key (backend/school_groups.py), or for an old link a raw
|
||||
# GIAS type label, matched exactly as before.
|
||||
if school_type:
|
||||
type_key = school_type.lower()
|
||||
if type_key in TYPE_GROUP_KEYS:
|
||||
column = schools_df["school_type"]
|
||||
schools_df = schools_df[
|
||||
column.isin(_names_in_group(column, lambda n: type_group_for(n) == type_key))
|
||||
]
|
||||
else:
|
||||
schools_df = schools_df[schools_df["school_type"].str.lower() == type_key]
|
||||
```
|
||||
|
||||
In `get_filter_options`, add to the early `if df.empty:` return dict:
|
||||
|
||||
```python
|
||||
"school_type_groups": [],
|
||||
"faiths": [],
|
||||
```
|
||||
|
||||
and before the final `return {`:
|
||||
|
||||
```python
|
||||
def offered(groups, present):
|
||||
return [{"value": key, "label": label} for key, label, _ in groups if key in present]
|
||||
|
||||
type_groups_present = (
|
||||
{type_group_for(n) for n in df["school_type"].dropna().unique()} - {None}
|
||||
if "school_type" in df.columns else set()
|
||||
)
|
||||
faiths_present = (
|
||||
{f for n in df["religious_denomination"].unique() for f in faith_groups_for(n)}
|
||||
if "religious_denomination" in df.columns else set()
|
||||
)
|
||||
```
|
||||
|
||||
and add to the returned dict:
|
||||
|
||||
```python
|
||||
"school_type_groups": offered(TYPE_GROUPS, type_groups_present),
|
||||
"faiths": offered(FAITH_GROUPS, faiths_present),
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run the new tests, then the whole backend suite**
|
||||
|
||||
Run: `uv run --with-requirements requirements.txt --with pytest --with "httpx==0.27.0" python -m pytest backend/tests/test_type_and_faith_filters.py -q`
|
||||
Expected: all pass.
|
||||
|
||||
Run: `uv run --with-requirements requirements.txt --with pytest --with "httpx==0.27.0" python -m pytest backend/tests pipeline/tests scripts/ci/tests -q`
|
||||
Expected: all pass (the CI command; `pyyaml` comes from requirements or add `--with pyyaml` if collection fails on `import yaml`).
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add backend/app.py backend/tests/test_type_and_faith_filters.py
|
||||
git commit -m "feat(api): filter schools by type group and by faith"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 3: The frontend filters
|
||||
|
||||
**Files:**
|
||||
- Modify: `nextjs-app/lib/types.ts` (`Filters` ~487-494, `SchoolSearchParams` ~558-570)
|
||||
- Modify: `nextjs-app/app/(frontend)/page.tsx` (props type ~15-29, `hasSearchParams` ~79-88, `fetchSchools` call ~96-109)
|
||||
- Modify: `nextjs-app/components/FilterBar.tsx`
|
||||
- Test: `nextjs-app/__tests__/components/FilterBarTypeFaith.test.tsx` (new)
|
||||
- Modify tests: `__tests__/components/ResultsToolbar.test.tsx`, `FilterSheet.test.tsx`, `FilterSheetPending.test.tsx`, `FilterBarOptions.test.tsx`
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: `/api/filters` keys `school_type_groups`, `faiths` (Task 2); URL params `school_type` (group key) and `faith`.
|
||||
- Produces: `export interface FilterOption { value: string; label: string }`; `Filters.school_type_groups?: FilterOption[]`; `Filters.faiths?: FilterOption[]`; `SchoolSearchParams.faith?: string`. FilterBar selects named "School type" and "Faith".
|
||||
|
||||
- [ ] **Step 1: Write the failing tests**
|
||||
|
||||
Create `nextjs-app/__tests__/components/FilterBarTypeFaith.test.tsx`:
|
||||
|
||||
```tsx
|
||||
import { fireEvent, render, screen, within } from '@testing-library/react';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
import { track } from '@/lib/analytics';
|
||||
|
||||
/*
|
||||
* School type offers six groups a parent recognises, not GIAS's 34 types, and
|
||||
* a Faith filter sits beside it (spec 2026-10-02-school-type-groups-and-faith-
|
||||
* filter-design.md). Both lists come from /api/filters.
|
||||
*/
|
||||
|
||||
let params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
const push = jest.fn();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useSearchParams: () => params,
|
||||
usePathname: () => '/',
|
||||
useRouter: () => ({ push, replace: jest.fn(), prefetch: jest.fn() }),
|
||||
}));
|
||||
jest.mock('@/lib/analytics', () => ({ track: jest.fn() }));
|
||||
|
||||
const filters = {
|
||||
local_authorities: ['Wandsworth'], school_types: ['Community school'], years: [],
|
||||
phases: ['Primary', 'Secondary'], genders: [], admissions_policies: [],
|
||||
school_type_groups: [
|
||||
{ value: 'academy', label: 'State school: academy or free school' },
|
||||
{ value: 'council', label: 'State school: council-run' },
|
||||
{ value: 'special', label: 'Special school (SEND)' },
|
||||
],
|
||||
faiths: [
|
||||
{ value: 'none', label: 'No religious character' },
|
||||
{ value: 'roman_catholic', label: 'Roman Catholic' },
|
||||
],
|
||||
};
|
||||
|
||||
const pushedParams = () => new URLSearchParams(push.mock.calls.at(-1)![0].split('?')[1]);
|
||||
const openSheet = () => {
|
||||
fireEvent.click(screen.getByRole('button', { name: /^Filters/ }));
|
||||
return screen.getByRole('dialog', { name: 'Filters' });
|
||||
};
|
||||
const optionsOf = (scope: HTMLElement, name: string) =>
|
||||
within(within(scope).getByRole('combobox', { name })).getAllByRole('option').map((o) => o.textContent);
|
||||
|
||||
beforeEach(() => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
push.mockClear();
|
||||
jest.mocked(track).mockClear();
|
||||
});
|
||||
|
||||
describe('School type', () => {
|
||||
it('offers the groups, not the GIAS types, on desktop and in the sheet', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const groups = ['Any school type', 'State school: academy or free school',
|
||||
'State school: council-run', 'Special school (SEND)'];
|
||||
expect(optionsOf(screen.getByRole('group', { name: 'Filters' }), 'School type')).toEqual(groups);
|
||||
expect(optionsOf(openSheet(), 'School type')).toEqual(groups);
|
||||
});
|
||||
|
||||
it('puts the group key in the URL and names the chip by its label', () => {
|
||||
const view = render(<FilterBar filters={filters} />);
|
||||
fireEvent.change(within(openSheet()).getByRole('combobox', { name: 'School type' }),
|
||||
{ target: { value: 'special' } });
|
||||
expect(pushedParams().get('school_type')).toBe('special');
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&school_type=special');
|
||||
view.rerender(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Special school (SEND)' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('names an old raw-label link\'s chip by that label', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&school_type=Community+school');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Community school' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('is left out when the API sends no groups', () => {
|
||||
render(<FilterBar filters={{ ...filters, school_type_groups: undefined }} />);
|
||||
expect(screen.queryByRole('combobox', { name: 'School type' })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Faith', () => {
|
||||
it('offers its options in the More filters panel and in the sheet', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.click(screen.getByRole('button', { name: /More filters/ }));
|
||||
const faiths = ['Any faith or none', 'No religious character', 'Roman Catholic'];
|
||||
expect(optionsOf(document.body, 'Faith')).toEqual(faiths);
|
||||
expect(optionsOf(openSheet(), 'Faith')).toEqual(faiths);
|
||||
});
|
||||
|
||||
it('shows as a chip, counts on both buttons, and clears with Clear all', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&faith=roman_catholic');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Roman Catholic' })).toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: 'Filters, 1 applied' })).toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: /More filters \(1\)/ })).toBeInTheDocument();
|
||||
fireEvent.click(within(screen.getByRole('group', { name: 'Applied filters' }))
|
||||
.getByRole('button', { name: 'Clear all' }));
|
||||
expect(pushedParams().get('faith')).toBeNull();
|
||||
expect(pushedParams().get('postcode')).toBe('SW196AR');
|
||||
});
|
||||
|
||||
it('goes into the search analytics event', () => {
|
||||
params = new URLSearchParams('faith=roman_catholic');
|
||||
render(<FilterBar filters={filters} />);
|
||||
const input = screen.getByRole('searchbox', { name: 'School name or postcode' });
|
||||
fireEvent.change(input, { target: { value: 'st marys' } });
|
||||
fireEvent.submit(input.closest('form')!);
|
||||
expect(track).toHaveBeenCalledWith('search_submitted',
|
||||
expect.objectContaining({ filters_active: 'faith=roman_catholic', filters_count: 1 }));
|
||||
});
|
||||
|
||||
it('is left out when the API sends no faiths', () => {
|
||||
render(<FilterBar filters={{ ...filters, faiths: [] }} />);
|
||||
expect(within(openSheet()).queryByRole('combobox', { name: 'Faith' })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run them to see them fail**
|
||||
|
||||
Run (from `nextjs-app/`): `npx jest __tests__/components/FilterBarTypeFaith.test.tsx`
|
||||
Expected: failures; School type still lists `Community school`, no `Faith` combobox. (`tsc` also flags `school_type_groups` on `Filters`, which Step 3 fixes.)
|
||||
|
||||
- [ ] **Step 3: Types and page plumbing**
|
||||
|
||||
In `nextjs-app/lib/types.ts`, above `export interface Filters`:
|
||||
|
||||
```ts
|
||||
/** A filter option whose URL value differs from what a parent reads. */
|
||||
export interface FilterOption {
|
||||
value: string;
|
||||
label: string;
|
||||
}
|
||||
```
|
||||
|
||||
and add to `Filters` (after `admissions_policies`):
|
||||
|
||||
```ts
|
||||
/** Parent-facing school type groups; the URL's school_type takes their value. */
|
||||
school_type_groups?: FilterOption[];
|
||||
faiths?: FilterOption[];
|
||||
```
|
||||
|
||||
and to `SchoolSearchParams` (after `has_sixth_form`):
|
||||
|
||||
```ts
|
||||
faith?: string;
|
||||
```
|
||||
|
||||
In `nextjs-app/app/(frontend)/page.tsx`: add `faith?: string;` to the `searchParams` type after `has_sixth_form?: string;`; add `params.faith ||` to `hasSearchParams` after `params.has_sixth_form`; add `faith: params.faith,` to the `fetchSchools({...})` call after `has_sixth_form: params.has_sixth_form,`.
|
||||
|
||||
- [ ] **Step 4: FilterBar**
|
||||
|
||||
In `nextjs-app/components/FilterBar.tsx`:
|
||||
|
||||
1. Add `"faith"` to `FILTER_KEYS` directly after `"school_type"`.
|
||||
2. After `const currentHasSixthForm = ...` add:
|
||||
|
||||
```tsx
|
||||
const currentFaith = searchParams.get("faith") || "";
|
||||
```
|
||||
|
||||
3. Add `currentFaith,` to the `activeDropdownFilters` array (after `currentLA,`). Faith lives behind More filters, so it counts there.
|
||||
4. In `handleSearchSubmit`'s `filters_active` list, after the `type=` line add:
|
||||
|
||||
```tsx
|
||||
currentFaith && `faith=${currentFaith}`,
|
||||
```
|
||||
|
||||
5. Add `currentFaith ||` to `hasActiveFilters` after `currentType ||`.
|
||||
6. Replace `const typeOptions = filters.school_types;` with:
|
||||
|
||||
```tsx
|
||||
// Six groups a parent recognises, not GIAS's 34 establishment types.
|
||||
const typeOptions = filters.school_type_groups ?? [];
|
||||
const faithOptions = filters.faiths ?? [];
|
||||
```
|
||||
|
||||
7. Add `faith: currentFaith,` to the `values` record after `school_type: currentType,`.
|
||||
8. In `labelFor`, before the `// Phase, gender and admissions values…` comment, add:
|
||||
|
||||
```tsx
|
||||
// An old link may carry a raw GIAS type, which reads as itself.
|
||||
const labelled = { school_type: typeOptions, faith: faithOptions }[
|
||||
key as "school_type" | "faith"
|
||||
];
|
||||
if (labelled) return labelled.find((o) => o.value === value)?.label ?? value;
|
||||
```
|
||||
|
||||
9. In `typeSelect`, replace the options map with:
|
||||
|
||||
```tsx
|
||||
{typeOptions.map((o) => (
|
||||
<option key={o.value} value={o.value}>
|
||||
{o.label}
|
||||
</option>
|
||||
))}
|
||||
```
|
||||
|
||||
10. After `laSelect`, add:
|
||||
|
||||
```tsx
|
||||
const faithSelect = (look: Look) => (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentFaith}
|
||||
onChange={(e) => handleFilterChange("faith", e.target.value)}
|
||||
className={selectClass(look, currentFaith)}
|
||||
aria-label="Faith"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">Any faith or none</option>
|
||||
{faithOptions.map((o) => (
|
||||
<option key={o.value} value={o.value}>
|
||||
{o.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
```
|
||||
|
||||
11. In the desktop row, change `{typeSelect("pill")}` to `{typeOptions.length > 0 && typeSelect("pill")}`.
|
||||
12. In the More filters panel, after `{laSelect("panel")}` add `{faithOptions.length > 0 && faithSelect("panel")}`.
|
||||
13. In the sheet, replace `<SheetField label="School type">{typeSelect("sheet")}</SheetField>` with:
|
||||
|
||||
```tsx
|
||||
{typeOptions.length > 0 && (
|
||||
<SheetField label="School type">{typeSelect("sheet")}</SheetField>
|
||||
)}
|
||||
{faithOptions.length > 0 && (
|
||||
<SheetField label="Faith">{faithSelect("sheet")}</SheetField>
|
||||
)}
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Move the existing tests' fixtures to groups**
|
||||
|
||||
These tests used raw types as values; give each fixture the groups and use keys:
|
||||
|
||||
- `ResultsToolbar.test.tsx`: add to `filters` `school_type_groups: [{ value: 'council', label: 'State school: council-run' }],`; in 'counts only what More filters hides' change `school_type=Community+school` to `school_type=council`.
|
||||
- `FilterSheet.test.tsx`: add the same `school_type_groups` to `filters`; change both `school_type=Community+school` to `school_type=council`.
|
||||
- `FilterSheetPending.test.tsx`: add the same `school_type_groups`; change the `{ target: { value: 'Community school' } }` to `{ target: { value: 'council' } }` and `toBe('Community school')` to `toBe('council')`.
|
||||
- `FilterBarOptions.test.tsx`: add to `filters` `school_type_groups: [{ value: 'academy', label: 'State school: academy or free school' }, { value: 'council', label: 'State school: council-run' }],`; change `school_type=Community+school` (two places) to `school_type=council`; change the expected School type options to `['Any school type', 'State school: academy or free school', 'State school: council-run']`; change `toBe('Community school')` to `toBe('council')`; rename the first test to 'offer every school type group, gender and admissions policy, whatever the results hold'; and in the header comment replace "School type, gender and admissions offer the full lists" with "School type groups, gender and admissions offer the full lists".
|
||||
|
||||
- [ ] **Step 6: Run the frontend checks**
|
||||
|
||||
Run (from `nextjs-app/`): `npx jest` then `npx tsc --noEmit`
|
||||
Expected: all suites pass; no type errors.
|
||||
|
||||
- [ ] **Step 7: Commit**
|
||||
|
||||
```bash
|
||||
git add nextjs-app/lib/types.ts "nextjs-app/app/(frontend)/page.tsx" nextjs-app/components/FilterBar.tsx nextjs-app/__tests__/components/FilterBarTypeFaith.test.tsx nextjs-app/__tests__/components/ResultsToolbar.test.tsx nextjs-app/__tests__/components/FilterSheet.test.tsx nextjs-app/__tests__/components/FilterSheetPending.test.tsx nextjs-app/__tests__/components/FilterBarOptions.test.tsx
|
||||
git commit -m "feat(search): school type groups and a faith filter"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 4: E2E journey, build, PR
|
||||
|
||||
**Files:**
|
||||
- Modify: `e2e/tests/journeys.spec.ts` (insert before `test('a phase outside primary/secondary filters to that phase, not to everything'`)
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: the "School type" and "Faith" selects (Task 3); `/api/schools?school_type=&faith=` (Task 2).
|
||||
|
||||
- [ ] **Step 1: Add the journey**
|
||||
|
||||
```ts
|
||||
/*
|
||||
* School type offers six groups a parent recognises, and Faith sits beside it.
|
||||
* Data-invariant: asserts what every returned school is, never how many.
|
||||
*/
|
||||
test('school type groups and the faith filter narrow to what they name', async ({ page }) => {
|
||||
await page.goto('/?search=school');
|
||||
const type = page.getByRole('combobox', { name: 'School type', exact: true });
|
||||
await expect(type).toBeVisible({ timeout: 15_000 });
|
||||
await type.selectOption({ label: 'Special school (SEND)' });
|
||||
await expect(page).toHaveURL(/[?&]school_type=special(&|$)/);
|
||||
|
||||
await page.getByRole('button', { name: /^More filters/ }).click();
|
||||
await page.getByRole('combobox', { name: 'Faith', exact: true }).selectOption({ label: 'Roman Catholic' });
|
||||
await expect(page).toHaveURL(/[?&]faith=roman_catholic(&|$)/);
|
||||
|
||||
const res = await page.request.get(
|
||||
'/api/schools?search=school&school_type=special&faith=roman_catholic&page_size=100');
|
||||
expect(res.ok()).toBeTruthy();
|
||||
for (const s of (await res.json()).schools as { school_type: string; religious_denomination: string }[]) {
|
||||
expect(s.school_type).toMatch(/special/i);
|
||||
expect(s.religious_denomination).toMatch(/catholic/i);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Confirm it parses, and fails on today's staging**
|
||||
|
||||
Run (from `e2e/`): `npx playwright test --list | grep "school type groups"`
|
||||
Expected: the test is listed.
|
||||
|
||||
Run: `BASE_URL=https://stx.schoolcompare.co.uk npx playwright test -g "school type groups" --retries=0 --reporter=line`
|
||||
Expected: FAIL at `selectOption({ label: 'Special school (SEND)' })`, because staging still offers the raw types. It can only pass after merge (the staging E2E gate runs post-merge).
|
||||
|
||||
- [ ] **Step 3: Build without a database**
|
||||
|
||||
Run (from `nextjs-app/`): `env -u DATABASE_URL npm run build`
|
||||
Expected: build completes.
|
||||
|
||||
- [ ] **Step 4: Commit, push, open the PR**
|
||||
|
||||
```bash
|
||||
git add e2e/tests/journeys.spec.ts
|
||||
git commit -m "test(e2e): school type groups and the faith filter"
|
||||
git push -u origin feat/school-type-groups-faith
|
||||
```
|
||||
|
||||
Open the PR on Gitea against `main` (credential-helper basic auth, as for PRs #168/#169), listing: the six groups and seven faiths, the old-link compatibility, the backend-by-name decision, test counts, and that the new journey can only pass post-merge.
|
||||
@@ -0,0 +1,233 @@
|
||||
# School Type Groups and a Faith Filter — Design
|
||||
|
||||
**Date:** 2026-10-02
|
||||
**Status:** shipped in PR #170; revised 2026-10-02 (one state group)
|
||||
**Scope:** search filters (`/` results toolbar and phone filter sheet), `/api/schools`, `/api/filters`
|
||||
|
||||
## Goal
|
||||
|
||||
Replace the School type filter's 34 GIAS establishment types with five groups a
|
||||
parent recognises, and add a Faith filter.
|
||||
|
||||
> **Revision, 2026-10-02.** PR #170 shipped six groups, with state schools
|
||||
> split into "academy or free school" and "council-run". They are now one,
|
||||
> "State school (free)". The split was two near-halves of the same pool, so it
|
||||
> rarely narrowed anything, and it did not follow the difference a parent feels
|
||||
> most, admissions: voluntary aided and foundation schools set their own
|
||||
> admissions, as academies do, while community and voluntary controlled
|
||||
> schools have theirs set by the council. Faith, which voluntary aided mostly
|
||||
> meant, has its own filter. The old keys `academy` and `council` resolve to
|
||||
> `state`, so their links keep working.
|
||||
|
||||
Since PR #169 the School type select offers the full GIAS list rather than the
|
||||
types in the results. That fixed the trap where choosing a type left only that
|
||||
type on offer, but it exposed the list itself: "Academy converter", "Academy
|
||||
sponsor led", "Free schools", "Foundation school", "Voluntary controlled
|
||||
school" and 29 more. These describe governance and funding. For a mainstream
|
||||
state school they change almost nothing a parent experiences, and parents
|
||||
cannot be expected to know the differences.
|
||||
|
||||
What parents actually ask is: is it free, is it mainstream, is it for children
|
||||
with special needs, is it a sixth form or college, and is it a faith school.
|
||||
The first four are the type groups below. The fifth is the real meaning behind
|
||||
"Voluntary aided" and "Voluntary controlled", but many academies are faith
|
||||
schools too, so it gets its own filter rather than hiding inside type.
|
||||
|
||||
## Non-goals
|
||||
|
||||
- Changing what a school page or result row shows. They keep the precise GIAS
|
||||
type ("Academy sponsor led"), where it is information, not a choice.
|
||||
- Removing the "not offered" types from search results. They stay reachable
|
||||
under "Any school type"; whether parents should see them at all is a
|
||||
separate decision.
|
||||
- Reordering the type options by phase (for example "Sixth form or college"
|
||||
first for 16 plus). Fixed order is simpler.
|
||||
- The rankings page, which has no type filter.
|
||||
- Changing `result_filters`. Its `school_types` key is already unread
|
||||
(docs/LEGACY_CODE.md).
|
||||
|
||||
## Type groups
|
||||
|
||||
Order is the order shown. Codes are GIAS `TypeOfEstablishment` codes
|
||||
(`backend/gias_codes.py: SCHOOL_TYPE`). Counts are staging schools on
|
||||
2026-10-02.
|
||||
|
||||
| Key | Label | GIAS codes | Schools |
|
||||
|---|---|---|---|
|
||||
| `state` | State school (free) | 28 Academy sponsor led, 34 Academy converter, 35 Free schools, 40 University technical college, 41 Studio schools, 6 City technology college, 1 Community school, 2 Voluntary aided school, 3 Voluntary controlled school, 5 Foundation school, 15 Local authority nursery school | 20,502 |
|
||||
| `independent` | Independent (fee-paying) | 11 Other independent school | 1,585 |
|
||||
| `special` | Special school (SEND) | 7 Community special, 12 Foundation special, 44 Academy special converter, 33 Academy special sponsor led, 36 Free schools special, 8 Non-maintained special, 10 Other independent special, 32 Special post 16 institution | 2,227 |
|
||||
| `post16` | Sixth form or college | 18 Further education, 31 Sixth form centres, 45 Academy 16-19 converter, 46 Academy 16 to 19 sponsor led, 39 Free schools 16 to 19 | 302 |
|
||||
| `alternative` | Alternative provision | 14 Pupil referral unit, 42 Academy AP converter, 43 Academy AP sponsor led, 38 Free schools AP | 331 |
|
||||
|
||||
**Not offered** (no group, reachable only under "Any school type"): 29 Higher
|
||||
education institutions, 27 Miscellaneous, 24 Secure units, 49 Online provider,
|
||||
57 Academy secure 16 to 19, 56 Institution funded by other government
|
||||
department. 238 schools.
|
||||
|
||||
**Excluded upstream** (never in the marts): 25, 26, 30, 37, per
|
||||
`non_england_school_type_codes` in `pipeline/transform/dbt_project.yml`.
|
||||
|
||||
### Judgement calls
|
||||
|
||||
- **Independent special schools are Special, not Independent.** They are
|
||||
usually funded by the local authority through a child's EHCP; to a parent
|
||||
they are SEND provision, not private school.
|
||||
- **UTCs, studio schools and city technology colleges are state schools.** They
|
||||
are legally academies, they are few (66 together), and a family considering
|
||||
one searches for it by name.
|
||||
- **Academies and council-run schools are one group.** See the revision note
|
||||
under Goal.
|
||||
- **Special post 16 institutions are Special, not Sixth form or college.** The
|
||||
defining fact for a parent is the SEND provision.
|
||||
- **Alternative provision is last.** Parents do not apply to it; the local
|
||||
authority places children there.
|
||||
|
||||
## Faith groups
|
||||
|
||||
Codes are GIAS `ReligiousCharacter` codes
|
||||
(`backend/gias_codes.py: RELIGIOUS_CHARACTER`). A joint school belongs to every
|
||||
faith its label names, so "Roman Catholic/Church of England" matches both
|
||||
Church of England and Roman Catholic. A generic "Christian" alongside a named
|
||||
denomination adds nothing ("Church of England/Christian" is Church of England
|
||||
only).
|
||||
|
||||
| Key | Label | GIAS codes |
|
||||
|---|---|---|
|
||||
| `none` | No religious character | 0 Does not apply, 6 None, 99 (blank), and a missing code |
|
||||
| `church_of_england` | Church of England | 2, 31 Anglican, 34 Anglican/Church of England, 20 CofE/Christian, 32 Anglican/Christian, and the joint codes 9, 10, 11, 12, 13, 19, 30, 33, 41, 48 |
|
||||
| `roman_catholic` | Roman Catholic | 3, 35 Catholic, and the joint codes 11, 13, 48 |
|
||||
| `other_christian` | Other Christian | 4 Methodist, 8 Seventh Day Adventist, 14 Quaker, 15 Christian, 16 United Reformed Church, 17 Congregational Church, 18 Free Church, 22 Greek Orthodox, 26 Moravian, 28 Inter- / non- denominational, 37 Christian/Evangelical, 38 Christian Science, 39 Christian/Methodist, 40 Christian/non-denominational, 44 Plymouth Brethren Christian Church, 45 Protestant, 46 Protestant/Evangelical, 47 Reformed Baptist, and the joint codes 9, 10, 12, 19, 30, 33, 41 |
|
||||
| `jewish` | Jewish | 5 Jewish, 36 Charadi Jewish, 43 Orthodox Jewish |
|
||||
| `muslim` | Muslim | 7 Muslim, 42 Islam, 49 Sunni Deobandi |
|
||||
| `other_faith` | Other faith | 21 Sikh, 24 Buddhist, 25 Hindu, 29 Multi-faith |
|
||||
|
||||
The joint codes: 9 CofE/Methodist, 10 Methodist/CofE, 11 CofE/RC, 12 CofE/URC,
|
||||
13 RC/CofE, 19 CofE/Free Church, 30 CofE/Methodist/URC/Baptist,
|
||||
33 Anglican/Evangelical, 41 CofE/Evangelical, 48 RC/Anglican.
|
||||
|
||||
28 "Inter- / non- denominational" is filed as Other Christian: GIAS uses it for
|
||||
Christian schools that are not tied to one church.
|
||||
|
||||
## Architecture
|
||||
|
||||
Grouping lives in the backend, not dbt. The API already translates GIAS codes
|
||||
to names when it loads the marts (`backend/data_loader.py:
|
||||
translate_gias_code_columns`), and every filter is applied to that DataFrame.
|
||||
Grouping there needs no mart change, so there is no Airflow run between merge
|
||||
and staging showing it.
|
||||
|
||||
### `backend/school_groups.py` (new)
|
||||
|
||||
- `TYPE_GROUPS`: ordered `(key, label, frozenset[int])` per type group.
|
||||
- `UNOFFERED_TYPE_CODES`: the not-offered codes, so that "every code is
|
||||
accounted for" is testable.
|
||||
- `FAITH_GROUPS`: ordered `(key, label, frozenset[int])` per faith group.
|
||||
- `type_group_for(name) -> str | None` and
|
||||
`faith_groups_for(name) -> tuple[str, ...]` (a missing or blank name gives
|
||||
`("none",)`).
|
||||
|
||||
No dependence on the generated GIAS dictionaries beyond their codes, so the
|
||||
backend/pipeline dictionary parity test is untouched.
|
||||
|
||||
### Grouping by name, at filter time
|
||||
|
||||
The groups are defined over codes but looked up by the translated name
|
||||
(`type_group_for(name)`, `faith_groups_for(name)`), when `/api/schools` and
|
||||
`/api/filters` filter. The DataFrame those endpoints read carries names only:
|
||||
`translate_gias_code_columns` replaces the codes at load, the legacy-name
|
||||
mart fallback never had codes, and the API test fixtures are written in
|
||||
names. The names come from the same dictionaries, so the lookup is exact.
|
||||
`data_loader.py` is unchanged.
|
||||
|
||||
### `/api/schools`
|
||||
|
||||
Both filters work on the name columns at request time. `_names_in_group`
|
||||
collects the distinct `school_type` or `religious_denomination` names the
|
||||
group accepts, once per distinct name rather than per row, and the rows are
|
||||
kept with `isin`. No group column is stored.
|
||||
|
||||
- `school_type`: if the value is a type group key (any case), keep the rows
|
||||
whose `school_type` name `type_group_for` puts in that group. Otherwise
|
||||
filter on the raw label exactly as today, so an old
|
||||
`?school_type=Community+school` link keeps working.
|
||||
- `faith` (new, optional, `max_length=40`, sanitised like the others): keep the
|
||||
rows whose `religious_denomination` name `faith_groups_for` puts in that
|
||||
faith (any case); for `none`, rows with a missing name too. An unknown key
|
||||
returns no schools rather than being ignored, so a typo does not silently
|
||||
show everything.
|
||||
|
||||
### `/api/filters`
|
||||
|
||||
Two new keys:
|
||||
|
||||
- `school_type_groups`: `[{value, label}]` in `TYPE_GROUPS` order, only groups
|
||||
with at least one school.
|
||||
- `faiths`: `[{value, label}]` in `FAITH_GROUPS` order, same rule.
|
||||
|
||||
`school_types` stays as it is (the raw list), so nothing that reads it breaks.
|
||||
|
||||
### Frontend
|
||||
|
||||
- `lib/types.ts`: `Filters` gains optional `school_type_groups` and `faiths`
|
||||
(`{ value: string; label: string }[]`). Optional, so the empty fallbacks in
|
||||
`app/(frontend)/page.tsx` and `rankings/page.tsx` stay valid.
|
||||
- `app/(frontend)/page.tsx`: reads `faith` from the search params, counts it
|
||||
in `hasSearchParams`, and passes it to `fetchSchools`. `SchoolSearchParams`
|
||||
in `lib/types.ts` gains `faith`. HomeView's load-more already forwards every
|
||||
URL param. HomeView's `isSearchActive` is left as it is: like phase and
|
||||
gender, faith narrows a search rather than starting one.
|
||||
- `components/FilterBar.tsx`:
|
||||
- The School type select's options become `filters.school_type_groups`;
|
||||
"Any school type" stays first. With no groups (the API failed), the select
|
||||
is left out, as Gender and Admissions already are.
|
||||
- A new **Faith** select (`aria-label="Faith"`, "Any faith or none" first)
|
||||
from `filters.faiths`. On desktop it goes in the More filters panel, after
|
||||
Local authority. In the phone sheet it comes after School type.
|
||||
- `faith` joins `FILTER_KEYS` (chip and Filters count) and the More filters
|
||||
count, and `faith=` joins `filters_active` in the `search_submitted`
|
||||
analytics event.
|
||||
- Chip labels come from the option lists: "Special school (SEND)",
|
||||
"Roman Catholic". An old raw-label `school_type` shows its raw label.
|
||||
- `lib/utils.ts: isSpecialSchool` is unchanged. It reads a school's raw
|
||||
`school_type`, which still arrives.
|
||||
|
||||
## Testing
|
||||
|
||||
**Backend (pytest):**
|
||||
|
||||
- Every `SCHOOL_TYPE` code is in exactly one type group, in
|
||||
`UNOFFERED_TYPE_CODES`, or in `non_england_school_type_codes`. A new DfE
|
||||
code fails this test instead of silently vanishing from the filter.
|
||||
- Every `RELIGIOUS_CHARACTER` code maps to at least one faith group.
|
||||
- The joint codes map to each faith they name (11 and 48 → CofE and RC;
|
||||
9 → CofE and Other Christian) and 20 → CofE only.
|
||||
- `/api/schools?school_type=special` returns only special-group schools;
|
||||
`?school_type=Community+school` still filters by label.
|
||||
- `/api/schools?faith=roman_catholic` returns only matching schools, a joint
|
||||
school included; `?faith=nonsense` returns none.
|
||||
- `/api/filters` lists the groups in order and leaves out an empty one.
|
||||
- Run via uv, as the backend tests always are.
|
||||
|
||||
**Frontend (Jest):**
|
||||
|
||||
- School type offers the six group labels, not raw types.
|
||||
- Faith offers its options, in the panel and in the sheet.
|
||||
- A faith filter shows as a chip, counts on Filters and More filters, and
|
||||
clears with Clear all.
|
||||
- No groups or faiths in `filters` → the select is left out.
|
||||
|
||||
**E2E (`e2e/tests/journeys.spec.ts`):**
|
||||
|
||||
- A journey that picks "Special school (SEND)" and "Roman Catholic" from the
|
||||
selects, then checks through `/api/schools` with the same params that every
|
||||
returned school's `school_type` is a special type and its
|
||||
`religious_denomination` names Catholic. Data-invariant: it asserts the
|
||||
property, not a count.
|
||||
- It can only pass after merge; the staging E2E gate runs post-merge.
|
||||
|
||||
## Rollout
|
||||
|
||||
One PR; backend and frontend deploy together on merge. The frontend tolerates
|
||||
an API without the new keys (the selects are left out), so the order the
|
||||
containers update in does not matter.
|
||||
+355
-4
@@ -270,6 +270,90 @@ test('searching by name returns school results', async ({ page }) => {
|
||||
test('searching by postcode returns nearby schools', async ({ page }) => {
|
||||
await searchByName(page, 'B1 1BB');
|
||||
await expect(schoolLinks(page).first()).toBeVisible({ timeout: 15_000 });
|
||||
// A new postcode search starts at half a mile.
|
||||
await expect(page).toHaveURL(/[?&]radius=0\.5(&|$)/);
|
||||
await expect(page.getByRole('combobox', { name: 'Distance' })).toHaveValue('0.5');
|
||||
});
|
||||
|
||||
test('the phase filter switches straight from secondary to primary', async ({ page }) => {
|
||||
// The phase options once came from the result set, which the phase filter
|
||||
// had already narrowed — so with secondary chosen, primary was not offered.
|
||||
await page.goto('/?search=school&phase=secondary');
|
||||
const phase = page.getByRole('combobox', { name: 'Phase' });
|
||||
await expect(phase).toHaveValue('secondary', { timeout: 15_000 });
|
||||
await phase.selectOption('primary');
|
||||
await expect(page).toHaveURL(/[?&]phase=primary(&|$)/);
|
||||
await expect(phase).toHaveValue('primary');
|
||||
});
|
||||
|
||||
test('school type and gender switch straight to another value', async ({ page }) => {
|
||||
// Their options came from the result set, which the filter had already
|
||||
// narrowed, so with one value chosen it was the only one on offer.
|
||||
await page.goto('/?search=school&gender=girls');
|
||||
// An applied gender filter opens More filters by itself.
|
||||
const gender = page.getByRole('combobox', { name: 'Gender', exact: true });
|
||||
await expect(gender).toHaveValue('girls', { timeout: 15_000 });
|
||||
await gender.selectOption('boys');
|
||||
await expect(page).toHaveURL(/[?&]gender=boys(&|$)/);
|
||||
|
||||
// Whatever types the data holds, choosing one leaves the same list on offer.
|
||||
const type = page.getByRole('combobox', { name: 'School type', exact: true });
|
||||
const offered = await type.locator('option').allTextContents();
|
||||
expect(offered.length, 'no school type to choose').toBeGreaterThan(1);
|
||||
await type.selectOption(offered[1]);
|
||||
await expect(page).toHaveURL(/[?&]school_type=/);
|
||||
await expect.poll(() => type.locator('option').allTextContents()).toEqual(offered);
|
||||
});
|
||||
|
||||
/*
|
||||
* School type offers six groups a parent recognises, and Faith sits beside it.
|
||||
* Data-invariant: asserts what every returned school is, never how many.
|
||||
*/
|
||||
// Clear all once dropped the search with the filters, which sent desktop back
|
||||
// to the home page instead of to the unfiltered results.
|
||||
test('Clear all removes the filters and keeps the search', async ({ page }) => {
|
||||
await page.goto('/?search=school&phase=primary');
|
||||
const row = page.getByRole('group', { name: 'Filters', exact: true });
|
||||
await expect(schoolLinks(page).first()).toBeVisible({ timeout: 15_000 });
|
||||
await row.getByRole('button', { name: 'Clear all', exact: true }).click();
|
||||
await expect(page).not.toHaveURL(/[?&]phase=/);
|
||||
await expect(page).toHaveURL(/[?&]search=school(&|$)/);
|
||||
await expect(schoolLinks(page).first()).toBeVisible();
|
||||
await expect(row.getByRole('button', { name: 'Clear all', exact: true })).toHaveCount(0);
|
||||
});
|
||||
|
||||
test('school type groups and the faith filter narrow to what they name', async ({ page }) => {
|
||||
await page.goto('/?search=school');
|
||||
const type = page.getByRole('combobox', { name: 'School type', exact: true });
|
||||
await expect(type).toBeVisible({ timeout: 15_000 });
|
||||
await type.selectOption({ label: 'Special school (SEND)' });
|
||||
await expect(page).toHaveURL(/[?&]school_type=special(&|$)/);
|
||||
|
||||
await page.getByRole('button', { name: /^More filters/ }).click();
|
||||
await page.getByRole('combobox', { name: 'Faith', exact: true }).selectOption({ label: 'Roman Catholic' });
|
||||
await expect(page).toHaveURL(/[?&]faith=roman_catholic(&|$)/);
|
||||
|
||||
const res = await page.request.get(
|
||||
'/api/schools?search=school&school_type=special&faith=roman_catholic&page_size=100');
|
||||
expect(res.ok()).toBeTruthy();
|
||||
for (const s of (await res.json()).schools as { school_type: string; religious_denomination: string }[]) {
|
||||
expect(s.school_type).toMatch(/special/i);
|
||||
expect(s.religious_denomination).toMatch(/catholic/i);
|
||||
}
|
||||
});
|
||||
|
||||
test('a phase outside primary/secondary filters to that phase, not to everything', async ({ page }) => {
|
||||
// The search page offers every GIAS phase, but the API only knew the grouped
|
||||
// ones and silently dropped the rest — so "Nursery" returned primaries.
|
||||
for (const phase of ['Nursery', '16 plus']) {
|
||||
const res = await page.request.get(
|
||||
`/api/schools?phase=${encodeURIComponent(phase.toLowerCase())}&page_size=50`);
|
||||
expect(res.ok()).toBeTruthy();
|
||||
const phases = new Set(
|
||||
((await res.json()).schools ?? []).map((s: { phase?: string }) => s.phase));
|
||||
expect([...phases], `phase=${phase} returned other phases`)
|
||||
.toEqual(phases.size ? [phase] : []);
|
||||
}
|
||||
});
|
||||
|
||||
test('a report-card school shows a Report Card badge in search results, not its old grade', async ({ page }) => {
|
||||
@@ -500,11 +584,8 @@ test('results map fullscreen falls back to an overlay on iOS', async ({ page })
|
||||
delete Element.prototype.requestFullscreen;
|
||||
});
|
||||
|
||||
// A postcode search opens on the map, phones included; open it fullscreen.
|
||||
await searchByName(page, 'B1 1BB');
|
||||
await expect(schoolLinks(page).first()).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
// Switch to the map view, then open the map fullscreen.
|
||||
await page.getByRole('button', { name: 'Map', exact: true }).click();
|
||||
const openFs = page.getByRole('button', { name: 'View map fullscreen' });
|
||||
await expect(openFs).toBeVisible({ timeout: 15_000 });
|
||||
await openFs.click();
|
||||
@@ -516,6 +597,276 @@ test('results map fullscreen falls back to an overlay on iOS', async ({ page })
|
||||
await expect(openFs).toBeVisible();
|
||||
});
|
||||
|
||||
/*
|
||||
* A postcode search with a list long enough to scroll. The default half mile
|
||||
* finds two schools around B1 1BB, so the page ends before the toolbar has
|
||||
* anything to stay pinned over; the scroll tests ask for a mile.
|
||||
*/
|
||||
const LONG_LIST = '/?postcode=B1%201BB&radius=1';
|
||||
|
||||
/*
|
||||
* The results toolbar: search, filters and the List/Map switch pinned under
|
||||
* the header, so none of them scroll away with the results.
|
||||
*
|
||||
* Positions are read after window.scrollTo, never after a click: Playwright
|
||||
* scrolls a click target into view first, which would make "still on screen
|
||||
* after scrolling" true of anything.
|
||||
*/
|
||||
test('the results toolbar stays pinned with its List/Map switch', async ({ page }) => {
|
||||
await page.setViewportSize({ width: 1280, height: 800 });
|
||||
await page.goto(LONG_LIST);
|
||||
await expect(schoolLinks(page).first()).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
const view = page.getByRole('group', { name: 'Results view' });
|
||||
await expect(view).toBeVisible();
|
||||
// Desktop opens on the map; the list is the long page that scrolls.
|
||||
await page.getByRole('button', { name: 'List', exact: true }).click();
|
||||
await expect(page.getByRole('button', { name: 'List', exact: true }))
|
||||
.toHaveAttribute('aria-pressed', 'true');
|
||||
|
||||
await page.evaluate(() => window.scrollTo(0, 1500));
|
||||
await expect.poll(() => page.evaluate(() => window.scrollY)).toBeGreaterThan(1000);
|
||||
const box = await view.boundingBox();
|
||||
expect(box, 'the switch left the viewport').not.toBeNull();
|
||||
// Just under the 64px header, not scrolled off the top.
|
||||
expect(box!.y).toBeGreaterThanOrEqual(64);
|
||||
expect(box!.y).toBeLessThan(160);
|
||||
await expect(page.getByRole('combobox', { name: 'Distance' })).toBeInViewport();
|
||||
|
||||
await page.getByRole('button', { name: 'Map', exact: true }).click();
|
||||
await expect(page.getByRole('button', { name: 'Map', exact: true }))
|
||||
.toHaveAttribute('aria-pressed', 'true');
|
||||
});
|
||||
|
||||
/*
|
||||
* The toolbar's line count is set by the screen width, never by the results.
|
||||
* It once wrapped wherever it ran out of room, and the List/Map switch only
|
||||
* appears when there are results — so the same search took two lines with
|
||||
* results and one without.
|
||||
*/
|
||||
test('the results toolbar keeps its line count whether or not there are results', async ({ page }) => {
|
||||
const withResults = LONG_LIST;
|
||||
// No school type matches this, so the same search returns nothing.
|
||||
const without = `${withResults}&school_type=no-such-type`;
|
||||
|
||||
const lines = async (url: string) => {
|
||||
await page.goto(url);
|
||||
// By label: the input is a combobox when autosuggest is on.
|
||||
const input = page.getByLabel('School name or postcode', { exact: true });
|
||||
const filters = page.getByRole('group', { name: 'Filters' });
|
||||
await expect(filters).toBeVisible({ timeout: 15_000 });
|
||||
const a = (await input.boundingBox())!;
|
||||
const b = (await filters.boundingBox())!;
|
||||
return b.y >= a.y + a.height ? 2 : 1;
|
||||
};
|
||||
const view = page.getByRole('group', { name: 'Results view' });
|
||||
|
||||
for (const [width, expected] of [[1400, 1], [1100, 2]] as const) {
|
||||
await page.setViewportSize({ width, height: 800 });
|
||||
expect(await lines(withResults), `${width}px with results`).toBe(expected);
|
||||
await expect(view).toBeVisible();
|
||||
expect(await lines(without), `${width}px without results`).toBe(expected);
|
||||
await expect(view).toHaveCount(0);
|
||||
}
|
||||
});
|
||||
|
||||
/*
|
||||
* Desktop opens a postcode search on the map (mockup B): the list in a pane on
|
||||
* the left, the map filling the rest of the screen, and a card on the map for
|
||||
* the school picked in either.
|
||||
*/
|
||||
test('a desktop postcode search opens on the map with the list beside it', async ({ page }) => {
|
||||
await page.setViewportSize({ width: 1280, height: 800 });
|
||||
await searchByName(page, 'B1 1BB');
|
||||
|
||||
await expect(page.getByRole('button', { name: 'Map', exact: true }))
|
||||
.toHaveAttribute('aria-pressed', 'true', { timeout: 15_000 });
|
||||
const pane = page.locator('[class*="mapListPane"]');
|
||||
const card = pane.locator('[data-urn]').first();
|
||||
await expect(card).toBeVisible({ timeout: 15_000 });
|
||||
// The list view's own row, not a cut-down card: it carries the same View
|
||||
// link and Compare button.
|
||||
await expect(card.getByRole('link', { name: 'View', exact: true })).toBeVisible();
|
||||
await expect(card.getByRole('button', { name: /Compar/ })).toBeVisible();
|
||||
await expect(page.locator('.sc-pin').first()).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
// The count and the sort share one line at the top of the list.
|
||||
const heading = await pane.getByRole('heading', { level: 2 }).boundingBox();
|
||||
const sort = await pane.getByRole('combobox').boundingBox();
|
||||
expect(Math.abs((heading!.y + heading!.height / 2) - (sort!.y + sort!.height / 2)))
|
||||
.toBeLessThan(8);
|
||||
|
||||
// The split runs to the bottom of the screen rather than stopping short.
|
||||
const split = await page.locator('[class*="mapViewContainer"]').boundingBox();
|
||||
expect(split!.y + split!.height).toBeGreaterThan(800 - 40);
|
||||
expect(split!.y + split!.height).toBeLessThanOrEqual(800);
|
||||
|
||||
// A card picks its pin and opens its card on the map. Clicked in its padding,
|
||||
// clear of the name link and the Compare button.
|
||||
const name = (await card.locator('a').first().innerText()).trim();
|
||||
await card.click({ position: { x: 6, y: 6 } });
|
||||
await expect(page.locator('.sc-pin--selected')).toHaveCount(1);
|
||||
// Leaflet crossfades popups for 200ms, so two exist until the old one goes.
|
||||
await expect(page.locator('.sc-popup')).toHaveCount(1);
|
||||
await expect(page.locator('.sc-popup')).toContainText(name);
|
||||
// The card's View link is drawn like the list's, not in Leaflet's link blue.
|
||||
// Polled, because .btn transitions its colour.
|
||||
const colour = (l: Locator) => l.evaluate(el => getComputedStyle(el).color);
|
||||
const listViewColour = await colour(card.getByRole('link', { name: 'View', exact: true }));
|
||||
await expect.poll(() => colour(page.locator('.sc-popup').getByRole('link', { name: 'View', exact: true })))
|
||||
.toBe(listViewColour);
|
||||
|
||||
// And from the keyboard: each row has a "Show … on the map" button that
|
||||
// appears on focus.
|
||||
const second = pane.locator('[data-urn]').nth(1);
|
||||
const secondName = (await second.locator('a').first().innerText()).trim();
|
||||
const show = second.getByRole('button', { name: `Show ${secondName} on the map` });
|
||||
await show.focus();
|
||||
await expect(show).toBeVisible();
|
||||
await page.keyboard.press('Enter');
|
||||
await expect(show).toHaveAttribute('aria-pressed', 'true');
|
||||
await expect(page.locator('.sc-popup')).toHaveCount(1);
|
||||
await expect(page.locator('.sc-popup')).toContainText(secondName);
|
||||
});
|
||||
|
||||
// 402 is the iPhone 17, where the toolbar overflowed (see below).
|
||||
for (const width of [360, 390, 402, 430]) {
|
||||
test(`a phone opens on the map, with the list a tap away, at ${width}px`, async ({ page }) => {
|
||||
await page.setViewportSize({ width, height: 800 });
|
||||
await page.goto(LONG_LIST);
|
||||
|
||||
// On the map, with the floating button offering the list, clear of the
|
||||
// bottom tab bar.
|
||||
const toList = page.getByRole('button', { name: 'Show list' });
|
||||
await expect(toList).toBeInViewport({ timeout: 15_000 });
|
||||
await expect(page.locator('.sc-pin').first()).toBeAttached({ timeout: 15_000 });
|
||||
const barTop = await page.locator('nav[class*="bottomBar"]')
|
||||
.evaluate((el) => el.getBoundingClientRect().top);
|
||||
const fabBox = (await toList.boundingBox())!;
|
||||
expect(fabBox.y + fabBox.height).toBeLessThanOrEqual(barTop);
|
||||
|
||||
// A pin opens the bottom sheet, stacked under the button, above the bar.
|
||||
// dispatchEvent, not click: a pin may sit under the button or the toolbar,
|
||||
// and Leaflet listens on the pin itself.
|
||||
await page.locator('.sc-pin').first().dispatchEvent('click');
|
||||
const sheet = page.locator('[class*="bottomSheet"]');
|
||||
await expect(sheet).toBeVisible();
|
||||
// The sheet slides up over 0.3s; measure where it comes to rest, not a
|
||||
// frame of the animation (which reads as below the tab bar).
|
||||
await expect.poll(async () => {
|
||||
const box = (await sheet.boundingBox())!;
|
||||
return Math.round(box.y + box.height);
|
||||
}).toBeLessThanOrEqual(barTop);
|
||||
// The dock is anchored at the bottom, so the sheet pushes the button up:
|
||||
// measure the button again now that the sheet is in.
|
||||
const fabNow = (await toList.boundingBox())!;
|
||||
expect((await sheet.boundingBox())!.y).toBeGreaterThanOrEqual(fabNow.y + fabNow.height);
|
||||
|
||||
// MOBILE.md: no horizontal overflow, and 44px targets in the new chrome.
|
||||
expect(await page.evaluate(() => document.documentElement.scrollWidth - window.innerWidth))
|
||||
.toBe(0);
|
||||
// scrollWidth alone cannot see this page's overflow: .main clips on x, so
|
||||
// the search summary ran 40px off an iPhone 17 screen with scrollWidth
|
||||
// still equal to the viewport. Measure the toolbar's own edges instead;
|
||||
// the applied-filter chips scroll by design, so only their line's box is
|
||||
// held to the edge.
|
||||
const offscreen = await page.evaluate(() => {
|
||||
const toolbar = document.querySelector('[class*="resultsToolbar"]');
|
||||
return [...(toolbar?.querySelectorAll('*') ?? [])]
|
||||
.filter((el) => (el as HTMLElement).offsetParent
|
||||
&& !el.parentElement?.closest('[class*="chipsLine"]'))
|
||||
.map((el) => ({ el: (el.className?.toString() || el.tagName).slice(0, 40),
|
||||
right: Math.round(el.getBoundingClientRect().right) }))
|
||||
.filter((o) => o.right > window.innerWidth);
|
||||
});
|
||||
expect(offscreen).toEqual([]);
|
||||
const small = await page.evaluate(() => {
|
||||
const toolbar = document.querySelector('[class*="resultsToolbar"]');
|
||||
const fabEl = document.querySelector('[class*="viewFab"]');
|
||||
const closeEl = document.querySelector('[class*="closeSheetBtn"]');
|
||||
return [...(toolbar?.querySelectorAll('a, button, input, select') ?? []), fabEl, closeEl]
|
||||
.filter((el): el is HTMLElement => !!el && !!(el as HTMLElement).offsetParent)
|
||||
.map((el) => ({ t: el.innerText?.trim().slice(0, 24) || el.getAttribute('aria-label'),
|
||||
w: el.getBoundingClientRect().width, h: el.getBoundingClientRect().height }))
|
||||
.filter((o) => o.w < 44 || o.h < 44);
|
||||
});
|
||||
expect(small).toEqual([]);
|
||||
|
||||
// The list: the search folds to a summary, and the pinned toolbar and
|
||||
// the button survive a scroll.
|
||||
await toList.click();
|
||||
const toMap = page.getByRole('button', { name: 'Show map' });
|
||||
await expect(toMap).toBeInViewport();
|
||||
await expect(schoolLinks(page).first()).toBeVisible();
|
||||
const summary = page.getByRole('button', { name: /^Edit search: B1 1BB/ });
|
||||
await page.evaluate(() => window.scrollTo(0, 1200));
|
||||
await expect.poll(() => page.evaluate(() => window.scrollY)).toBeGreaterThan(600);
|
||||
await expect(summary).toBeInViewport();
|
||||
await expect(toMap).toBeInViewport();
|
||||
});
|
||||
}
|
||||
|
||||
/*
|
||||
* Phones filter through one Filters button and a sheet with every filter in
|
||||
* it. The row it replaced scrolled sideways with "More filters" first, so
|
||||
* phase showed only in part, school type not at all, and the panel "More
|
||||
* filters" opened held neither.
|
||||
*/
|
||||
test('a phone filters through one sheet, and sees what it applied as chips', async ({ page }) => {
|
||||
await page.setViewportSize({ width: 390, height: 844 });
|
||||
await page.goto(LONG_LIST);
|
||||
const trigger = page.getByRole('button', { name: 'Filters', exact: true });
|
||||
await expect(trigger).toBeInViewport({ timeout: 15_000 });
|
||||
// The desktop row is gone at this width: no phase select until the sheet.
|
||||
await expect(page.getByRole('combobox', { name: 'Phase', exact: true })).toHaveCount(0);
|
||||
|
||||
await trigger.click();
|
||||
const sheet = page.getByRole('dialog', { name: 'Filters' });
|
||||
await expect(sheet).toBeVisible();
|
||||
await expect(sheet.getByRole('radio', { name: 'Within 1 mile' })).toBeChecked();
|
||||
for (const name of ['Phase', 'School type', 'Local authority']) {
|
||||
await expect(sheet.getByRole('combobox', { name, exact: true })).toBeVisible();
|
||||
}
|
||||
|
||||
// A change applies at once, and the sheet stays open for the next one.
|
||||
await sheet.getByRole('combobox', { name: 'Phase', exact: true }).selectOption('primary');
|
||||
await page.waitForURL(/[?&]phase=primary(&|$)/);
|
||||
await expect(sheet).toBeVisible();
|
||||
const show = sheet.getByRole('button', { name: /^(Show [\d,]+ schools?|No schools match)$/ });
|
||||
await expect(show).toBeVisible();
|
||||
|
||||
// MOBILE.md: the sheet clears the bottom tab bar, and its targets are 44px.
|
||||
// It slides up over 0.3s, so poll for where it comes to rest.
|
||||
await expect.poll(async () => {
|
||||
const box = (await show.boundingBox())!;
|
||||
return Math.round(box.y + box.height);
|
||||
}).toBeLessThanOrEqual(844);
|
||||
const small = await sheet.evaluate((el) =>
|
||||
[...el.querySelectorAll('button, select, label:has(input)')]
|
||||
.filter((n): n is HTMLElement => !!(n as HTMLElement).offsetParent)
|
||||
.map((n) => ({ t: n.innerText?.trim().slice(0, 24) || n.getAttribute('aria-label'),
|
||||
w: n.getBoundingClientRect().width, h: n.getBoundingClientRect().height }))
|
||||
.filter((o) => o.w < 44 || o.h < 44));
|
||||
expect(small).toEqual([]);
|
||||
|
||||
await show.click();
|
||||
await expect(sheet).toBeHidden();
|
||||
|
||||
// What was applied shows under the search, counted on the button, and comes
|
||||
// off with a tap, keeping the search.
|
||||
await expect(page.getByRole('button', { name: 'Filters, 1 applied' })).toBeInViewport();
|
||||
const chip = page.getByRole('group', { name: 'Applied filters' })
|
||||
.getByRole('button', { name: 'Remove filter: Primary' });
|
||||
await expect(chip).toBeInViewport();
|
||||
expect(await page.evaluate(() => document.documentElement.scrollWidth - window.innerWidth))
|
||||
.toBe(0);
|
||||
await chip.click();
|
||||
await expect(page).not.toHaveURL(/[?&]phase=/);
|
||||
await expect(page).toHaveURL(/[?&]postcode=B1(%20|\+)1BB/);
|
||||
await expect(page.getByRole('group', { name: 'Applied filters' })).toHaveCount(0);
|
||||
await expect(trigger).toBeInViewport();
|
||||
});
|
||||
|
||||
test('comparing two schools shows the parent-first sections side by side', async ({ page }) => {
|
||||
// Two same-phase (pure primary) schools so both stay on one tab.
|
||||
const [urn0, urn1] = await twoPrimaryUrns(page);
|
||||
|
||||
@@ -0,0 +1,129 @@
|
||||
import { fireEvent, render, screen, within } from '@testing-library/react';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
import type { ResultFilters } from '@/lib/types';
|
||||
|
||||
/*
|
||||
* A filter's options must not come from the results it is filtering, or
|
||||
* choosing one leaves only that one on offer: pick "Girls" and "Boys" is gone
|
||||
* until the filter is cleared. School type groups, gender and admissions offer the
|
||||
* full lists, as phase already did. Local authority stays scoped to the
|
||||
* results, so a postcode search offers the councils nearby rather than 153.
|
||||
*
|
||||
* Gender, sixth form and admissions show unless the phase chosen is a primary
|
||||
* one, so what the results happen to contain never decides which filters
|
||||
* there are.
|
||||
*/
|
||||
|
||||
let params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
const push = jest.fn();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useSearchParams: () => params,
|
||||
usePathname: () => '/',
|
||||
useRouter: () => ({ push, replace: jest.fn(), prefetch: jest.fn() }),
|
||||
}));
|
||||
jest.mock('@/lib/analytics', () => ({ track: jest.fn() }));
|
||||
|
||||
const filters = {
|
||||
local_authorities: ['Merton', 'Wandsworth'],
|
||||
school_types: ['Academy converter', 'Community school'], years: [],
|
||||
phases: ['Middle deemed primary', 'Nursery', 'Primary', 'Secondary', 'All-through'],
|
||||
genders: ['Boys', 'Girls', 'Mixed'],
|
||||
admissions_policies: ['Non-selective', 'Selective'],
|
||||
school_type_groups: [
|
||||
{ value: 'academy', label: 'State school: academy or free school' },
|
||||
{ value: 'council', label: 'State school: council-run' },
|
||||
],
|
||||
};
|
||||
|
||||
// What the results came back with once narrowed by the chosen filters.
|
||||
const narrowed: ResultFilters = {
|
||||
local_authorities: ['Wandsworth'], school_types: ['Community school'],
|
||||
phases: ['Secondary'], genders: ['Girls'], admissions_policies: ['Non-selective'],
|
||||
};
|
||||
|
||||
const pushedParams = () => new URLSearchParams(push.mock.calls.at(-1)![0].split('?')[1]);
|
||||
|
||||
const openSheet = () => {
|
||||
fireEvent.click(screen.getByRole('button', { name: /^Filters/ }));
|
||||
return screen.getByRole('dialog', { name: 'Filters' });
|
||||
};
|
||||
|
||||
const optionsOf = (sheet: HTMLElement, name: string) =>
|
||||
within(within(sheet).getByRole('combobox', { name }))
|
||||
.getAllByRole('option').map((o) => o.textContent);
|
||||
|
||||
beforeEach(() => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
push.mockClear();
|
||||
});
|
||||
|
||||
describe('filter options', () => {
|
||||
it('offer every school type group, gender and admissions policy, whatever the results hold', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&school_type=council&gender=girls');
|
||||
render(<FilterBar filters={filters} resultFilters={narrowed} />);
|
||||
const sheet = openSheet();
|
||||
expect(optionsOf(sheet, 'School type')).toEqual(['Any school type', 'State school: academy or free school', 'State school: council-run']);
|
||||
expect(optionsOf(sheet, 'Gender')).toEqual(['Boys, Girls & Mixed', 'Boys', 'Girls', 'Mixed']);
|
||||
expect(optionsOf(sheet, 'Admissions')).toEqual(['All admissions types', 'Non-selective', 'Selective']);
|
||||
});
|
||||
|
||||
it('keep local authority to the councils in the results', () => {
|
||||
render(<FilterBar filters={filters} resultFilters={narrowed} />);
|
||||
expect(optionsOf(openSheet(), 'Local authority')).toEqual(['All Local Authorities', 'Wandsworth']);
|
||||
});
|
||||
|
||||
it('offer the full school types in the desktop row too', () => {
|
||||
render(<FilterBar filters={filters} resultFilters={narrowed} />);
|
||||
const row = screen.getByRole('group', { name: 'Filters' });
|
||||
expect(within(within(row).getByRole('combobox', { name: 'School type' }))
|
||||
.getAllByRole('option')).toHaveLength(3);
|
||||
});
|
||||
});
|
||||
|
||||
describe('the secondary-only filters', () => {
|
||||
const secondaryOnly = ['Gender', 'Sixth form', 'Admissions'];
|
||||
const shown = (sheet: HTMLElement) =>
|
||||
secondaryOnly.filter((name) => within(sheet).queryByRole('combobox', { name }));
|
||||
|
||||
it('show with any phase, even when no secondary school is in the results', () => {
|
||||
const primariesOnly = { ...narrowed, phases: ['Primary'], genders: [], admissions_policies: [] };
|
||||
render(<FilterBar filters={filters} resultFilters={primariesOnly} />);
|
||||
expect(shown(openSheet())).toEqual(secondaryOnly);
|
||||
});
|
||||
|
||||
it.each(['primary', 'nursery', 'middle deemed primary', 'Middle-deemed Primary'])(
|
||||
'hide for the %s phase', (phase) => {
|
||||
params = new URLSearchParams(`postcode=SW196AR&radius=1&phase=${encodeURIComponent(phase)}`);
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(shown(openSheet())).toEqual([]);
|
||||
});
|
||||
|
||||
it('leave out a filter with no options, rather than show only its "any"', () => {
|
||||
render(<FilterBar filters={{ ...filters, genders: [], admissions_policies: [] }} />);
|
||||
expect(shown(openSheet())).toEqual(['Sixth form']);
|
||||
});
|
||||
|
||||
it.each(['secondary', 'all-through', 'middle deemed secondary', '16 plus'])('show for the %s phase', (phase) => {
|
||||
params = new URLSearchParams(`postcode=SW196AR&radius=1&phase=${phase}`);
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(shown(openSheet())).toEqual(secondaryOnly);
|
||||
});
|
||||
|
||||
it('are cleared by choosing a primary phase, rather than left applied and hidden', () => {
|
||||
params = new URLSearchParams(
|
||||
'postcode=SW196AR&radius=1&phase=secondary&gender=girls&has_sixth_form=yes&admissions_policy=selective&school_type=council');
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.change(within(openSheet()).getByRole('combobox', { name: 'Phase' }), { target: { value: 'primary' } });
|
||||
const next = pushedParams();
|
||||
expect(next.get('phase')).toBe('primary');
|
||||
for (const key of ['gender', 'has_sixth_form', 'admissions_policy']) expect(next.get(key)).toBeNull();
|
||||
expect(next.get('school_type')).toBe('council');
|
||||
});
|
||||
|
||||
it('are kept when the new phase still has them', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&phase=secondary&gender=girls');
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.change(within(openSheet()).getByRole('combobox', { name: 'Phase' }), { target: { value: 'all-through' } });
|
||||
expect(pushedParams().get('gender')).toBe('girls');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,40 @@
|
||||
import { render, screen, within } from '@testing-library/react';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
|
||||
let searchParams = new URLSearchParams();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useRouter: () => ({ push: jest.fn(), replace: jest.fn(), prefetch: jest.fn() }),
|
||||
usePathname: () => '/',
|
||||
useSearchParams: () => searchParams,
|
||||
}));
|
||||
|
||||
const FILTERS = {
|
||||
local_authorities: [], school_types: [], years: [],
|
||||
phases: ['Primary', 'Secondary', 'All-through'],
|
||||
genders: [], admissions_policies: [],
|
||||
};
|
||||
|
||||
/**
|
||||
* The phase options must not come from the result set. The backend scopes its
|
||||
* result filters to the schools it returns, and it applies the phase filter
|
||||
* first — so with "secondary" chosen the scoped list holds only secondary-ish
|
||||
* phases, and switching to primary meant going back to "Any phase" first.
|
||||
*/
|
||||
describe('FilterBar phase options', () => {
|
||||
it('offers every phase while a phase filter narrows the results', () => {
|
||||
searchParams = new URLSearchParams('search=hampton&phase=secondary');
|
||||
render(
|
||||
<FilterBar
|
||||
filters={FILTERS}
|
||||
resultFilters={{
|
||||
local_authorities: [], school_types: [],
|
||||
phases: ['Secondary', 'All-through'],
|
||||
genders: [], admissions_policies: [],
|
||||
}}
|
||||
/>,
|
||||
);
|
||||
const phase = screen.getByRole('combobox', { name: 'Phase' });
|
||||
expect(within(phase).getByRole('option', { name: 'Primary' })).toBeInTheDocument();
|
||||
expect(phase).toHaveValue('secondary');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,51 @@
|
||||
import { render, screen, waitFor } from '@testing-library/react';
|
||||
import userEvent from '@testing-library/user-event';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
|
||||
const push = jest.fn();
|
||||
let searchParams = new URLSearchParams();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useRouter: () => ({ push, replace: jest.fn(), prefetch: jest.fn() }),
|
||||
usePathname: () => '/',
|
||||
useSearchParams: () => searchParams,
|
||||
}));
|
||||
|
||||
const FILTERS = {
|
||||
local_authorities: [], school_types: [], years: [], phases: [],
|
||||
genders: [], admissions_policies: [],
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
push.mockClear();
|
||||
searchParams = new URLSearchParams();
|
||||
});
|
||||
|
||||
describe('FilterBar default distance', () => {
|
||||
it('searches a new postcode within half a mile', async () => {
|
||||
render(<FilterBar filters={FILTERS} />);
|
||||
await userEvent.type(screen.getByPlaceholderText(/School name or postcode/i), 'SW19 6AR{Enter}');
|
||||
await waitFor(() => expect(push).toHaveBeenCalledWith(expect.stringContaining('radius=0.5')));
|
||||
});
|
||||
|
||||
it('shows half a mile when the URL carries a postcode but no radius', () => {
|
||||
searchParams = new URLSearchParams('postcode=SW196AR');
|
||||
render(<FilterBar filters={FILTERS} />);
|
||||
expect(screen.getByRole('combobox', { name: 'Distance' })).toHaveValue('0.5');
|
||||
});
|
||||
|
||||
it('keeps a distance the user already chose', async () => {
|
||||
searchParams = new URLSearchParams('postcode=SW196AR&radius=3');
|
||||
render(<FilterBar filters={FILTERS} />);
|
||||
expect(screen.getByRole('combobox', { name: 'Distance' })).toHaveValue('3');
|
||||
});
|
||||
});
|
||||
|
||||
describe('FilterBar distance options', () => {
|
||||
it('offers a quarter mile without making it the default', () => {
|
||||
searchParams = new URLSearchParams('postcode=SW196AR');
|
||||
render(<FilterBar filters={FILTERS} />);
|
||||
const distance = screen.getByRole('combobox', { name: 'Distance' });
|
||||
expect([...(distance as HTMLSelectElement).options].map(o => o.value)).toEqual(['0.25', '0.5', '1', '3', '5']);
|
||||
expect(distance).toHaveValue('0.5');
|
||||
});
|
||||
});
|
||||
@@ -32,9 +32,9 @@ afterEach(() => { global.fetch = realFetch; });
|
||||
describe('FilterBar autosuggest', () => {
|
||||
it('is a combobox only when the flag is on', () => {
|
||||
const { rerender } = render(<FilterBar filters={FILTERS} autosuggest={false} />);
|
||||
expect(screen.queryByRole('combobox')).not.toBeInTheDocument();
|
||||
expect(screen.queryByRole('combobox', { name: 'School name or postcode' })).not.toBeInTheDocument();
|
||||
rerender(<FilterBar filters={FILTERS} autosuggest />);
|
||||
expect(screen.getByRole('combobox')).toBeInTheDocument();
|
||||
expect(screen.getByRole('combobox', { name: 'School name or postcode' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('makes no request while the flag is off', async () => {
|
||||
@@ -47,7 +47,7 @@ describe('FilterBar autosuggest', () => {
|
||||
|
||||
it('shows suggestions and navigates when one is chosen', async () => {
|
||||
render(<FilterBar filters={FILTERS} autosuggest />);
|
||||
await userEvent.type(screen.getByRole('combobox'), 'brecknock');
|
||||
await userEvent.type(screen.getByRole('combobox', { name: 'School name or postcode' }), 'brecknock');
|
||||
const option = await screen.findByRole('option', { name: /Brecknock/ });
|
||||
await userEvent.click(option);
|
||||
expect(push).toHaveBeenCalledWith(
|
||||
@@ -61,7 +61,7 @@ describe('FilterBar autosuggest', () => {
|
||||
// "NW1" is not a postcode, so a request for it is correct behaviour. Only
|
||||
// the settled value is the assertion, so set it in one go.
|
||||
render(<FilterBar filters={FILTERS} autosuggest />);
|
||||
fireEvent.change(screen.getByRole('combobox'), { target: { value: 'NW1 1AA' } });
|
||||
fireEvent.change(screen.getByRole('combobox', { name: 'School name or postcode' }), { target: { value: 'NW1 1AA' } });
|
||||
await new Promise((r) => setTimeout(r, 300)); // past the 200ms debounce
|
||||
expect(global.fetch).not.toHaveBeenCalled();
|
||||
});
|
||||
@@ -69,7 +69,7 @@ describe('FilterBar autosuggest', () => {
|
||||
it('Enter with no active option still submits the free-text search', async () => {
|
||||
// The existing behaviour is preserved, not replaced.
|
||||
render(<FilterBar filters={FILTERS} autosuggest />);
|
||||
const input = screen.getByRole('combobox');
|
||||
const input = screen.getByRole('combobox', { name: 'School name or postcode' });
|
||||
await userEvent.type(input, 'brecknock{Enter}');
|
||||
// updateURL pushes inside startTransition, so the call is not synchronous.
|
||||
await waitFor(() => expect(push).toHaveBeenCalledWith(
|
||||
@@ -90,7 +90,7 @@ describe('FilterBar autosuggest does not reopen over results', () => {
|
||||
searchParams = new URLSearchParams('search=brecknock');
|
||||
render(<FilterBar filters={FILTERS} autosuggest />);
|
||||
|
||||
expect(screen.getByRole('combobox')).toHaveValue('brecknock');
|
||||
expect(screen.getByRole('combobox', { name: 'School name or postcode' })).toHaveValue('brecknock');
|
||||
await new Promise((r) => setTimeout(r, 300)); // past the 200ms debounce
|
||||
expect(global.fetch).not.toHaveBeenCalled();
|
||||
expect(screen.queryByRole('listbox')).not.toBeInTheDocument();
|
||||
@@ -98,7 +98,7 @@ describe('FilterBar autosuggest does not reopen over results', () => {
|
||||
|
||||
it('closes the dropdown when the search is submitted', async () => {
|
||||
render(<FilterBar filters={FILTERS} autosuggest />);
|
||||
const input = screen.getByRole('combobox');
|
||||
const input = screen.getByRole('combobox', { name: 'School name or postcode' });
|
||||
|
||||
await userEvent.type(input, 'brecknock');
|
||||
expect(await screen.findByRole('listbox')).toBeInTheDocument();
|
||||
|
||||
@@ -0,0 +1,137 @@
|
||||
import { fireEvent, render, screen, within } from '@testing-library/react';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
import { track } from '@/lib/analytics';
|
||||
|
||||
/*
|
||||
* School type offers six groups a parent recognises, not GIAS's 34 types, and
|
||||
* a Faith filter sits beside it (spec 2026-10-02-school-type-groups-and-faith-
|
||||
* filter-design.md). Both lists come from /api/filters.
|
||||
*/
|
||||
|
||||
let params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
const push = jest.fn();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useSearchParams: () => params,
|
||||
usePathname: () => '/',
|
||||
useRouter: () => ({ push, replace: jest.fn(), prefetch: jest.fn() }),
|
||||
}));
|
||||
jest.mock('@/lib/analytics', () => ({ track: jest.fn() }));
|
||||
|
||||
const filters = {
|
||||
local_authorities: ['Wandsworth'], school_types: ['Community school'], years: [],
|
||||
phases: ['Primary', 'Secondary'], genders: [], admissions_policies: [],
|
||||
school_type_groups: [
|
||||
{ value: 'academy', label: 'State school: academy or free school' },
|
||||
{ value: 'council', label: 'State school: council-run' },
|
||||
{ value: 'special', label: 'Special school (SEND)' },
|
||||
],
|
||||
faiths: [
|
||||
{ value: 'none', label: 'No religious character' },
|
||||
{ value: 'roman_catholic', label: 'Roman Catholic' },
|
||||
],
|
||||
};
|
||||
|
||||
const pushedParams = () => new URLSearchParams(push.mock.calls.at(-1)![0].split('?')[1]);
|
||||
const openSheet = () => {
|
||||
fireEvent.click(screen.getByRole('button', { name: /^Filters/ }));
|
||||
return screen.getByRole('dialog', { name: 'Filters' });
|
||||
};
|
||||
const optionsOf = (scope: HTMLElement, name: string) =>
|
||||
within(within(scope).getByRole('combobox', { name })).getAllByRole('option').map((o) => o.textContent);
|
||||
|
||||
beforeEach(() => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
push.mockClear();
|
||||
jest.mocked(track).mockClear();
|
||||
});
|
||||
|
||||
describe('School type', () => {
|
||||
it('offers the groups, not the GIAS types, on desktop and in the sheet', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const groups = ['Any school type', 'State school: academy or free school',
|
||||
'State school: council-run', 'Special school (SEND)'];
|
||||
expect(optionsOf(screen.getByRole('group', { name: 'Filters' }), 'School type')).toEqual(groups);
|
||||
expect(optionsOf(openSheet(), 'School type')).toEqual(groups);
|
||||
});
|
||||
|
||||
it('puts the group key in the URL and names the chip by its label', () => {
|
||||
const view = render(<FilterBar filters={filters} />);
|
||||
fireEvent.change(within(openSheet()).getByRole('combobox', { name: 'School type' }),
|
||||
{ target: { value: 'special' } });
|
||||
expect(pushedParams().get('school_type')).toBe('special');
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&school_type=special');
|
||||
view.rerender(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Special school (SEND)' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('names an old raw-label link\'s chip by that label', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&school_type=Community+school');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Community school' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('is left out when the API sends no groups', () => {
|
||||
render(<FilterBar filters={{ ...filters, school_type_groups: undefined }} />);
|
||||
expect(screen.queryByRole('combobox', { name: 'School type' })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Faith', () => {
|
||||
it('offers its options in the More filters panel and in the sheet', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.click(screen.getByRole('button', { name: /More filters/ }));
|
||||
const faiths = ['Any faith or none', 'No religious character', 'Roman Catholic'];
|
||||
expect(optionsOf(document.body, 'Faith')).toEqual(faiths);
|
||||
expect(optionsOf(openSheet(), 'Faith')).toEqual(faiths);
|
||||
});
|
||||
|
||||
it('shows as a chip, counts on both buttons, and clears with Clear all', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&faith=roman_catholic');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Roman Catholic' })).toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: 'Filters, 1 applied' })).toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: /More filters \(1\)/ })).toBeInTheDocument();
|
||||
fireEvent.click(within(screen.getByRole('group', { name: 'Applied filters' }))
|
||||
.getByRole('button', { name: 'Clear all' }));
|
||||
expect(pushedParams().get('faith')).toBeNull();
|
||||
expect(pushedParams().get('postcode')).toBe('SW196AR');
|
||||
});
|
||||
|
||||
it('goes into the search analytics event', () => {
|
||||
params = new URLSearchParams('faith=roman_catholic');
|
||||
render(<FilterBar filters={filters} />);
|
||||
const input = screen.getByRole('searchbox', { name: 'School name or postcode' });
|
||||
fireEvent.change(input, { target: { value: 'st marys' } });
|
||||
fireEvent.submit(input.closest('form')!);
|
||||
expect(track).toHaveBeenCalledWith('search_submitted',
|
||||
expect.objectContaining({ filters_active: 'faith=roman_catholic', filters_count: 1 }));
|
||||
});
|
||||
|
||||
it('is left out when the API sends no faiths', () => {
|
||||
render(<FilterBar filters={{ ...filters, faiths: [] }} />);
|
||||
expect(within(openSheet()).queryByRole('combobox', { name: 'Faith' })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('a URL value the options do not spell the same way', () => {
|
||||
const row = () => screen.getByRole('group', { name: 'Filters' });
|
||||
|
||||
it('shows an old raw-label type in the select, and lets "Any" clear it', () => {
|
||||
params = new URLSearchParams('search=school&school_type=Community+school');
|
||||
render(<FilterBar filters={filters} />);
|
||||
const type = within(row()).getByRole('combobox', { name: 'School type' });
|
||||
expect(type).toHaveValue('Community school');
|
||||
expect(within(type).getByRole('option', { name: 'Community school' })).toBeInTheDocument();
|
||||
fireEvent.change(type, { target: { value: '' } });
|
||||
expect(pushedParams().get('school_type')).toBeNull();
|
||||
});
|
||||
|
||||
it('matches a key in another case, in the select and the chip', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&school_type=Special&faith=Roman_Catholic');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(within(row()).getByRole('combobox', { name: 'School type' })).toHaveValue('special');
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Special school (SEND)' })).toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: 'Remove filter: Roman Catholic' })).toBeInTheDocument();
|
||||
expect(screen.getByRole('combobox', { name: 'Faith' })).toHaveValue('roman_catholic');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,157 @@
|
||||
import { fireEvent, render, screen, within } from '@testing-library/react';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
|
||||
/*
|
||||
* Phones filter through one "Filters" button and a bottom sheet holding every
|
||||
* filter, rather than a sideways-scrolling row whose later chips (phase, type)
|
||||
* sat off-screen beside a "More filters" panel that did not contain them.
|
||||
* Which markup shows at which width is CSS and invisible to jsdom; these pin
|
||||
* the behaviour and the accessible names.
|
||||
*/
|
||||
|
||||
let params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
const push = jest.fn();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useSearchParams: () => params,
|
||||
usePathname: () => '/',
|
||||
useRouter: () => ({ push, replace: jest.fn(), prefetch: jest.fn() }),
|
||||
}));
|
||||
jest.mock('@/lib/analytics', () => ({ track: jest.fn() }));
|
||||
|
||||
const filters = {
|
||||
local_authorities: ['Wandsworth', 'Merton'], school_types: ['Community school'], years: [],
|
||||
phases: ['Primary', 'Secondary'], genders: ['Girls', 'Mixed'], admissions_policies: [],
|
||||
school_type_groups: [{ value: 'council', label: 'State school: council-run' }],
|
||||
};
|
||||
|
||||
const pushedParams = () => new URLSearchParams(push.mock.calls.at(-1)![0].split('?')[1]);
|
||||
|
||||
beforeEach(() => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
push.mockClear();
|
||||
});
|
||||
|
||||
describe('the phone Filters button', () => {
|
||||
it('sits beside the folded search summary', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const summary = screen.getByRole('button', { name: /Edit search/ });
|
||||
expect(summary.parentElement).toContainElement(screen.getByRole('button', { name: 'Filters' }));
|
||||
});
|
||||
|
||||
it('counts every applied filter, phase and type included', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&phase=primary&school_type=council');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Filters, 2 applied' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('is still offered before anything has been searched', () => {
|
||||
params = new URLSearchParams('local_authority=Wandsworth');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: 'Filters, 1 applied' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('stays out of the hero', () => {
|
||||
render(<FilterBar filters={filters} isHero />);
|
||||
expect(screen.queryByRole('button', { name: /^Filters/ })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('the filter sheet', () => {
|
||||
const openSheet = () => {
|
||||
fireEvent.click(screen.getByRole('button', { name: /^Filters/ }));
|
||||
return screen.getByRole('dialog', { name: 'Filters' });
|
||||
};
|
||||
|
||||
it('holds every filter in one place', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const sheet = openSheet();
|
||||
expect(within(sheet).getByRole('radiogroup', { name: 'Distance' })).toBeInTheDocument();
|
||||
for (const name of ['Phase', 'School type', 'Local authority']) {
|
||||
expect(within(sheet).getByRole('combobox', { name })).toBeInTheDocument();
|
||||
}
|
||||
});
|
||||
|
||||
it('shows the secondary-only filters once they apply', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&phase=secondary');
|
||||
render(<FilterBar filters={filters} />);
|
||||
const sheet = openSheet();
|
||||
for (const name of ['Gender', 'Sixth form']) {
|
||||
expect(within(sheet).getByRole('combobox', { name })).toBeInTheDocument();
|
||||
}
|
||||
});
|
||||
|
||||
it('offers distance only for a postcode search', () => {
|
||||
params = new URLSearchParams('search=southmead');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(within(openSheet()).queryByRole('radiogroup', { name: 'Distance' })).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('changes the distance', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const distance = within(openSheet()).getByRole('radiogroup', { name: 'Distance' });
|
||||
expect(within(distance).getByRole('radio', { name: 'Within 1 mile' })).toBeChecked();
|
||||
fireEvent.click(within(distance).getByRole('radio', { name: 'Within 3 miles' }));
|
||||
expect(pushedParams().get('radius')).toBe('3');
|
||||
});
|
||||
|
||||
it('applies a change straight away and stays open for the next one', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const sheet = openSheet();
|
||||
fireEvent.change(within(sheet).getByRole('combobox', { name: 'Phase' }), { target: { value: 'primary' } });
|
||||
expect(pushedParams().get('phase')).toBe('primary');
|
||||
expect(screen.getByRole('dialog', { name: 'Filters' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('closes on the results button, which gives the count', () => {
|
||||
render(<FilterBar filters={filters} resultCount={12} />);
|
||||
fireEvent.click(within(openSheet()).getByRole('button', { name: 'Show 12 schools' }));
|
||||
expect(screen.queryByRole('dialog')).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('says so when nothing matches', () => {
|
||||
render(<FilterBar filters={filters} resultCount={0} />);
|
||||
expect(within(openSheet()).getByRole('button', { name: 'No schools match' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('clears the filters but keeps the search', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&phase=primary&local_authority=Wandsworth');
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.click(within(openSheet()).getByRole('button', { name: 'Clear all' }));
|
||||
const next = pushedParams();
|
||||
expect(next.get('phase')).toBeNull();
|
||||
expect(next.get('local_authority')).toBeNull();
|
||||
expect(next.get('postcode')).toBe('SW196AR');
|
||||
expect(next.get('radius')).toBe('1');
|
||||
});
|
||||
});
|
||||
|
||||
describe('the applied-filter chips', () => {
|
||||
it('appear only when something is applied', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.queryByRole('group', { name: 'Applied filters' })).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('name each filter by its label and remove it on tap', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&phase=primary&gender=girls&has_sixth_form=no');
|
||||
render(<FilterBar filters={filters} />);
|
||||
const chips = screen.getByRole('group', { name: 'Applied filters' });
|
||||
for (const label of ['Primary', 'Girls', 'Without sixth form']) {
|
||||
expect(within(chips).getByRole('button', { name: `Remove filter: ${label}` })).toBeInTheDocument();
|
||||
}
|
||||
fireEvent.click(within(chips).getByRole('button', { name: 'Remove filter: Primary' }));
|
||||
const next = pushedParams();
|
||||
expect(next.get('phase')).toBeNull();
|
||||
expect(next.get('gender')).toBe('girls');
|
||||
expect(next.get('postcode')).toBe('SW196AR');
|
||||
});
|
||||
|
||||
it('carry a Clear all that keeps the search', () => {
|
||||
params = new URLSearchParams('search=southmead&school_type=council');
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.click(within(screen.getByRole('group', { name: 'Applied filters' }))
|
||||
.getByRole('button', { name: 'Clear all' }));
|
||||
const next = pushedParams();
|
||||
expect(next.get('school_type')).toBeNull();
|
||||
expect(next.get('search')).toBe('southmead');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,81 @@
|
||||
import { act, fireEvent, render, screen, within } from '@testing-library/react';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
|
||||
/*
|
||||
* While a filter change is navigating, the sheet's controls stay enabled: a
|
||||
* control disabled under the user's focus drops it to <body>, and a keyboard or
|
||||
* screen-reader user is thrown out of the sheet after every change. A second
|
||||
* change made before the first lands must build on the first, not on the URL
|
||||
* useSearchParams still reports.
|
||||
*/
|
||||
|
||||
// Every transition stays pending, as a slow server render would.
|
||||
jest.mock('react', () => ({
|
||||
...jest.requireActual('react'),
|
||||
useTransition: () => [true, (fn: () => void) => fn()],
|
||||
}));
|
||||
|
||||
const params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
const push = jest.fn();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useSearchParams: () => params,
|
||||
usePathname: () => '/',
|
||||
useRouter: () => ({ push, replace: jest.fn(), prefetch: jest.fn() }),
|
||||
}));
|
||||
jest.mock('@/lib/analytics', () => ({ track: jest.fn() }));
|
||||
|
||||
const filters = {
|
||||
local_authorities: ['Wandsworth'], school_types: ['Community school'], years: [],
|
||||
phases: ['Primary', 'Secondary'], genders: [], admissions_policies: [],
|
||||
school_type_groups: [{ value: 'council', label: 'State school: council-run' }],
|
||||
};
|
||||
|
||||
const pushedParams = () => new URLSearchParams(push.mock.calls.at(-1)![0].split('?')[1]);
|
||||
|
||||
const openSheet = () => {
|
||||
fireEvent.click(screen.getByRole('button', { name: /^Filters/ }));
|
||||
return screen.getByRole('dialog', { name: 'Filters' });
|
||||
};
|
||||
|
||||
beforeEach(() => push.mockClear());
|
||||
|
||||
it('keeps the sheet usable, and says it is busy, while a change lands', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const sheet = openSheet();
|
||||
for (const name of ['Phase', 'School type', 'Local authority']) {
|
||||
expect(within(sheet).getByRole('combobox', { name })).toBeEnabled();
|
||||
}
|
||||
expect(within(sheet).getByRole('radio', { name: 'Within 3 miles' })).toBeEnabled();
|
||||
expect(sheet.querySelector('[aria-busy="true"]')).not.toBeNull();
|
||||
});
|
||||
|
||||
it('builds a second change on the first, not on the URL it has not reached', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const sheet = openSheet();
|
||||
fireEvent.change(within(sheet).getByRole('combobox', { name: 'Phase' }), { target: { value: 'primary' } });
|
||||
fireEvent.change(within(sheet).getByRole('combobox', { name: 'School type' }),
|
||||
{ target: { value: 'council' } });
|
||||
const next = pushedParams();
|
||||
expect(next.get('phase')).toBe('primary');
|
||||
expect(next.get('school_type')).toBe('council');
|
||||
expect(next.get('postcode')).toBe('SW196AR');
|
||||
});
|
||||
|
||||
describe('a screen that widens past phone width', () => {
|
||||
let listeners: ((e: { matches: boolean }) => void)[] = [];
|
||||
beforeEach(() => {
|
||||
listeners = [];
|
||||
window.matchMedia = jest.fn().mockImplementation((query: string) => ({
|
||||
matches: true, media: query,
|
||||
addEventListener: (_: string, l: (e: { matches: boolean }) => void) => listeners.push(l),
|
||||
removeEventListener: jest.fn(),
|
||||
}));
|
||||
});
|
||||
|
||||
it('closes the sheet, leaving the desktop row as the only filters', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
openSheet();
|
||||
act(() => listeners.forEach((l) => l({ matches: false })));
|
||||
expect(screen.queryByRole('dialog')).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
@@ -18,7 +18,10 @@ jest.mock('@/lib/api', () => ({
|
||||
fetchNationalAverages: jest.fn(async () => ({})),
|
||||
fetchLAaverages: jest.fn(async () => ({ secondary: { attainment_8_by_la: {} } })),
|
||||
}));
|
||||
jest.mock('@/components/FilterBar', () => ({ FilterBar: () => null }));
|
||||
// Renders only the List/Map switch HomeView hands it, which lives in its row.
|
||||
jest.mock('@/components/FilterBar', () => ({
|
||||
FilterBar: ({ viewSwitch }: { viewSwitch?: unknown }) => viewSwitch || null,
|
||||
}));
|
||||
jest.mock('@/components/SchoolRow', () => ({ SchoolRow: ({ school }: {school: School}) => <div>{school.school_name}</div> }));
|
||||
jest.mock('@/components/SchoolMap', () => ({ SchoolMap: ({ schools }: {schools: School[]}) => <div data-testid="map">{schools.map(s => s.school_name).join(',')}</div> }));
|
||||
|
||||
@@ -39,15 +42,17 @@ beforeEach(() => {
|
||||
});
|
||||
|
||||
test('load-more results from an old search are discarded, even after returning to it', async () => {
|
||||
// Name searches: a postcode search opens on the map, which has no Load more.
|
||||
params = new URLSearchParams('search=abbey');
|
||||
const pending = deferred();
|
||||
jest.mocked(fetchSchools).mockReturnValueOnce(pending.promise);
|
||||
const view = render(<HomeView initialSchools={response('Initial A')} filters={filters} />);
|
||||
fireEvent.click(screen.getByRole('button', { name: 'Load more schools' }));
|
||||
const signal = jest.mocked(fetchSchools).mock.calls[0][1]?.signal;
|
||||
params = new URLSearchParams('postcode=SW2+1AA');
|
||||
params = new URLSearchParams('search=brecknock');
|
||||
view.rerender(<HomeView initialSchools={response('Initial B')} filters={filters} />);
|
||||
expect(signal?.aborted).toBe(true);
|
||||
params = new URLSearchParams('postcode=SW1A+1AA');
|
||||
params = new URLSearchParams('search=abbey');
|
||||
view.rerender(<HomeView initialSchools={response('Fresh A')} filters={filters} />);
|
||||
await act(async () => pending.resolve(response('Stale append')));
|
||||
expect(screen.queryByText('Stale append')).not.toBeInTheDocument();
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
import { act, fireEvent, render } from '@testing-library/react';
|
||||
import LeafletMapInner from '@/components/LeafletMapInner';
|
||||
import { primaryFixture } from '../support/schoolFixtures';
|
||||
import type { School } from '@/lib/types';
|
||||
|
||||
/*
|
||||
* The results map's own logic, against real Leaflet in jsdom: which pin is
|
||||
* selected, whether the card opens, and what the card offers. jsdom lays out
|
||||
* nothing, so this pins behaviour, never positions.
|
||||
*/
|
||||
|
||||
const base = primaryFixture.schoolInfo;
|
||||
const a: School = { ...base, urn: 1, school_name: 'Southmead Primary School', latitude: 51.43, longitude: -0.21, distance: 0.2, rwm_expected_pct: 52 };
|
||||
const b: School = { ...base, urn: 2, school_name: 'Greenmead School', latitude: 51.431, longitude: -0.205, distance: 0.2,
|
||||
school_type: 'Community special school', rwm_expected_pct: 0, reading_expected_pct: 0, writing_expected_pct: 0, maths_expected_pct: 0 };
|
||||
const schools = [a, b];
|
||||
const centre: [number, number] = [51.43, -0.21];
|
||||
|
||||
function setWide(wide: boolean) {
|
||||
window.matchMedia = ((q: string) => ({
|
||||
matches: wide, media: q, addEventListener() {}, removeEventListener() {},
|
||||
})) as unknown as typeof window.matchMedia;
|
||||
}
|
||||
|
||||
function renderMap(props: Partial<React.ComponentProps<typeof LeafletMapInner>> = {}) {
|
||||
const all = {
|
||||
schools, center: centre, zoom: 13, referencePoint: centre, radiusMiles: 1,
|
||||
nationalAvgRwm: 62, ...props,
|
||||
};
|
||||
const view = render(<LeafletMapInner {...all} />);
|
||||
return { ...view, rerender: (next: Partial<typeof all>) => view.rerender(<LeafletMapInner {...all} {...next} />) };
|
||||
}
|
||||
|
||||
beforeEach(() => setWide(true));
|
||||
|
||||
it('draws a pin per school, the search location and the radius', () => {
|
||||
const { container } = renderMap();
|
||||
expect(container.querySelectorAll('.sc-pin')).toHaveLength(2);
|
||||
expect(container.querySelector('.sc-home')).not.toBeNull();
|
||||
expect(container.querySelector('.sc-radius-label')).toHaveTextContent('1 mile');
|
||||
});
|
||||
|
||||
it('reports a pin click, and marks and opens the selected school', () => {
|
||||
const onMarkerClick = jest.fn();
|
||||
const { container, rerender } = renderMap({ onMarkerClick });
|
||||
fireEvent.click(container.querySelectorAll('.sc-pin')[0]);
|
||||
expect(onMarkerClick).toHaveBeenCalledWith(a);
|
||||
|
||||
rerender({ onMarkerClick, selectedUrn: 1 });
|
||||
expect(container.querySelectorAll('.sc-pin--selected')).toHaveLength(1);
|
||||
expect(container.querySelector('.sc-popup')).toHaveTextContent('Southmead Primary School');
|
||||
expect(container.querySelector('.sc-popup')).toHaveTextContent('52% RWM -10 pts');
|
||||
});
|
||||
|
||||
it('keeps the special-school card free of a benchmark and a placeholder 0%', () => {
|
||||
const { container } = renderMap({ selectedUrn: 2 });
|
||||
const card = container.querySelector('.sc-popup')!;
|
||||
expect(card).toHaveTextContent('Greenmead School');
|
||||
expect(card).not.toHaveTextContent(/%|pts/);
|
||||
});
|
||||
|
||||
it('adds to compare from the card, and the card follows the basket', () => {
|
||||
const onAddToCompare = jest.fn();
|
||||
const { container, rerender } = renderMap({ onAddToCompare, selectedUrn: 1, compareUrns: [] });
|
||||
fireEvent.click(container.querySelector('[data-compare]')!);
|
||||
expect(onAddToCompare).toHaveBeenCalledWith(a);
|
||||
|
||||
rerender({ onAddToCompare, selectedUrn: 1, compareUrns: [1] });
|
||||
expect(container.querySelector('[data-compare]')).toHaveTextContent('✓ Comparing');
|
||||
fireEvent.click(container.querySelector('[data-compare]')!);
|
||||
expect(onAddToCompare).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it('tells the page when the card is closed from the map, but not when replaced', () => {
|
||||
const onDeselect = jest.fn();
|
||||
const { container, rerender } = renderMap({ onDeselect, selectedUrn: 1 });
|
||||
rerender({ onDeselect, selectedUrn: 2 });
|
||||
expect(onDeselect).not.toHaveBeenCalled();
|
||||
|
||||
fireEvent.click(container.querySelector('.leaflet-popup-close-button')!);
|
||||
expect(onDeselect).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('keeps the selection when the results reload under it', () => {
|
||||
const onDeselect = jest.fn();
|
||||
const { container, rerender } = renderMap({ onDeselect, selectedUrn: 1 });
|
||||
act(() => rerender({ onDeselect, selectedUrn: 1, schools: [...schools] }));
|
||||
expect(onDeselect).not.toHaveBeenCalled();
|
||||
expect(container.querySelector('.sc-popup')).toHaveTextContent('Southmead Primary School');
|
||||
});
|
||||
|
||||
it('opens no card on a narrow screen, where the page shows a bottom sheet', () => {
|
||||
setWide(false);
|
||||
const { container } = renderMap({ selectedUrn: 1 });
|
||||
expect(container.querySelectorAll('.sc-pin--selected')).toHaveLength(1);
|
||||
expect(container.querySelector('.sc-popup')).toBeNull();
|
||||
});
|
||||
|
||||
it('puts the card back when the pins are rebuilt for a reason other than the schools', () => {
|
||||
const onDeselect = jest.fn();
|
||||
const { container, rerender } = renderMap({ onDeselect, selectedUrn: 1 });
|
||||
act(() => rerender({ onDeselect, selectedUrn: 1, radiusMiles: 3, referencePoint: [51.43, -0.21] }));
|
||||
expect(onDeselect).not.toHaveBeenCalled();
|
||||
expect(container.querySelector('.sc-radius-label')).toHaveTextContent('3 miles');
|
||||
expect(container.querySelector('.sc-popup')).toHaveTextContent('Southmead Primary School');
|
||||
expect(container.querySelectorAll('.sc-pin--selected')).toHaveLength(1);
|
||||
});
|
||||
@@ -0,0 +1,195 @@
|
||||
import { act, fireEvent, render, screen, within } from '@testing-library/react';
|
||||
import { HomeView } from '@/components/HomeView';
|
||||
import { fetchSchools, fetchNationalAverages } from '@/lib/api';
|
||||
import { primaryFixture } from '../support/schoolFixtures';
|
||||
import type { School, SchoolsResponse } from '@/lib/types';
|
||||
|
||||
/*
|
||||
* The map view: the list beside the map (mockup B), where every postcode
|
||||
* search opens. The map itself is Leaflet and mocked here; what is pinned is what
|
||||
* HomeView hands it and the list it draws beside it.
|
||||
*/
|
||||
|
||||
let params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
jest.mock('next/navigation', () => ({
|
||||
useSearchParams: () => params,
|
||||
usePathname: () => '/',
|
||||
useRouter: () => ({ push: jest.fn(), replace: jest.fn(), prefetch: jest.fn() }),
|
||||
}));
|
||||
jest.mock('@/context/ComparisonContext', () => ({
|
||||
useComparisonContext: () => ({ addSchool: jest.fn(), removeSchool: jest.fn(), selectedSchools: [] }),
|
||||
}));
|
||||
jest.mock('@/lib/api', () => ({
|
||||
fetchSchools: jest.fn(),
|
||||
fetchNationalAverages: jest.fn(),
|
||||
fetchLAaverages: jest.fn(async () => ({ secondary: { attainment_8_by_la: {} } })),
|
||||
}));
|
||||
// Renders only the List/Map switch HomeView hands it, which lives in its row.
|
||||
jest.mock('@/components/FilterBar', () => ({
|
||||
FilterBar: ({ viewSwitch }: { viewSwitch?: unknown }) => viewSwitch || null,
|
||||
}));
|
||||
jest.mock('@/components/SchoolMap', () => ({
|
||||
SchoolMap: ({ selectedUrn, radiusMiles, onMarkerClick, schools }: {
|
||||
selectedUrn: number | null; radiusMiles?: number;
|
||||
onMarkerClick: (s: School) => void; schools: School[];
|
||||
}) => (
|
||||
<div data-testid="map" data-selected={selectedUrn ?? ''} data-radius={radiusMiles}>
|
||||
<button type="button" onClick={() => onMarkerClick(schools[1])}>pin</button>
|
||||
</div>
|
||||
),
|
||||
}));
|
||||
|
||||
const base = primaryFixture.schoolInfo;
|
||||
const southmead: School = {
|
||||
...base, urn: 2, school_name: 'Southmead Primary School', distance: 0.2,
|
||||
school_type: 'Community school', rwm_expected_pct: 52, total_pupils: 269,
|
||||
};
|
||||
const greenmead: School = {
|
||||
...base, urn: 3, school_name: 'Greenmead School', distance: 0.2,
|
||||
school_type: 'Community special school', rwm_expected_pct: 0,
|
||||
reading_expected_pct: 0, writing_expected_pct: 0, maths_expected_pct: 0, total_pupils: 62,
|
||||
};
|
||||
const ourLady: School = {
|
||||
...base, urn: 1, school_name: 'Our Lady Queen of Heaven RC School', distance: 0,
|
||||
school_type: 'Voluntary aided school', rwm_expected_pct: 70, total_pupils: 224,
|
||||
};
|
||||
|
||||
function results(): SchoolsResponse {
|
||||
return {
|
||||
schools: [ourLady, southmead, greenmead], total: 3, page: 1, page_size: 25, total_pages: 1,
|
||||
location_info: { postcode: 'SW196AR', radius: 1.60934, coordinates: [51.42, -0.21] },
|
||||
} as SchoolsResponse;
|
||||
}
|
||||
const filters = { local_authorities: [], school_types: [], years: [], phases: [], genders: [], admissions_policies: [] };
|
||||
|
||||
beforeEach(() => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
jest.mocked(fetchSchools).mockReset().mockResolvedValue(results());
|
||||
jest.mocked(fetchNationalAverages).mockResolvedValue({ primary: { rwm_expected_pct: 62 } } as never);
|
||||
setWide(true);
|
||||
});
|
||||
|
||||
/** Desktop unless a test says otherwise: the list pane is shown from 769px. */
|
||||
function setWide(wide: boolean) {
|
||||
window.matchMedia = ((q: string) => ({
|
||||
matches: wide, media: q, addEventListener() {}, removeEventListener() {},
|
||||
})) as unknown as typeof window.matchMedia;
|
||||
}
|
||||
|
||||
async function renderMap() {
|
||||
const view = render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
await act(async () => {});
|
||||
return view;
|
||||
}
|
||||
|
||||
it('opens a postcode search on the map', async () => {
|
||||
await renderMap();
|
||||
expect(screen.getByTestId('map')).toHaveAttribute('data-radius', '1');
|
||||
expect(screen.getByRole('button', { name: 'Map' })).toHaveAttribute('aria-pressed', 'true');
|
||||
});
|
||||
|
||||
it('lists a name search, which has no map', async () => {
|
||||
params = new URLSearchParams('search=southmead');
|
||||
render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
await act(async () => {});
|
||||
expect(screen.queryByTestId('map')).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('puts the count and the sort in the list beside the map, once', async () => {
|
||||
await renderMap();
|
||||
// Short beside the map, so it shares one line with the sort.
|
||||
expect(screen.getAllByRole('heading', { name: '3 schools within 1 mile' })).toHaveLength(1);
|
||||
expect(screen.getAllByRole('combobox')).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('selects the pin from the card, and the card from the pin', async () => {
|
||||
const { container } = await renderMap();
|
||||
const card = (urn: number) => container.querySelector(`[data-urn="${urn}"]`) as HTMLElement;
|
||||
|
||||
fireEvent.click(within(card(1)).getByText(/pupils/));
|
||||
expect(screen.getByTestId('map')).toHaveAttribute('data-selected', '1');
|
||||
expect(card(1).className).toMatch(/mapRowSelected/);
|
||||
|
||||
fireEvent.click(screen.getByRole('button', { name: 'pin' }));
|
||||
expect(card(2).className).toMatch(/mapRowSelected/);
|
||||
expect(card(1).className).not.toMatch(/mapRowSelected/);
|
||||
});
|
||||
|
||||
it('clicking a card\'s link or button does not also select it', async () => {
|
||||
const { container } = await renderMap();
|
||||
const card = container.querySelector('[data-urn="1"]') as HTMLElement;
|
||||
fireEvent.click(within(card).getByRole('button', { name: '+ Compare' }));
|
||||
expect(screen.getByTestId('map')).toHaveAttribute('data-selected', '');
|
||||
});
|
||||
|
||||
it('shows the England comparison for mainstream schools only, and never a placeholder 0%', async () => {
|
||||
const { container } = await renderMap();
|
||||
const card = (urn: number) => container.querySelector(`[data-urn="${urn}"]`) as HTMLElement;
|
||||
expect(card(2)).toHaveTextContent('52%Reading, Writing & Maths-10 pts vs national');
|
||||
expect(card(2)).toHaveTextContent('269pupils');
|
||||
expect(card(3)).toHaveTextContent('62pupils');
|
||||
expect(card(3)).not.toHaveTextContent(/%|pts/);
|
||||
});
|
||||
|
||||
it('opens the map after a hero search, and keeps the reader\'s choice after that', async () => {
|
||||
// Landing page, then a hero search: the same instance gets new props.
|
||||
params = new URLSearchParams('');
|
||||
const empty = { schools: [], total: 0, page: 1, page_size: 25, total_pages: 0 } as SchoolsResponse;
|
||||
const view = render(<HomeView initialSchools={empty} filters={filters} />);
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
view.rerender(<HomeView initialSchools={results()} filters={filters} />);
|
||||
await act(async () => {});
|
||||
expect(screen.getByTestId('map')).toBeInTheDocument();
|
||||
|
||||
// Chosen: a later search keeps the list.
|
||||
fireEvent.click(screen.getByRole('button', { name: 'List' }));
|
||||
params = new URLSearchParams('postcode=SW170AA&radius=1');
|
||||
view.rerender(<HomeView initialSchools={results()} filters={filters} />);
|
||||
await act(async () => {});
|
||||
expect(screen.queryByTestId('map')).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('builds no list cards on a phone, where the pane is hidden', async () => {
|
||||
setWide(false);
|
||||
const { container } = await renderMap();
|
||||
expect(screen.getByTestId('map')).toBeInTheDocument();
|
||||
expect(container.querySelectorAll('[data-urn]')).toHaveLength(0);
|
||||
// The count stays: it is the pane's heading, shown above the map.
|
||||
expect(screen.getByRole('heading', { name: /3 schools within/ })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('draws the list view\'s own row beside the map, with the same content', async () => {
|
||||
const { container } = await renderMap();
|
||||
const beside = container.querySelector('[data-urn="2"] > [class~="row"]')!.textContent;
|
||||
|
||||
fireEvent.click(screen.getByRole('button', { name: 'List' }));
|
||||
const row = screen.getByRole('link', { name: 'Southmead Primary School' }).closest('[class~="row"]')!;
|
||||
expect(row.parentElement?.className).toMatch(/schoolList/);
|
||||
expect(row.textContent).toBe(beside);
|
||||
});
|
||||
|
||||
it('lets a keyboard pick a pin from the list, with a real button', async () => {
|
||||
await renderMap();
|
||||
const show = screen.getByRole('button', { name: 'Show Southmead Primary School on the map' });
|
||||
expect(show).toHaveAttribute('aria-pressed', 'false');
|
||||
fireEvent.click(show);
|
||||
expect(screen.getByTestId('map')).toHaveAttribute('data-selected', '2');
|
||||
expect(show).toHaveAttribute('aria-pressed', 'true');
|
||||
});
|
||||
|
||||
it('keeps the postcode in the heading in list view, where there is room', async () => {
|
||||
await renderMap();
|
||||
fireEvent.click(screen.getByRole('button', { name: 'List' }));
|
||||
expect(screen.getByRole('heading', { name: '3 schools within 1 mile of SW196AR' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('draws and names a quarter-mile search as 0.25, not rounded to 0.3', async () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=0.25');
|
||||
const quarter = { ...results(), location_info: { postcode: 'SW196AR', radius: 0.25 * 1.60934, coordinates: [51.42, -0.21] } } as SchoolsResponse;
|
||||
render(<HomeView initialSchools={quarter} filters={filters} />);
|
||||
await act(async () => {});
|
||||
expect(screen.getByTestId('map')).toHaveAttribute('data-radius', '0.25');
|
||||
expect(screen.getByRole('heading', { name: '3 schools within 0.25 miles' })).toBeInTheDocument();
|
||||
fireEvent.click(screen.getByRole('button', { name: 'List' }));
|
||||
expect(screen.getByRole('heading', { name: '3 schools within 0.25 miles of SW196AR' })).toBeInTheDocument();
|
||||
});
|
||||
@@ -0,0 +1,198 @@
|
||||
import { act, fireEvent, render, screen, within } from '@testing-library/react';
|
||||
import { HomeView } from '@/components/HomeView';
|
||||
import { FilterBar } from '@/components/FilterBar';
|
||||
import { fetchSchools } from '@/lib/api';
|
||||
import { track } from '@/lib/analytics';
|
||||
import { primaryFixture } from '../support/schoolFixtures';
|
||||
import type { SchoolsResponse } from '@/lib/types';
|
||||
|
||||
/*
|
||||
* The results toolbar (option B of the 2026-09-30 results-controls mockups):
|
||||
* search, filters and the List/Map switch pinned under the header, with a
|
||||
* floating List/Map button standing in for the switch on phones. Layout is CSS
|
||||
* and not visible to jsdom; these pin the behaviour and the accessible names
|
||||
* the E2E journeys rely on.
|
||||
*/
|
||||
|
||||
let params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
const push = jest.fn();
|
||||
jest.mock('next/navigation', () => ({
|
||||
useSearchParams: () => params,
|
||||
usePathname: () => '/',
|
||||
useRouter: () => ({ push, replace: jest.fn(), prefetch: jest.fn() }),
|
||||
}));
|
||||
jest.mock('@/context/ComparisonContext', () => ({
|
||||
useComparisonContext: () => ({ addSchool: jest.fn(), removeSchool: jest.fn(), selectedSchools: [] }),
|
||||
}));
|
||||
jest.mock('@/lib/api', () => ({
|
||||
fetchSchools: jest.fn(),
|
||||
fetchNationalAverages: jest.fn(async () => ({})),
|
||||
fetchLAaverages: jest.fn(async () => ({ secondary: { attainment_8_by_la: {} } })),
|
||||
}));
|
||||
jest.mock('@/lib/analytics', () => ({ track: jest.fn() }));
|
||||
jest.mock('@/components/SchoolMap', () => ({ SchoolMap: () => <div data-testid="map" /> }));
|
||||
|
||||
const filters = {
|
||||
local_authorities: ['Wandsworth'], school_types: ['Community school'], years: [],
|
||||
phases: ['Primary', 'Secondary'], genders: [], admissions_policies: [],
|
||||
school_type_groups: [{ value: 'council', label: 'State school: council-run' }],
|
||||
};
|
||||
|
||||
function results(): SchoolsResponse {
|
||||
return { schools: [{ ...primaryFixture.schoolInfo, school_name: 'Southmead Primary School' }],
|
||||
total: 1, page: 1, page_size: 25, total_pages: 1 };
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1');
|
||||
push.mockClear();
|
||||
jest.mocked(track).mockClear();
|
||||
jest.mocked(fetchSchools).mockReset().mockResolvedValue(results());
|
||||
});
|
||||
|
||||
describe('the List/Map switch', () => {
|
||||
it('lives in the toolbar with the filters and says which view is on', () => {
|
||||
render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
const view = screen.getByRole('group', { name: 'Results view' });
|
||||
expect(view.closest('div[class*="resultsToolbar"]')).not.toBeNull();
|
||||
// A postcode search opens on the map.
|
||||
expect(screen.getByRole('button', { name: 'Map' })).toHaveAttribute('aria-pressed', 'true');
|
||||
expect(screen.getByRole('button', { name: 'List' })).toHaveAttribute('aria-pressed', 'false');
|
||||
});
|
||||
|
||||
it('has a floating twin that flips between map and list', async () => {
|
||||
render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
await act(async () => {});
|
||||
fireEvent.click(screen.getByRole('button', { name: 'Show list' }));
|
||||
expect(screen.queryByTestId('map')).not.toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: 'List' })).toHaveAttribute('aria-pressed', 'true');
|
||||
expect(track).toHaveBeenCalledWith('results_view_changed', { view: 'list', via: 'floating' });
|
||||
|
||||
await act(async () => fireEvent.click(screen.getByRole('button', { name: 'Show map' })));
|
||||
expect(screen.getByTestId('map')).toBeInTheDocument();
|
||||
expect(screen.getByRole('button', { name: 'Show list' })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('does not track a click on the view already showing', async () => {
|
||||
render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
await act(async () => {});
|
||||
fireEvent.click(screen.getByRole('button', { name: 'Map' }));
|
||||
expect(track).not.toHaveBeenCalledWith('results_view_changed', expect.anything());
|
||||
});
|
||||
|
||||
it('is absent from a name search, which has no map', () => {
|
||||
params = new URLSearchParams('search=southmead');
|
||||
render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
expect(screen.queryByRole('group', { name: 'Results view' })).not.toBeInTheDocument();
|
||||
expect(screen.queryByRole('button', { name: 'Show map' })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('the toolbar filters', () => {
|
||||
it('keeps distance, phase and school type in the row, not behind More filters', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const row = screen.getByRole('group', { name: 'Filters' });
|
||||
for (const name of ['Distance', 'Phase', 'School type']) {
|
||||
expect(row).toContainElement(screen.getByRole('combobox', { name }));
|
||||
}
|
||||
expect(screen.getByRole('combobox', { name: 'Distance' })).toHaveDisplayValue('Within 1 mile');
|
||||
expect(screen.queryByRole('combobox', { name: 'Local authority' })).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('counts only what More filters hides', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&school_type=council&local_authority=Wandsworth');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.getByRole('button', { name: /More filters \(1\)/ })).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('the phone chips line', () => {
|
||||
it('drops its "more this way" fade when nothing is left to scroll', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=1&phase=primary');
|
||||
render(<FilterBar filters={filters} />);
|
||||
// jsdom lays nothing out, so the line reads as not overflowing at all.
|
||||
const line = screen.getByRole('group', { name: 'Applied filters' }).parentElement!;
|
||||
expect(line.className).toMatch(/controlsAtEnd/);
|
||||
});
|
||||
});
|
||||
|
||||
describe('the phone filter sheet', () => {
|
||||
it('offers the results total', () => {
|
||||
render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
fireEvent.click(screen.getByRole('button', { name: 'Filters' }));
|
||||
expect(screen.getByRole('button', { name: 'Show 1 school' })).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('the folded search', () => {
|
||||
it('summarises the search and unfolds on tap', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
const summary = screen.getByRole('button', { name: 'Edit search: SW196AR, within 1 mile' });
|
||||
fireEvent.click(summary);
|
||||
expect(screen.queryByRole('button', { name: /Edit search/ })).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('folds again once the edited search is submitted', () => {
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.click(screen.getByRole('button', { name: /Edit search/ }));
|
||||
const input = screen.getByRole('searchbox', { name: 'School name or postcode' });
|
||||
fireEvent.change(input, { target: { value: 'SW19 1AA' } });
|
||||
fireEvent.submit(input.closest('form')!);
|
||||
expect(screen.getByRole('button', { name: /Edit search/ })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('refolds and shows the new text when the search changes some other way', () => {
|
||||
const view = render(<FilterBar filters={filters} />);
|
||||
fireEvent.click(screen.getByRole('button', { name: /Edit search/ }));
|
||||
fireEvent.change(screen.getByRole('searchbox', { name: 'School name or postcode' }),
|
||||
{ target: { value: 'half-typed' } });
|
||||
|
||||
// Back button: the URL changes under the component, nothing is submitted.
|
||||
params = new URLSearchParams('postcode=SW170AA&radius=3');
|
||||
view.rerender(<FilterBar filters={filters} />);
|
||||
|
||||
expect(screen.getByRole('button', { name: 'Edit search: SW170AA, within 3 miles' }))
|
||||
.toBeInTheDocument();
|
||||
expect(screen.getByRole('searchbox', { name: 'School name or postcode' }))
|
||||
.toHaveValue('SW170AA');
|
||||
});
|
||||
|
||||
it('never appears in the hero, or before anything has been searched', () => {
|
||||
const { unmount } = render(<FilterBar filters={filters} isHero />);
|
||||
expect(screen.queryByRole('button', { name: /Edit search/ })).not.toBeInTheDocument();
|
||||
unmount();
|
||||
params = new URLSearchParams('local_authority=Wandsworth');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(screen.queryByRole('button', { name: /Edit search/ })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('the results list', () => {
|
||||
it('repeats no applied filters above the results; the filter bar shows them', () => {
|
||||
params = new URLSearchParams('search=southmead&school_type=council&local_authority=Wandsworth');
|
||||
const { container } = render(<HomeView initialSchools={results()} filters={filters} />);
|
||||
expect(container.querySelector('[class*="activeFilters"]')).toBeNull();
|
||||
expect(screen.queryByText('Search: southmead')).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
describe('the desktop Clear all', () => {
|
||||
const row = () => screen.getByRole('group', { name: 'Filters' });
|
||||
|
||||
it('removes the filters and keeps the search, rather than going home', () => {
|
||||
params = new URLSearchParams('postcode=SW196AR&radius=3&phase=primary&school_type=council&local_authority=Wandsworth');
|
||||
render(<FilterBar filters={filters} />);
|
||||
fireEvent.click(within(row()).getByRole('button', { name: 'Clear all' }));
|
||||
const pushed = push.mock.calls.at(-1)![0] as string;
|
||||
const next = new URLSearchParams(pushed.split('?')[1]);
|
||||
expect(next.get('postcode')).toBe('SW196AR');
|
||||
expect(next.get('radius')).toBe('3');
|
||||
for (const key of ['phase', 'school_type', 'local_authority']) expect(next.get(key)).toBeNull();
|
||||
});
|
||||
|
||||
it('is not offered when only a search is applied', () => {
|
||||
params = new URLSearchParams('search=southmead');
|
||||
render(<FilterBar filters={filters} />);
|
||||
expect(within(row()).queryByRole('button', { name: /^Clear/ })).not.toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
@@ -119,10 +119,13 @@ describe('third-party surfaces under themed text', () => {
|
||||
|
||||
it('still finds a component painting themed text into a Leaflet popup', () => {
|
||||
// Guards the rule below against passing vacuously if the popups are ever
|
||||
// rewritten as React components rather than HTML strings.
|
||||
// rewritten as React components rather than HTML strings. The results
|
||||
// map's card themes its text through classes in SchoolMap.module.css
|
||||
// rather than inline, so a class-built popup counts as well.
|
||||
const themed = sources(COMPONENTS).filter((file) => {
|
||||
const src = fs.readFileSync(file, 'utf8');
|
||||
return /bindPopup\(/.test(src) && /color:var\(--|color: var\(--/.test(src);
|
||||
return /bindPopup\(|L\.popup\(/.test(src)
|
||||
&& (/color:var\(--|color: var\(--/.test(src) || /class="sc-card/.test(src));
|
||||
});
|
||||
|
||||
expect(themed.length).toBeGreaterThan(0);
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
|
||||
/*
|
||||
* SchoolRow and SecondarySchoolRow switch to their narrow layout with a
|
||||
* container query on a `results` container, not a media query, because the
|
||||
* same row fills the phone list and the narrow list beside the desktop map.
|
||||
* Outside a `results` container the query never matches and the row keeps its
|
||||
* wide layout on a phone, a silent regression rather than an error.
|
||||
*
|
||||
* HomeView provides the container on every list it renders the rows into.
|
||||
* Anything else that starts rendering them must do the same; this fails so
|
||||
* that the person adding it reads this first.
|
||||
*/
|
||||
|
||||
const ROOT = path.join(__dirname, '..', '..');
|
||||
const DIRS = ['app', 'components', 'lib'];
|
||||
const ROW_IMPORT = /from\s+['"][^'"]*\/(SchoolRow|SecondarySchoolRow)['"]/;
|
||||
|
||||
function sources(dir: string): string[] {
|
||||
return fs.readdirSync(dir, { withFileTypes: true }).flatMap((entry) => {
|
||||
const full = path.join(dir, entry.name);
|
||||
if (entry.isDirectory()) return entry.name === 'node_modules' ? [] : sources(full);
|
||||
return /\.tsx?$/.test(entry.name) ? [full] : [];
|
||||
});
|
||||
}
|
||||
|
||||
it('renders the results rows only where a `results` container is provided', () => {
|
||||
const importers = DIRS.flatMap((d) => sources(path.join(ROOT, d)))
|
||||
.filter((file) => ROW_IMPORT.test(fs.readFileSync(file, 'utf8')))
|
||||
.map((file) => path.relative(ROOT, file));
|
||||
expect(importers).toEqual(['components/HomeView.tsx']);
|
||||
});
|
||||
|
||||
it('gives each of HomeView\'s row lists the `results` container', () => {
|
||||
const css = fs.readFileSync(path.join(ROOT, 'components', 'HomeView.module.css'), 'utf8');
|
||||
for (const list of ['.schoolList', '.compactList', '.bottomSheet']) {
|
||||
const rule = new RegExp(`\\${list}\\s*\\{[^}]*container:\\s*results\\s*/\\s*inline-size`);
|
||||
expect({ list, provided: rule.test(css) }).toEqual({ list, provided: true });
|
||||
}
|
||||
});
|
||||
@@ -645,6 +645,13 @@ html .leaflet-container a.leaflet-popup-close-button:focus {
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
/* The popup card's View link is a .btn-tertiary, which leaflet.css's
|
||||
`.leaflet-container a` (0,1,1) paints #0078A8 over its 0,1,0. Its hover
|
||||
rule, at 0,3,0, still wins over this. */
|
||||
html .leaflet-container a.btn-tertiary {
|
||||
color: var(--text-secondary);
|
||||
}
|
||||
|
||||
/* Main content column */
|
||||
.main {
|
||||
max-width: 1400px;
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { absoluteUrl } from '@/lib/site';
|
||||
import type { Metadata } from 'next';
|
||||
import { fetchSchools, fetchFilters, fetchDataInfo } from '@/lib/api';
|
||||
import { formatAcademicYear } from '@/lib/utils';
|
||||
import { DEFAULT_RADIUS_MILES, formatAcademicYear } from '@/lib/utils';
|
||||
import { HomeView } from '@/components/HomeView';
|
||||
import { getFlags } from '@/lib/flags';
|
||||
import { HowItWorksSection } from '@/components/HowItWorksSection';
|
||||
@@ -25,6 +25,7 @@ interface HomePageProps {
|
||||
gender?: string;
|
||||
admissions_policy?: string;
|
||||
has_sixth_form?: string;
|
||||
faith?: string;
|
||||
}>;
|
||||
}
|
||||
|
||||
@@ -71,7 +72,9 @@ export default async function HomePage({ searchParams }: HomePageProps) {
|
||||
|
||||
// Parse search params
|
||||
const page = parseInt(params.page || '1');
|
||||
const radius = params.radius ? parseFloat(params.radius) : undefined;
|
||||
// Without this the API applies its own 5-mile default while the Distance
|
||||
// control shows DEFAULT_RADIUS_MILES.
|
||||
const radius = params.radius ? parseFloat(params.radius) : DEFAULT_RADIUS_MILES;
|
||||
|
||||
// Check if user has performed a search
|
||||
const hasSearchParams = !!(
|
||||
@@ -82,7 +85,8 @@ export default async function HomePage({ searchParams }: HomePageProps) {
|
||||
params.postcode ||
|
||||
params.gender ||
|
||||
params.admissions_policy ||
|
||||
params.has_sixth_form
|
||||
params.has_sixth_form ||
|
||||
params.faith
|
||||
);
|
||||
|
||||
// Failures propagate to the retryable error boundary.
|
||||
@@ -103,6 +107,7 @@ export default async function HomePage({ searchParams }: HomePageProps) {
|
||||
gender: params.gender,
|
||||
admissions_policy: params.admissions_policy,
|
||||
has_sixth_form: params.has_sixth_form,
|
||||
faith: params.faith,
|
||||
});
|
||||
} else {
|
||||
// Empty state by default
|
||||
|
||||
@@ -4,8 +4,10 @@
|
||||
* hero a single white pill on the Sand hero panel, carrying the one
|
||||
* coral action the page exists for. No card of its own: the panel
|
||||
* behind it belongs to the page, so the pill reads as the object.
|
||||
* compact the filter rail above the results — a white card of quiet
|
||||
* controls, brand for what is active, sage for what is selected.
|
||||
* compact the results toolbar — search, then a row of pill controls. The
|
||||
* card around it belongs to HomeView, which pins it under the
|
||||
* header and puts the List/Map switch beside it, so the compact
|
||||
* bar draws no card of its own.
|
||||
*
|
||||
* Colour comes from the token layer only; the disclosure arrows are drawn
|
||||
* from currentColor rather than a background image so they follow the theme.
|
||||
@@ -38,6 +40,68 @@
|
||||
margin: 0 auto 1.5rem;
|
||||
}
|
||||
|
||||
/*
|
||||
* One row on wide screens, two below 1340px — decided by the width alone,
|
||||
* never by what the search returned.
|
||||
*
|
||||
* The row once wrapped wherever it ran out of room, and its contents change
|
||||
* with the results: the List/Map switch beside it, the distance chip and Clear
|
||||
* all come and go. So the same search folded onto two lines when it had
|
||||
* results and sat on one when it had none. Now the controls never wrap away
|
||||
* from the search on a wide screen; the search box takes what they leave, and
|
||||
* 1340px is where the fullest toolbar (distance, phase, type, More filters,
|
||||
* Clear and the switch) still leaves it 12rem. The "More filters" panel breaks
|
||||
* onto its own line below both.
|
||||
*/
|
||||
.filterBar:not(.heroMode) {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
background: none;
|
||||
border: 0;
|
||||
border-radius: 0;
|
||||
box-shadow: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.filterBar:not(.heroMode) .searchSection {
|
||||
flex: 1 1 0;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.filterBar:not(.heroMode) .controlsRow {
|
||||
flex: 0 0 auto;
|
||||
flex-wrap: nowrap;
|
||||
}
|
||||
|
||||
/* The List/Map switch closes the line; the "More filters" panel follows it. */
|
||||
.viewSwitchSlot {
|
||||
flex: 0 0 auto;
|
||||
order: 1;
|
||||
}
|
||||
|
||||
/* Below that, the switch stays up beside the search and the controls always
|
||||
take a full-width line of their own, results or not. */
|
||||
@media (min-width: 641px) and (max-width: 1339px) {
|
||||
.viewSwitchSlot {
|
||||
order: 0;
|
||||
}
|
||||
|
||||
.filterBar:not(.heroMode) .controlsRow {
|
||||
flex-basis: 100%;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
}
|
||||
|
||||
/* Only phones fold the form away and filter through the sheet; see the
|
||||
640px block. */
|
||||
.summaryRow,
|
||||
.chipsLine {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* ── Search ───────────────────────────────────────────────────────── */
|
||||
|
||||
.searchSection {
|
||||
@@ -115,8 +179,13 @@
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
.filterBar:not(.heroMode) .omniInput {
|
||||
min-height: 2.75rem;
|
||||
}
|
||||
|
||||
.searchButton {
|
||||
flex: 0 0 auto;
|
||||
min-height: 2.75rem;
|
||||
padding: 0.6875rem 1.25rem;
|
||||
font-size: var(--step--1);
|
||||
border-radius: var(--radius-sm);
|
||||
@@ -217,34 +286,13 @@
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
/* ── Controls row (radius + phase + advanced toggle) ──────────────── */
|
||||
/* ── Controls row (distance, phase, type, more filters) ───────────── */
|
||||
|
||||
.controlsRow {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
flex-wrap: wrap;
|
||||
margin-top: 0.875rem;
|
||||
padding-top: 0.875rem;
|
||||
border-top: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.controlsRow .advancedToggle {
|
||||
margin-left: auto;
|
||||
}
|
||||
|
||||
.radiusControl {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.375rem;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.radiusLabel {
|
||||
font-size: var(--step--2);
|
||||
font-weight: 600;
|
||||
color: var(--text-secondary);
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
/* ── Selects ──────────────────────────────────────────────────────── */
|
||||
@@ -302,11 +350,30 @@
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
/* In the phone sheet a select is a full-width field and a whole touch target. */
|
||||
.sheetSelect {
|
||||
min-height: 2.75rem;
|
||||
}
|
||||
|
||||
/* A pill, 44px tall: these are the page's main controls now, not fine print,
|
||||
and a phone needs the full touch target. */
|
||||
.controlSelect {
|
||||
padding: 0.4375rem 1.875rem 0.4375rem 0.75rem;
|
||||
min-height: 2.75rem;
|
||||
padding: 0 2.25rem 0 1rem;
|
||||
border-color: var(--border-strong);
|
||||
border-radius: 999px;
|
||||
font-size: var(--step--1);
|
||||
font-weight: 500;
|
||||
white-space: nowrap;
|
||||
/* A select is as wide as its longest option, and a school type can run to
|
||||
"Academy special sponsor led". Cap it; the chosen value truncates. The cap
|
||||
is part of the one-line budget above. */
|
||||
max-width: 11rem;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.selectShell:has(.controlSelect) .selectChevron {
|
||||
right: 1rem;
|
||||
}
|
||||
|
||||
.filterSelect:hover:not(:disabled),
|
||||
@@ -335,12 +402,19 @@
|
||||
border-color: var(--brand);
|
||||
}
|
||||
|
||||
/* Capped so an open panel scrolls inside the pinned toolbar instead of
|
||||
pushing the results off a short screen. The 3px gutter keeps the selects'
|
||||
focus rings clear of the scroll clip. */
|
||||
.filters {
|
||||
order: 2;
|
||||
flex-basis: 100%;
|
||||
display: flex;
|
||||
gap: 0.625rem;
|
||||
flex-wrap: wrap;
|
||||
margin-top: 0.75rem;
|
||||
padding-top: 0.75rem;
|
||||
max-height: 50dvh;
|
||||
overflow-y: auto;
|
||||
margin: 0.25rem -3px 0;
|
||||
padding: 0.75rem 3px 3px;
|
||||
border-top: 1px solid var(--border);
|
||||
}
|
||||
|
||||
@@ -350,15 +424,16 @@
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.375rem;
|
||||
padding: 0.4375rem 0.75rem;
|
||||
background: none;
|
||||
border: 1px solid var(--border);
|
||||
border-radius: var(--radius-sm);
|
||||
min-height: 2.75rem;
|
||||
padding: 0 1rem;
|
||||
background: var(--bg-card);
|
||||
border: 1px solid var(--text-secondary);
|
||||
border-radius: 999px;
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 500;
|
||||
font-weight: 600;
|
||||
line-height: 1;
|
||||
color: var(--text-secondary);
|
||||
color: var(--text-primary);
|
||||
cursor: pointer;
|
||||
white-space: nowrap;
|
||||
transition: border-color var(--transition), background-color var(--transition),
|
||||
@@ -387,7 +462,8 @@
|
||||
}
|
||||
|
||||
.clearButton {
|
||||
padding: 0.4375rem 0.875rem;
|
||||
min-height: 2.75rem;
|
||||
padding: 0 1rem;
|
||||
font-size: var(--step--1);
|
||||
font-weight: 500;
|
||||
border-radius: var(--radius-sm);
|
||||
@@ -413,31 +489,6 @@
|
||||
/* ── Narrow ───────────────────────────────────────────────────────── */
|
||||
|
||||
@media (max-width: 768px) {
|
||||
/*
|
||||
* Scoped, like the two rules below it.
|
||||
*
|
||||
* The results filter bar is a card — background, border, shadow — and needs
|
||||
* inner padding. The hero's search is not a card: .heroMode zeroes the
|
||||
* padding, border and background so the search sits directly on the panel.
|
||||
* Unscoped, this rule put 14px back, which indented the search box, the hint
|
||||
* and the location link 14px past the headline they sit under, and cost the
|
||||
* search field 28px of width on a 390px screen.
|
||||
*/
|
||||
.filterBar:not(.heroMode) {
|
||||
padding: 0.875rem;
|
||||
}
|
||||
|
||||
/* The hero pill stays a pill at every width — stacking it would lose the
|
||||
one shape the page is built around. Only the results bar stacks. */
|
||||
.filterBar:not(.heroMode) .omniBoxContainer {
|
||||
flex-direction: column;
|
||||
align-items: stretch;
|
||||
}
|
||||
|
||||
.filterBar:not(.heroMode) .searchButton {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.filters {
|
||||
flex-direction: column;
|
||||
}
|
||||
@@ -446,19 +497,6 @@
|
||||
min-width: 100%;
|
||||
}
|
||||
|
||||
.controlsRow {
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.controlsRow .advancedToggle {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.controlSelect {
|
||||
flex: 1;
|
||||
min-width: 140px;
|
||||
}
|
||||
|
||||
.searchHint {
|
||||
text-align: left;
|
||||
}
|
||||
@@ -518,3 +556,201 @@
|
||||
padding: 0.75rem 0.875rem;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Phones: the results toolbar is pinned, so it is held to two short lines.
|
||||
*
|
||||
* After a search the form folds into a one-line summary ("SW196AR · 1 mi
|
||||
* Edit") with the Filters button beside it, and every filter lives in
|
||||
* the sheet that button opens. A second line, of the applied filters as
|
||||
* chips, appears only once something is applied.
|
||||
*/
|
||||
@media (max-width: 640px) {
|
||||
/*
|
||||
* nowrap matters as much as column. The desktop rule wraps, and in a
|
||||
* wrapping flex container each line is as wide as its widest item's content,
|
||||
* not the container: the search summary (then "SW196AR · within 1 mile Edit",
|
||||
* about 410px) stretched the line, and the controls row with it, 40px past a
|
||||
* 402px iPhone 17 screen. Single-line, stretch means the container's width.
|
||||
*/
|
||||
.filterBar:not(.heroMode) {
|
||||
flex-direction: column;
|
||||
flex-wrap: nowrap;
|
||||
align-items: stretch;
|
||||
gap: 0.625rem;
|
||||
}
|
||||
|
||||
.filterBar:not(.heroMode) .searchSection {
|
||||
flex: 0 0 auto;
|
||||
}
|
||||
|
||||
.searchSummary {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
min-height: 2.75rem;
|
||||
padding: 0 0.875rem;
|
||||
background: var(--bg-card);
|
||||
border: 1px solid var(--border-strong);
|
||||
border-radius: var(--radius-md);
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
color: var(--text-muted);
|
||||
text-align: left;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.summaryText {
|
||||
flex: 1;
|
||||
min-width: 0;
|
||||
overflow: hidden;
|
||||
white-space: nowrap;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.summaryText strong {
|
||||
color: var(--text-primary);
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
.summaryEdit {
|
||||
flex-shrink: 0;
|
||||
font-weight: 600;
|
||||
color: var(--brand);
|
||||
}
|
||||
|
||||
.searchFolded {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* Phones switch views with the floating button (HomeView, .mobileDock). An
|
||||
empty slot would still take a gap in this column. */
|
||||
.viewSwitchSlot {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* The desktop row and its panel give way to the Filters button, the
|
||||
applied-filter chips and the sheet. */
|
||||
.filterBar:not(.heroMode) .controlsRow,
|
||||
.filterBar:not(.heroMode) .filters {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.summaryRow {
|
||||
display: flex;
|
||||
align-items: stretch;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.summaryRow .searchSummary {
|
||||
flex: 1 1 auto;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.sheetTrigger {
|
||||
flex: 0 0 auto;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.375rem;
|
||||
min-height: 2.75rem;
|
||||
padding: 0 0.875rem;
|
||||
background: var(--bg-card);
|
||||
border: 1px solid var(--text-secondary);
|
||||
border-radius: var(--radius-md);
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 600;
|
||||
line-height: 1;
|
||||
color: var(--text-primary);
|
||||
cursor: pointer;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
/* The same brand chip as "More filters" on desktop: the list is narrowed. */
|
||||
.sheetTriggerActive {
|
||||
border-color: var(--brand);
|
||||
background: var(--brand-bg);
|
||||
color: var(--brand);
|
||||
}
|
||||
|
||||
.sheetTriggerCount {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
min-width: 1.25rem;
|
||||
height: 1.25rem;
|
||||
padding: 0 0.3rem;
|
||||
border-radius: 999px;
|
||||
background: var(--brand);
|
||||
color: var(--bg-card);
|
||||
font-size: 0.75rem;
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
/* Bleeds to the screen edge so a chip scrolls out from under it, rather than
|
||||
being cut off at the toolbar's padding. The toolbar's inline padding is
|
||||
1rem at this width (HomeView.module.css, .resultsToolbar). The 4px of
|
||||
block padding is room for focus rings, which the scroll clip would
|
||||
otherwise cut off above and below the chips. */
|
||||
.chipsLine {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
overflow-x: auto;
|
||||
margin: -4px -1rem;
|
||||
padding: 4px 1rem;
|
||||
scrollbar-width: none;
|
||||
mask-image: linear-gradient(to right, #000 calc(100% - 28px), transparent);
|
||||
}
|
||||
|
||||
.controlsAtEnd {
|
||||
mask-image: none;
|
||||
}
|
||||
|
||||
.chipsLine::-webkit-scrollbar {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.chipsLine > *,
|
||||
.chips > * {
|
||||
flex: 0 0 auto;
|
||||
}
|
||||
|
||||
.chips {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.chip {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.375rem;
|
||||
min-height: 2.75rem;
|
||||
padding: 0 0.75rem 0 1rem;
|
||||
background: rgba(var(--sage-rgb), 0.38);
|
||||
border: 1px solid var(--brand);
|
||||
border-radius: 999px;
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 600;
|
||||
line-height: 1;
|
||||
color: var(--brand-strong);
|
||||
cursor: pointer;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
/* A school type can run to "Academy special sponsor led". */
|
||||
.chipLabel {
|
||||
max-width: 11rem;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.chipsClear {
|
||||
min-height: 2.75rem;
|
||||
padding: 0 0.75rem;
|
||||
font-size: var(--step--1);
|
||||
font-weight: 500;
|
||||
}
|
||||
}
|
||||
+552
-152
@@ -3,12 +3,13 @@
|
||||
import { useState, useCallback, useTransition, useRef, useEffect } from "react";
|
||||
import type { ReactNode } from "react";
|
||||
import { useRouter, useSearchParams, usePathname } from "next/navigation";
|
||||
import { isValidPostcode, schoolUrl } from "@/lib/utils";
|
||||
import { DEFAULT_RADIUS_MILES, isValidPostcode, schoolUrl } from "@/lib/utils";
|
||||
import { track } from "@/lib/analytics";
|
||||
import { useSchoolSuggest } from "@/hooks/useSchoolSuggest";
|
||||
import { SuggestList, suggestOptionId } from "./SuggestList";
|
||||
import { FilterSheet, SheetField, RADIUS_OPTIONS, radiusLabel as milesLabel } from "./FilterSheet";
|
||||
import type { Suggestion } from "@/lib/suggest";
|
||||
import type { Filters, ResultFilters } from "@/lib/types";
|
||||
import type { FilterOption, Filters, ResultFilters } from "@/lib/types";
|
||||
import styles from "./FilterBar.module.css";
|
||||
|
||||
interface FilterBarProps {
|
||||
@@ -22,6 +23,14 @@ interface FilterBarProps {
|
||||
geoError?: string | null;
|
||||
/** Server-read feature flag. Off means no listener, no fetch, no markup. */
|
||||
autosuggest?: boolean;
|
||||
/**
|
||||
* The results page's List/Map switch. It sits in this bar's own row rather
|
||||
* than beside it, so that when the bar takes two lines the filters' line
|
||||
* runs the full width instead of stopping short of the switch.
|
||||
*/
|
||||
viewSwitch?: ReactNode;
|
||||
/** The results' total, for the phone filter sheet's "Show N schools". */
|
||||
resultCount?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -46,6 +55,76 @@ function SelectShell({
|
||||
);
|
||||
}
|
||||
|
||||
/** The filters a phone sees as chips and counts on its Filters button. */
|
||||
const FILTER_KEYS = [
|
||||
"phase",
|
||||
"school_type",
|
||||
"faith",
|
||||
"local_authority",
|
||||
"gender",
|
||||
"has_sixth_form",
|
||||
"admissions_policy",
|
||||
] as const;
|
||||
type FilterKey = (typeof FILTER_KEYS)[number];
|
||||
|
||||
/** Filters that only mean something for schools teaching beyond primary. */
|
||||
const SECONDARY_ONLY_KEYS = ["gender", "has_sixth_form", "admissions_policy"] as const;
|
||||
|
||||
/**
|
||||
* False for a phase with no secondary-age pupils, for which those filters are
|
||||
* hidden: Primary, Nursery and Middle deemed primary. Matched on the words,
|
||||
* not exact labels, so a change of case, hyphen or spacing in the GIAS label
|
||||
* cannot leave them showing. The same reading of "primary" as
|
||||
* compareGroups in lib/compareLogic.ts. The API's PHASE_GROUPS answers a
|
||||
* different question (which phases a phase filter returns: primary includes
|
||||
* all-through), so it is not this list.
|
||||
*/
|
||||
function hasSecondaryFilters(phase: string): boolean {
|
||||
const p = phase.toLowerCase().replace(/[^a-z]+/g, " ").trim();
|
||||
return !(p === "nursery" || (p.includes("primary") && !p.includes("secondary")));
|
||||
}
|
||||
|
||||
/**
|
||||
* The option a URL value names, ignoring case as the API does. An old link's
|
||||
* raw GIAS type names none, and is shown as itself.
|
||||
*/
|
||||
function optionFor(options: FilterOption[], value: string) {
|
||||
const v = value.toLowerCase();
|
||||
return options.find((o) => o.value.toLowerCase() === v);
|
||||
}
|
||||
|
||||
/**
|
||||
* A select's value and, when the URL holds something no option spells, an
|
||||
* extra option for it, so the select shows what is applied and "Any" can be
|
||||
* chosen to clear it. Without one, React shows the first option, "Any",
|
||||
* while the list is still filtered, and choosing it changes nothing.
|
||||
*/
|
||||
function selectedOf(options: FilterOption[], value: string) {
|
||||
if (!value) return { value, unlisted: null };
|
||||
const match = optionFor(options, value);
|
||||
return match ? { value: match.value, unlisted: null } : { value, unlisted: value };
|
||||
}
|
||||
|
||||
function SlidersIcon() {
|
||||
return (
|
||||
<svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<path d="M4 6h10M18 6h2M4 12h4M12 12h8M4 18h12" />
|
||||
<circle cx="16" cy="6" r="2" />
|
||||
<circle cx="10" cy="12" r="2" />
|
||||
<circle cx="18" cy="18" r="2" />
|
||||
</svg>
|
||||
);
|
||||
}
|
||||
|
||||
export function FilterBar({
|
||||
filters,
|
||||
isHero,
|
||||
@@ -54,6 +133,8 @@ export function FilterBar({
|
||||
geoState = "idle",
|
||||
geoError,
|
||||
autosuggest = false,
|
||||
viewSwitch,
|
||||
resultCount,
|
||||
}: FilterBarProps) {
|
||||
const router = useRouter();
|
||||
const pathname = usePathname();
|
||||
@@ -63,7 +144,7 @@ export function FilterBar({
|
||||
|
||||
const currentSearch = searchParams.get("search") || "";
|
||||
const currentPostcode = searchParams.get("postcode") || "";
|
||||
const currentRadius = searchParams.get("radius") || "1";
|
||||
const currentRadius = searchParams.get("radius") || String(DEFAULT_RADIUS_MILES);
|
||||
const initialOmniValue = currentPostcode || currentSearch;
|
||||
|
||||
const [omniValue, setOmniValue] = useState(initialOmniValue);
|
||||
@@ -127,11 +208,14 @@ export function FilterBar({
|
||||
const currentGender = searchParams.get("gender") || "";
|
||||
const currentAdmissionsPolicy = searchParams.get("admissions_policy") || "";
|
||||
const currentHasSixthForm = searchParams.get("has_sixth_form") || "";
|
||||
const currentFaith = searchParams.get("faith") || "";
|
||||
|
||||
// Count active dropdown filters (not search/postcode, not phase since it's always visible)
|
||||
// Count the filters behind "More filters". Search, postcode, distance, phase
|
||||
// and school type each have their own control in the toolbar, so they are
|
||||
// visible without opening anything and are not counted here.
|
||||
const activeDropdownFilters = [
|
||||
currentLA,
|
||||
currentType,
|
||||
currentFaith,
|
||||
currentGender,
|
||||
currentAdmissionsPolicy,
|
||||
currentHasSixthForm,
|
||||
@@ -144,6 +228,50 @@ export function FilterBar({
|
||||
if (hasActiveDropdownFilters) setFiltersOpen(true);
|
||||
}, [hasActiveDropdownFilters]);
|
||||
|
||||
/*
|
||||
* On phones the results toolbar is pinned, so it has to stay short. Once a
|
||||
* search has been made the form folds into a one-line summary of it, and
|
||||
* tapping the summary unfolds the form again. Desktop never folds: the
|
||||
* summary is hidden there by CSS and the form is always shown.
|
||||
*/
|
||||
const currentQuery = currentPostcode || currentSearch;
|
||||
const canFold = !isHero && !!currentQuery;
|
||||
const [searchOpen, setSearchOpen] = useState(false);
|
||||
|
||||
// A search that arrives any other way (back/forward, "Use my location", a
|
||||
// link) must fold the form and show its own text, or the summary and the
|
||||
// unfolded input would describe two different searches.
|
||||
const [shownQuery, setShownQuery] = useState(currentQuery);
|
||||
if (shownQuery !== currentQuery) {
|
||||
setShownQuery(currentQuery);
|
||||
setSearchOpen(false);
|
||||
setOmniValue(currentQuery);
|
||||
}
|
||||
|
||||
// The phone chips line's right-edge fade says "more this way"; once there is
|
||||
// no more, it only dims the last chip. Same rule as the school page's
|
||||
// section nav (MOBILE.md, "Right-edge scroll-fade").
|
||||
const controlsRowRef = useRef<HTMLDivElement>(null);
|
||||
const [controlsAtEnd, setControlsAtEnd] = useState(false);
|
||||
const updateControlsAtEnd = useCallback(() => {
|
||||
const el = controlsRowRef.current;
|
||||
if (!el) return;
|
||||
const overflow = el.scrollWidth - el.clientWidth;
|
||||
setControlsAtEnd(overflow <= 1 || el.scrollLeft >= overflow - 2);
|
||||
}, []);
|
||||
useEffect(() => {
|
||||
window.addEventListener("resize", updateControlsAtEnd);
|
||||
return () => window.removeEventListener("resize", updateControlsAtEnd);
|
||||
}, [updateControlsAtEnd]);
|
||||
// Chips come and go with the filters, so re-measure after every render
|
||||
// rather than only on resize.
|
||||
useEffect(updateControlsAtEnd);
|
||||
const openSearch = () => {
|
||||
setSearchOpen(true);
|
||||
// After the form is displayed, or focus() lands on a hidden input.
|
||||
requestAnimationFrame(() => inputRef.current?.focus());
|
||||
};
|
||||
|
||||
useEffect(() => {
|
||||
const handleKeyDown = (e: KeyboardEvent) => {
|
||||
if (
|
||||
@@ -160,9 +288,21 @@ export function FilterBar({
|
||||
return () => document.removeEventListener("keydown", handleKeyDown);
|
||||
}, []);
|
||||
|
||||
/*
|
||||
* Where the navigation in flight is headed. useSearchParams only catches up
|
||||
* once a navigation lands, so a second change made before then (the phone
|
||||
* sheet stays usable while one lands) would otherwise be built on the old
|
||||
* URL and undo the first. Dropped once nothing is pending, when
|
||||
* searchParams is current again.
|
||||
*/
|
||||
const pendingQueryRef = useRef<string | null>(null);
|
||||
useEffect(() => {
|
||||
if (!isPending) pendingQueryRef.current = null;
|
||||
}, [isPending]);
|
||||
|
||||
const updateURL = useCallback(
|
||||
(updates: Record<string, string>) => {
|
||||
const params = new URLSearchParams(searchParams);
|
||||
const params = new URLSearchParams(pendingQueryRef.current ?? searchParams);
|
||||
|
||||
Object.entries(updates).forEach(([key, value]) => {
|
||||
if (value && value !== "") {
|
||||
@@ -173,6 +313,7 @@ export function FilterBar({
|
||||
});
|
||||
|
||||
params.delete("page");
|
||||
pendingQueryRef.current = params.toString();
|
||||
|
||||
startTransition(() => {
|
||||
router.push(`${pathname}?${params.toString()}`);
|
||||
@@ -186,6 +327,7 @@ export function FilterBar({
|
||||
// The search has been made; the suggestions that led to it are spent.
|
||||
setHasTyped(false);
|
||||
close();
|
||||
setSearchOpen(false);
|
||||
if (!omniValue.trim()) {
|
||||
updateURL({ search: "", postcode: "", radius: "" });
|
||||
return;
|
||||
@@ -200,6 +342,7 @@ export function FilterBar({
|
||||
currentPhase && `phase=${currentPhase}`,
|
||||
currentLA && `la=${currentLA}`,
|
||||
currentType && `type=${currentType}`,
|
||||
currentFaith && `faith=${currentFaith}`,
|
||||
currentGender && `gender=${currentGender}`,
|
||||
currentAdmissionsPolicy && `admissions=${currentAdmissionsPolicy}`,
|
||||
currentHasSixthForm && `sixth_form=${currentHasSixthForm}`,
|
||||
@@ -216,7 +359,7 @@ export function FilterBar({
|
||||
if (isPostcode) {
|
||||
updateURL({
|
||||
postcode: cleaned.toUpperCase(),
|
||||
radius: currentRadius || "1",
|
||||
radius: currentRadius,
|
||||
search: "",
|
||||
});
|
||||
} else {
|
||||
@@ -225,47 +368,314 @@ export function FilterBar({
|
||||
};
|
||||
|
||||
const handleFilterChange = (key: string, value: string) => {
|
||||
updateURL({ [key]: value });
|
||||
// A primary phase hides the secondary-only filters, so it clears them
|
||||
// too: left applied, they would empty the list with no control showing.
|
||||
const cleared =
|
||||
key === "phase" && !hasSecondaryFilters(value)
|
||||
? Object.fromEntries(SECONDARY_ONLY_KEYS.map((k) => [k, ""]))
|
||||
: {};
|
||||
updateURL({ ...cleared, [key]: value });
|
||||
};
|
||||
|
||||
const handleClearFilters = () => {
|
||||
setOmniValue("");
|
||||
startTransition(() => {
|
||||
router.push(pathname);
|
||||
});
|
||||
// Every filter at once, keeping the search and its distance. The search is
|
||||
// what the results answer, not a filter on them: clearing it too used to
|
||||
// send desktop back to the home page.
|
||||
const handleClearFilterValues = () => {
|
||||
updateURL(Object.fromEntries(FILTER_KEYS.map((k) => [k, ""])));
|
||||
};
|
||||
|
||||
const hasActiveFilters =
|
||||
currentSearch ||
|
||||
currentLA ||
|
||||
currentType ||
|
||||
currentPhase ||
|
||||
currentPostcode ||
|
||||
currentGender ||
|
||||
currentAdmissionsPolicy ||
|
||||
currentHasSixthForm;
|
||||
|
||||
// Use result-scoped filter values when available, fall back to global
|
||||
/*
|
||||
* A filter's options come from the full lists, not from the results: the
|
||||
* results have already been narrowed by that filter, so scoping to them
|
||||
* would leave only the chosen value on offer, and switching (Girls to Boys,
|
||||
* one school type to another) would need clearing first.
|
||||
*
|
||||
* Local authority is the exception, scoped to the results so a postcode
|
||||
* search offers the councils nearby rather than all of England's.
|
||||
*/
|
||||
const laOptions =
|
||||
resultFilters?.local_authorities ?? filters.local_authorities;
|
||||
const typeOptions = resultFilters?.school_types ?? filters.school_types;
|
||||
const phaseOptions = resultFilters?.phases ?? filters.phases ?? [];
|
||||
const genderOptions = resultFilters?.genders ?? filters.genders ?? [];
|
||||
const admissionsPolicyOptions =
|
||||
resultFilters?.admissions_policies ?? filters.admissions_policies ?? [];
|
||||
// Five groups a parent recognises, not GIAS's 34 establishment types.
|
||||
const typeOptions = filters.school_type_groups ?? [];
|
||||
const faithOptions = filters.faiths ?? [];
|
||||
const phaseOptions = filters.phases ?? [];
|
||||
const genderOptions = filters.genders ?? [];
|
||||
const admissionsPolicyOptions = filters.admissions_policies ?? [];
|
||||
|
||||
const isSecondaryMode =
|
||||
currentPhase === "secondary" || genderOptions.length > 0;
|
||||
// Set by the phase chosen, never by what the results happen to contain.
|
||||
const isSecondaryMode = hasSecondaryFilters(currentPhase);
|
||||
|
||||
// A select that is narrowing the results carries a sage tint; the class is
|
||||
// only ever additive, so the control's behaviour is untouched.
|
||||
const activeIf = (value: string) => (value ? ` ${styles.selectActive}` : "");
|
||||
|
||||
const radiusLabel = milesLabel(currentRadius);
|
||||
|
||||
/*
|
||||
* Phones filter through one button and a sheet holding every filter. The
|
||||
* desktop row's phone version scrolled sideways with "More filters" first,
|
||||
* so phase showed only in part and school type not at all, and the panel
|
||||
* "More filters" opened did not contain either of them.
|
||||
*/
|
||||
const [sheetOpen, setSheetOpen] = useState(false);
|
||||
// The sheet is phone furniture: if the screen widens past phone width while
|
||||
// it is open (rotation, a resized window), close it, or its selects and the
|
||||
// desktop row's would both be showing.
|
||||
useEffect(() => {
|
||||
if (!sheetOpen || typeof window.matchMedia !== "function") return;
|
||||
const phone = window.matchMedia("(max-width: 640px)");
|
||||
const onChange = (e: { matches: boolean }) => {
|
||||
if (!e.matches) setSheetOpen(false);
|
||||
};
|
||||
phone.addEventListener("change", onChange);
|
||||
return () => phone.removeEventListener("change", onChange);
|
||||
}, [sheetOpen]);
|
||||
const values: Record<FilterKey, string> = {
|
||||
phase: currentPhase,
|
||||
school_type: currentType,
|
||||
faith: currentFaith,
|
||||
local_authority: currentLA,
|
||||
gender: currentGender,
|
||||
has_sixth_form: currentHasSixthForm,
|
||||
admissions_policy: currentAdmissionsPolicy,
|
||||
};
|
||||
const labelFor = (key: FilterKey, value: string) => {
|
||||
if (key === "has_sixth_form") {
|
||||
return value === "yes" ? "With sixth form" : "Without sixth form";
|
||||
}
|
||||
// An old link may carry a raw GIAS type, which reads as itself.
|
||||
const labelled = { school_type: typeOptions, faith: faithOptions }[
|
||||
key as "school_type" | "faith"
|
||||
];
|
||||
if (labelled) return optionFor(labelled, value)?.label ?? value;
|
||||
// Phase, gender and admissions values are lowercased option names; the
|
||||
// rest are the names themselves.
|
||||
const named: Partial<Record<FilterKey, string[]>> = {
|
||||
phase: phaseOptions,
|
||||
gender: genderOptions,
|
||||
admissions_policy: admissionsPolicyOptions,
|
||||
};
|
||||
return (named[key] ?? []).find((o) => o.toLowerCase() === value.toLowerCase()) ?? value;
|
||||
};
|
||||
const applied = FILTER_KEYS.filter((k) => values[k]).map((key) => ({
|
||||
key,
|
||||
label: labelFor(key, values[key]),
|
||||
}));
|
||||
const appliedCount = applied.length;
|
||||
|
||||
/*
|
||||
* Each select is built here once and drawn twice: as a pill in the desktop
|
||||
* row or panel, and as a full-width labelled field in the phone sheet. Only
|
||||
* one copy is ever showing; the sheet's is mounted only while it is open.
|
||||
* The sheet's stay enabled while a change lands: disabling the control
|
||||
* under the user's focus would drop focus to <body>, out of the dialog.
|
||||
*/
|
||||
type Look = "pill" | "panel" | "sheet";
|
||||
const selectClass = (look: Look, value: string) =>
|
||||
`${look === "pill" ? styles.controlSelect : styles.filterSelect}${look === "sheet" ? ` ${styles.sheetSelect}` : ""}${activeIf(value)}`;
|
||||
|
||||
const phaseSelect = (look: Look) => (
|
||||
<SelectShell wide={look !== "pill"}>
|
||||
<select
|
||||
value={currentPhase}
|
||||
onChange={(e) => handleFilterChange("phase", e.target.value)}
|
||||
className={selectClass(look, currentPhase)}
|
||||
aria-label="Phase"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">Any phase</option>
|
||||
{phaseOptions.map((p) => (
|
||||
<option key={p} value={p.toLowerCase()}>
|
||||
{p}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
|
||||
const typeSelected = selectedOf(typeOptions, currentType);
|
||||
const faithSelected = selectedOf(faithOptions, currentFaith);
|
||||
|
||||
const typeSelect = (look: Look) => (
|
||||
<SelectShell wide={look !== "pill"}>
|
||||
<select
|
||||
value={typeSelected.value}
|
||||
onChange={(e) => handleFilterChange("school_type", e.target.value)}
|
||||
className={selectClass(look, currentType)}
|
||||
aria-label="School type"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">Any school type</option>
|
||||
{typeSelected.unlisted && (
|
||||
<option value={typeSelected.unlisted}>{typeSelected.unlisted}</option>
|
||||
)}
|
||||
{typeOptions.map((o) => (
|
||||
<option key={o.value} value={o.value}>
|
||||
{o.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
|
||||
const laSelect = (look: Look) => (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentLA}
|
||||
onChange={(e) => handleFilterChange("local_authority", e.target.value)}
|
||||
className={selectClass(look, currentLA)}
|
||||
aria-label="Local authority"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">All Local Authorities</option>
|
||||
{laOptions.map((la) => (
|
||||
<option key={la} value={la}>
|
||||
{la}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
|
||||
const faithSelect = (look: Look) => (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={faithSelected.value}
|
||||
onChange={(e) => handleFilterChange("faith", e.target.value)}
|
||||
className={selectClass(look, currentFaith)}
|
||||
aria-label="Faith"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">Any faith or none</option>
|
||||
{faithSelected.unlisted && (
|
||||
<option value={faithSelected.unlisted}>{faithSelected.unlisted}</option>
|
||||
)}
|
||||
{faithOptions.map((o) => (
|
||||
<option key={o.value} value={o.value}>
|
||||
{o.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
|
||||
const genderSelect = (look: Look) => (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentGender}
|
||||
onChange={(e) => handleFilterChange("gender", e.target.value)}
|
||||
className={selectClass(look, currentGender)}
|
||||
aria-label="Gender"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">Boys, Girls & Mixed</option>
|
||||
{genderOptions.map((g) => (
|
||||
<option key={g} value={g.toLowerCase()}>
|
||||
{g}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
|
||||
const sixthFormSelect = (look: Look) => (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentHasSixthForm}
|
||||
onChange={(e) => handleFilterChange("has_sixth_form", e.target.value)}
|
||||
className={selectClass(look, currentHasSixthForm)}
|
||||
aria-label="Sixth form"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">With or without sixth form</option>
|
||||
<option value="yes">With sixth form</option>
|
||||
<option value="no">Without sixth form</option>
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
|
||||
const admissionsSelect = (look: Look) => (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentAdmissionsPolicy}
|
||||
onChange={(e) => handleFilterChange("admissions_policy", e.target.value)}
|
||||
className={selectClass(look, currentAdmissionsPolicy)}
|
||||
aria-label="Admissions"
|
||||
disabled={isPending && look !== "sheet"}
|
||||
>
|
||||
<option value="">All admissions types</option>
|
||||
{admissionsPolicyOptions.map((p) => (
|
||||
<option key={p} value={p.toLowerCase()}>
|
||||
{p}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
);
|
||||
|
||||
const sheetTrigger = (
|
||||
<button
|
||||
type="button"
|
||||
className={`${styles.sheetTrigger}${appliedCount ? ` ${styles.sheetTriggerActive}` : ""}`}
|
||||
onClick={() => setSheetOpen(true)}
|
||||
aria-haspopup="dialog"
|
||||
aria-label={appliedCount ? `Filters, ${appliedCount} applied` : "Filters"}
|
||||
>
|
||||
<SlidersIcon />
|
||||
Filters
|
||||
{appliedCount > 0 && (
|
||||
<span className={styles.sheetTriggerCount} aria-hidden="true">
|
||||
{appliedCount}
|
||||
</span>
|
||||
)}
|
||||
</button>
|
||||
);
|
||||
// Beside the folded search summary; on the chips line when there is no
|
||||
// summary to sit beside. While the search is being edited it steps aside,
|
||||
// and comes back when the form folds.
|
||||
const triggerBesideSummary = canFold && !searchOpen;
|
||||
const triggerOnChipsLine = !canFold;
|
||||
|
||||
return (
|
||||
<div
|
||||
className={`${styles.filterBar} ${isPending ? styles.isLoading : ""} ${isHero ? styles.heroMode : ""}`}
|
||||
>
|
||||
<form onSubmit={handleSearchSubmit} className={styles.searchSection}>
|
||||
{triggerBesideSummary && (
|
||||
<div className={styles.summaryRow}>
|
||||
<button
|
||||
type="button"
|
||||
className={styles.searchSummary}
|
||||
onClick={openSearch}
|
||||
aria-label={`Edit search: ${currentQuery}${currentPostcode ? `, within ${radiusLabel}` : ""}`}
|
||||
>
|
||||
<svg
|
||||
width="18"
|
||||
height="18"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<circle cx="11" cy="11" r="7" />
|
||||
<path d="m20 20-3.5-3.5" />
|
||||
</svg>
|
||||
<span className={styles.summaryText}>
|
||||
<strong>{currentQuery}</strong>
|
||||
{/* Short, so the distance survives beside the Filters button on a
|
||||
360px screen; the button's name carries the long form. */}
|
||||
{currentPostcode && <span> · {currentRadius} mi</span>}
|
||||
</span>
|
||||
<span className={styles.summaryEdit} aria-hidden="true">Edit</span>
|
||||
</button>
|
||||
{sheetTrigger}
|
||||
</div>
|
||||
)}
|
||||
<form
|
||||
onSubmit={handleSearchSubmit}
|
||||
className={`${styles.searchSection}${canFold && !searchOpen ? ` ${styles.searchFolded}` : ""}`}
|
||||
>
|
||||
<div className={styles.omniBoxContainer}>
|
||||
{isHero && (
|
||||
<span className={styles.omniIcon} aria-hidden="true">
|
||||
@@ -292,6 +702,7 @@ export function FilterBar({
|
||||
onKeyDown={handleOmniKeyDown}
|
||||
onBlur={close}
|
||||
placeholder="School name or postcode"
|
||||
aria-label="School name or postcode"
|
||||
className={styles.omniInput}
|
||||
{...(autosuggest ? {
|
||||
role: "combobox",
|
||||
@@ -370,51 +781,43 @@ export function FilterBar({
|
||||
|
||||
{!isHero && (
|
||||
<>
|
||||
<div className={styles.controlsRow}>
|
||||
{viewSwitch && (
|
||||
<div className={styles.viewSwitchSlot}>{viewSwitch}</div>
|
||||
)}
|
||||
{/* Desktop and tablet. Every control here is a real <select> or
|
||||
<button>, drawn as a pill. Phones hide the row and use the
|
||||
Filters button and sheet instead. */}
|
||||
<div className={styles.controlsRow} role="group" aria-label="Filters">
|
||||
{currentPostcode && (
|
||||
<div className={styles.radiusControl}>
|
||||
<label className={styles.radiusLabel}>Within:</label>
|
||||
<SelectShell>
|
||||
<select
|
||||
value={currentRadius}
|
||||
onChange={(e) => updateURL({ radius: e.target.value })}
|
||||
className={styles.controlSelect}
|
||||
disabled={isPending}
|
||||
>
|
||||
<option value="0.5">0.5 miles</option>
|
||||
<option value="1">1 mile</option>
|
||||
<option value="3">3 miles</option>
|
||||
<option value="5">5 miles</option>
|
||||
</select>
|
||||
</SelectShell>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{phaseOptions.length > 0 && (
|
||||
<SelectShell>
|
||||
<select
|
||||
value={currentPhase}
|
||||
onChange={(e) => handleFilterChange("phase", e.target.value)}
|
||||
className={`${styles.controlSelect}${activeIf(currentPhase)}`}
|
||||
value={currentRadius}
|
||||
onChange={(e) => updateURL({ radius: e.target.value })}
|
||||
className={`${styles.controlSelect} ${styles.selectActive}`}
|
||||
aria-label="Distance"
|
||||
disabled={isPending}
|
||||
>
|
||||
<option value="">All Phases</option>
|
||||
{phaseOptions.map((p) => (
|
||||
<option key={p} value={p.toLowerCase()}>
|
||||
{p}
|
||||
{RADIUS_OPTIONS.map((r) => (
|
||||
<option key={r} value={r}>
|
||||
Within {milesLabel(r)}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
)}
|
||||
|
||||
{phaseOptions.length > 0 && phaseSelect("pill")}
|
||||
|
||||
{typeOptions.length > 0 && typeSelect("pill")}
|
||||
|
||||
<button
|
||||
type="button"
|
||||
className={`${styles.advancedToggle}${hasActiveDropdownFilters ? ` ${styles.advancedToggleActive}` : ''}`}
|
||||
onClick={() => setFiltersOpen((v) => !v)}
|
||||
aria-expanded={filtersOpen}
|
||||
>
|
||||
{hasActiveDropdownFilters ? 'Filters' : 'Advanced'}
|
||||
<SlidersIcon />
|
||||
More filters
|
||||
{hasActiveDropdownFilters
|
||||
? ` (${activeDropdownFilters.length})`
|
||||
: ""}
|
||||
@@ -423,116 +826,113 @@ export function FilterBar({
|
||||
/>
|
||||
</button>
|
||||
|
||||
{hasActiveFilters && (
|
||||
{appliedCount > 0 && (
|
||||
<button
|
||||
onClick={handleClearFilters}
|
||||
onClick={handleClearFilterValues}
|
||||
className={`btn btn-tertiary ${styles.clearButton}`}
|
||||
type="button"
|
||||
disabled={isPending}
|
||||
>
|
||||
Clear
|
||||
Clear all
|
||||
</button>
|
||||
)}
|
||||
</div>
|
||||
|
||||
{filtersOpen && (
|
||||
<div className={styles.filters}>
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentLA}
|
||||
onChange={(e) =>
|
||||
handleFilterChange("local_authority", e.target.value)
|
||||
}
|
||||
className={`${styles.filterSelect}${activeIf(currentLA)}`}
|
||||
disabled={isPending}
|
||||
>
|
||||
<option value="">All Local Authorities</option>
|
||||
{laOptions.map((la) => (
|
||||
<option key={la} value={la}>
|
||||
{la}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentType}
|
||||
onChange={(e) =>
|
||||
handleFilterChange("school_type", e.target.value)
|
||||
}
|
||||
className={`${styles.filterSelect}${activeIf(currentType)}`}
|
||||
disabled={isPending}
|
||||
>
|
||||
<option value="">All School Types</option>
|
||||
{typeOptions.map((type) => (
|
||||
<option key={type} value={type}>
|
||||
{type}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
{laSelect("panel")}
|
||||
{faithOptions.length > 0 && faithSelect("panel")}
|
||||
|
||||
{isSecondaryMode && (
|
||||
<>
|
||||
{genderOptions.length > 0 && (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentGender}
|
||||
onChange={(e) =>
|
||||
handleFilterChange("gender", e.target.value)
|
||||
}
|
||||
className={`${styles.filterSelect}${activeIf(currentGender)}`}
|
||||
disabled={isPending}
|
||||
>
|
||||
<option value="">Boys, Girls & Mixed</option>
|
||||
{genderOptions.map((g) => (
|
||||
<option key={g} value={g.toLowerCase()}>
|
||||
{g}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
)}
|
||||
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentHasSixthForm}
|
||||
onChange={(e) =>
|
||||
handleFilterChange("has_sixth_form", e.target.value)
|
||||
}
|
||||
className={`${styles.filterSelect}${activeIf(currentHasSixthForm)}`}
|
||||
disabled={isPending}
|
||||
>
|
||||
<option value="">With or without sixth form</option>
|
||||
<option value="yes">With sixth form</option>
|
||||
<option value="no">Without sixth form</option>
|
||||
</select>
|
||||
</SelectShell>
|
||||
|
||||
{admissionsPolicyOptions.length > 0 && (
|
||||
<SelectShell wide>
|
||||
<select
|
||||
value={currentAdmissionsPolicy}
|
||||
onChange={(e) =>
|
||||
handleFilterChange("admissions_policy", e.target.value)
|
||||
}
|
||||
className={`${styles.filterSelect}${activeIf(currentAdmissionsPolicy)}`}
|
||||
disabled={isPending}
|
||||
>
|
||||
<option value="">All admissions types</option>
|
||||
{admissionsPolicyOptions.map((p) => (
|
||||
<option key={p} value={p.toLowerCase()}>
|
||||
{p}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</SelectShell>
|
||||
)}
|
||||
{genderOptions.length > 0 && genderSelect("panel")}
|
||||
{sixthFormSelect("panel")}
|
||||
{admissionsPolicyOptions.length > 0 && admissionsSelect("panel")}
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
)}
|
||||
|
||||
{/* Phones: what is applied, each removable with a tap. The line
|
||||
scrolls sideways if it overflows, under the same right-edge fade
|
||||
as the school page's section nav. */}
|
||||
{(appliedCount > 0 || triggerOnChipsLine) && (
|
||||
<div
|
||||
ref={controlsRowRef}
|
||||
className={`${styles.chipsLine}${controlsAtEnd ? ` ${styles.controlsAtEnd}` : ""}`}
|
||||
onScroll={updateControlsAtEnd}
|
||||
>
|
||||
{triggerOnChipsLine && sheetTrigger}
|
||||
{appliedCount > 0 && (
|
||||
<div className={styles.chips} role="group" aria-label="Applied filters">
|
||||
{applied.map(({ key, label }) => (
|
||||
<button
|
||||
key={key}
|
||||
type="button"
|
||||
className={styles.chip}
|
||||
onClick={() => handleFilterChange(key, "")}
|
||||
aria-label={`Remove filter: ${label}`}
|
||||
disabled={isPending}
|
||||
>
|
||||
<span className={styles.chipLabel}>{label}</span>
|
||||
<svg
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2.5"
|
||||
strokeLinecap="round"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<path d="M18 6 6 18M6 6l12 12" />
|
||||
</svg>
|
||||
</button>
|
||||
))}
|
||||
<button
|
||||
type="button"
|
||||
className={`btn btn-tertiary ${styles.chipsClear}`}
|
||||
onClick={handleClearFilterValues}
|
||||
disabled={isPending}
|
||||
>
|
||||
Clear all
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
)}
|
||||
|
||||
<FilterSheet
|
||||
open={sheetOpen}
|
||||
onClose={() => setSheetOpen(false)}
|
||||
radius={currentPostcode ? currentRadius : null}
|
||||
onRadiusChange={(r) => updateURL({ radius: r })}
|
||||
onClearAll={appliedCount > 0 ? handleClearFilterValues : undefined}
|
||||
resultCount={resultCount}
|
||||
isPending={isPending}
|
||||
>
|
||||
{phaseOptions.length > 0 && (
|
||||
<SheetField label="Phase">{phaseSelect("sheet")}</SheetField>
|
||||
)}
|
||||
{typeOptions.length > 0 && (
|
||||
<SheetField label="School type">{typeSelect("sheet")}</SheetField>
|
||||
)}
|
||||
{faithOptions.length > 0 && (
|
||||
<SheetField label="Faith">{faithSelect("sheet")}</SheetField>
|
||||
)}
|
||||
<SheetField label="Local authority">{laSelect("sheet")}</SheetField>
|
||||
{isSecondaryMode && (
|
||||
<>
|
||||
{genderOptions.length > 0 && (
|
||||
<SheetField label="Gender">{genderSelect("sheet")}</SheetField>
|
||||
)}
|
||||
<SheetField label="Sixth form">{sixthFormSelect("sheet")}</SheetField>
|
||||
{admissionsPolicyOptions.length > 0 && (
|
||||
<SheetField label="Admissions">{admissionsSelect("sheet")}</SheetField>
|
||||
)}
|
||||
</>
|
||||
)}
|
||||
</FilterSheet>
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
/* ── Phone filter sheet ───────────────────────────────────────────── */
|
||||
|
||||
.body {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 1rem;
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.field {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.375rem;
|
||||
}
|
||||
|
||||
.fieldLabel {
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 600;
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
/* Distance: five joined segments, a full-width row. At 360px each is about
|
||||
65px wide, clear of the 44px minimum. */
|
||||
.segments {
|
||||
display: flex;
|
||||
border: 1px solid var(--border-strong);
|
||||
border-radius: var(--radius-sm);
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.segment {
|
||||
position: relative;
|
||||
flex: 1 1 0;
|
||||
display: flex;
|
||||
}
|
||||
|
||||
.segment + .segment {
|
||||
border-left: 1px solid var(--border);
|
||||
}
|
||||
|
||||
/* The real radio stays in the tree for keyboard and screen readers; the span
|
||||
is what is drawn. */
|
||||
.segment input {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
margin: 0;
|
||||
opacity: 0;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.segment span {
|
||||
flex: 1;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
min-height: 2.75rem;
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 500;
|
||||
color: var(--text-primary);
|
||||
background: var(--bg-card);
|
||||
white-space: nowrap;
|
||||
transition: background-color var(--transition), color var(--transition);
|
||||
}
|
||||
|
||||
.segment input:checked + span {
|
||||
background: rgba(var(--sage-rgb), 0.38);
|
||||
color: var(--brand-strong);
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
.segment input:focus-visible + span {
|
||||
box-shadow: inset 0 0 0 2px var(--brand);
|
||||
}
|
||||
|
||||
.footer {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.clearAll {
|
||||
min-height: 2.75rem;
|
||||
padding: 0 1rem;
|
||||
}
|
||||
|
||||
.show {
|
||||
flex: 1;
|
||||
min-height: 2.75rem;
|
||||
justify-content: center;
|
||||
}
|
||||
@@ -0,0 +1,121 @@
|
||||
"use client";
|
||||
|
||||
import { useId } from "react";
|
||||
import type { ReactNode } from "react";
|
||||
import { Modal } from "./Modal";
|
||||
import styles from "./FilterSheet.module.css";
|
||||
|
||||
export const RADIUS_OPTIONS = ["0.25", "0.5", "1", "3", "5"] as const;
|
||||
|
||||
export const radiusLabel = (r: string) => `${r} mile${r === "1" ? "" : "s"}`;
|
||||
|
||||
interface FilterSheetProps {
|
||||
open: boolean;
|
||||
onClose: () => void;
|
||||
/** The current distance, or null when the search is not by postcode. */
|
||||
radius: string | null;
|
||||
onRadiusChange: (radius: string) => void;
|
||||
/** The filter selects, each already labelled; FilterBar owns their state. */
|
||||
children: ReactNode;
|
||||
/** Shown only when something is applied. */
|
||||
onClearAll?: () => void;
|
||||
resultCount?: number;
|
||||
isPending: boolean;
|
||||
}
|
||||
|
||||
/*
|
||||
* Every filter in one place, for phones. A change applies at once, as it does
|
||||
* in the desktop toolbar, so the results behind the sheet are already the
|
||||
* filtered ones and the footer button only has to close it.
|
||||
*/
|
||||
export function FilterSheet({
|
||||
open,
|
||||
onClose,
|
||||
radius,
|
||||
onRadiusChange,
|
||||
children,
|
||||
onClearAll,
|
||||
resultCount,
|
||||
isPending,
|
||||
}: FilterSheetProps) {
|
||||
const distanceId = useId();
|
||||
|
||||
const showLabel = isPending
|
||||
? "Updating…"
|
||||
: resultCount === undefined
|
||||
? "Show schools"
|
||||
: resultCount === 0
|
||||
? "No schools match"
|
||||
: `Show ${resultCount.toLocaleString()} school${resultCount === 1 ? "" : "s"}`;
|
||||
|
||||
return (
|
||||
<Modal
|
||||
isOpen={open}
|
||||
onClose={onClose}
|
||||
title="Filters"
|
||||
size="small"
|
||||
footer={
|
||||
<div className={styles.footer}>
|
||||
{onClearAll && (
|
||||
<button
|
||||
type="button"
|
||||
className={`btn btn-tertiary ${styles.clearAll}`}
|
||||
onClick={onClearAll}
|
||||
>
|
||||
Clear all
|
||||
</button>
|
||||
)}
|
||||
<button
|
||||
type="button"
|
||||
className={`btn btn-action ${styles.show}`}
|
||||
onClick={onClose}
|
||||
>
|
||||
{showLabel}
|
||||
</button>
|
||||
</div>
|
||||
}
|
||||
>
|
||||
{/* Controls stay enabled while a change lands, so focus is never
|
||||
dropped out of the dialog; aria-busy says the results are updating. */}
|
||||
<div className={styles.body} aria-busy={isPending}>
|
||||
{radius !== null && (
|
||||
<div className={styles.field}>
|
||||
<span id={distanceId} className={styles.fieldLabel}>
|
||||
Distance
|
||||
</span>
|
||||
<div
|
||||
className={styles.segments}
|
||||
role="radiogroup"
|
||||
aria-labelledby={distanceId}
|
||||
>
|
||||
{RADIUS_OPTIONS.map((r) => (
|
||||
<label key={r} className={styles.segment}>
|
||||
<input
|
||||
type="radio"
|
||||
name={`${distanceId}-radius`}
|
||||
value={r}
|
||||
checked={r === radius}
|
||||
onChange={() => onRadiusChange(r)}
|
||||
aria-label={`Within ${radiusLabel(r)}`}
|
||||
/>
|
||||
<span>{r} mi</span>
|
||||
</label>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
{children}
|
||||
</div>
|
||||
</Modal>
|
||||
);
|
||||
}
|
||||
|
||||
/** One labelled row of the sheet. */
|
||||
export function SheetField({ label, children }: { label: string; children: ReactNode }) {
|
||||
return (
|
||||
<label className={styles.field}>
|
||||
<span className={styles.fieldLabel}>{label}</span>
|
||||
{children}
|
||||
</label>
|
||||
);
|
||||
}
|
||||
@@ -484,42 +484,84 @@
|
||||
}
|
||||
}
|
||||
|
||||
/* View Toggle */
|
||||
.viewToggle {
|
||||
/* ── Results toolbar ───────────────────────────────────────────────────────
|
||||
Search, filters and the List/Map switch in one card, pinned under the
|
||||
header. It sits above Leaflet's controls (z-index 1000), which scroll up
|
||||
beneath it, and below the comparison toast and the map's own fullscreen
|
||||
overlay. */
|
||||
.resultsToolbar {
|
||||
position: sticky;
|
||||
top: calc(64px + 0.5rem);
|
||||
z-index: 1001;
|
||||
display: flex;
|
||||
gap: 0.2rem;
|
||||
background: var(--bg-secondary);
|
||||
padding: 0.2rem;
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
.viewToggleBtn {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
padding: 0.375rem 0.625rem;
|
||||
font-size: 0.8125rem;
|
||||
font-weight: 500;
|
||||
background: transparent;
|
||||
border: none;
|
||||
border-radius: 5px;
|
||||
cursor: pointer;
|
||||
color: var(--text-secondary);
|
||||
transition: all 0.2s ease;
|
||||
}
|
||||
|
||||
.viewToggleBtn:hover {
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
.viewToggleBtn.active {
|
||||
align-items: flex-start;
|
||||
gap: 0.75rem;
|
||||
margin-bottom: 1.25rem;
|
||||
padding: 0.875rem 1rem;
|
||||
background: var(--bg-card);
|
||||
color: var(--brand-strong);
|
||||
box-shadow: 0 2px 4px rgba(var(--shadow-rgb), 0.08);
|
||||
border: 1px solid var(--border);
|
||||
border-radius: var(--radius-lg);
|
||||
box-shadow: var(--shadow-soft);
|
||||
}
|
||||
|
||||
.viewToggleBtn svg {
|
||||
.resultsToolbar > :first-child {
|
||||
flex: 1;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
/* The one filled control in the toolbar: which view you are in is the first
|
||||
thing a results page should answer. */
|
||||
.viewSwitch {
|
||||
flex-shrink: 0;
|
||||
display: flex;
|
||||
gap: 2px;
|
||||
padding: 1px;
|
||||
background: var(--bg-card);
|
||||
border: 1.5px solid var(--brand);
|
||||
border-radius: var(--radius-md);
|
||||
}
|
||||
|
||||
.viewSwitchBtn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
min-height: 2.5rem;
|
||||
padding: 0 1.125rem;
|
||||
background: transparent;
|
||||
border: 0;
|
||||
border-radius: calc(var(--radius-md) - 3px);
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 700;
|
||||
color: var(--brand-strong);
|
||||
cursor: pointer;
|
||||
transition: background-color var(--transition), color var(--transition);
|
||||
}
|
||||
|
||||
.viewSwitchBtn:hover {
|
||||
background: var(--brand-bg);
|
||||
}
|
||||
|
||||
.viewSwitchBtn[aria-pressed='true'] {
|
||||
background: var(--brand);
|
||||
color: var(--brand-on);
|
||||
}
|
||||
|
||||
/* Phones: a full-bleed band flush under the header, and the switch gives way
|
||||
to the floating button in .mobileDock. */
|
||||
@media (max-width: 640px) {
|
||||
.resultsToolbar {
|
||||
top: 56px;
|
||||
margin: -1rem -1rem 1rem;
|
||||
padding: 0.75rem 1rem;
|
||||
border-width: 0 0 1px;
|
||||
border-radius: 0;
|
||||
box-shadow: 0 2px 8px rgba(var(--shadow-rgb), 0.06);
|
||||
}
|
||||
|
||||
.viewSwitch {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
.results {
|
||||
@@ -530,136 +572,132 @@
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
/* Map View Layout */
|
||||
/* ── Map view ──────────────────────────────────────────────────────────────
|
||||
The list on the left, the map filling the rest, in one card that runs from
|
||||
under the pinned toolbar to the bottom of the screen. --toolbar-h is the
|
||||
toolbar's measured height, written by HomeView. */
|
||||
/* Where the split starts before any scrolling: header, the page's top
|
||||
padding (globals.css .main), the toolbar and its margin. */
|
||||
.homeView {
|
||||
--map-top: calc(64px + 1.25rem + var(--toolbar-h, 76px) + 1.25rem);
|
||||
--map-bottom: 1rem;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.homeView {
|
||||
--map-top: calc(64px + 1rem + var(--toolbar-h, 76px) + 1.25rem);
|
||||
}
|
||||
}
|
||||
|
||||
.mapViewContainer {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 340px;
|
||||
gap: 1rem;
|
||||
height: calc(100dvh - 280px);
|
||||
min-height: 520px;
|
||||
max-height: 800px;
|
||||
}
|
||||
|
||||
.mapContainer {
|
||||
border-radius: 10px;
|
||||
overflow: hidden;
|
||||
border: 1px solid var(--border);
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
.compactList {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.5rem;
|
||||
overflow-y: auto;
|
||||
height: 100%;
|
||||
padding-right: 0.375rem;
|
||||
}
|
||||
|
||||
.compactList::-webkit-scrollbar {
|
||||
width: 6px;
|
||||
}
|
||||
|
||||
.compactList::-webkit-scrollbar-track {
|
||||
background: var(--bg-secondary);
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.compactList::-webkit-scrollbar-thumb {
|
||||
background: var(--border);
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.compactList::-webkit-scrollbar-thumb:hover {
|
||||
background: var(--text-muted);
|
||||
}
|
||||
|
||||
/* Compact School Item */
|
||||
.compactItem {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
gap: 0.75rem;
|
||||
padding: 0.625rem 0.75rem;
|
||||
grid-template-columns: minmax(360px, 460px) minmax(0, 1fr);
|
||||
height: calc(100dvh - var(--map-top) - var(--map-bottom));
|
||||
min-height: 480px;
|
||||
background: var(--bg-card);
|
||||
border: 1px solid var(--border);
|
||||
border-radius: 8px;
|
||||
transition: all 0.2s ease;
|
||||
border-radius: var(--radius-lg);
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.compactItem:hover {
|
||||
border-color: var(--brand);
|
||||
box-shadow: 0 2px 6px rgba(var(--shadow-rgb), 0.05);
|
||||
.mapListPane {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
min-height: 0;
|
||||
background: var(--bg-primary);
|
||||
border-right: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.compactItemContent {
|
||||
/* One line: the count takes what the sort leaves, and truncates rather than
|
||||
wrap if a narrow pane cannot fit both. */
|
||||
.mapListPane .resultsHeader {
|
||||
flex-wrap: nowrap;
|
||||
gap: 0.75rem;
|
||||
padding: 0.875rem 1rem 0.75rem;
|
||||
}
|
||||
|
||||
.mapListPane .resultsHeader h2 {
|
||||
flex: 1;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.compactItemHeader {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.375rem;
|
||||
margin-bottom: 0.125rem;
|
||||
}
|
||||
|
||||
.compactItemName {
|
||||
font-weight: 600;
|
||||
font-size: 0.8125rem;
|
||||
color: var(--text-primary);
|
||||
text-decoration: none;
|
||||
font-size: var(--step-0);
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.compactItemName:hover {
|
||||
color: var(--brand-strong);
|
||||
}
|
||||
|
||||
.distanceBadge {
|
||||
.mapListPane .resultsHeaderActions {
|
||||
flex-shrink: 0;
|
||||
padding: 0.0625rem 0.375rem;
|
||||
font-size: 0.6875rem;
|
||||
font-weight: 600;
|
||||
background: var(--brand);
|
||||
color: var(--brand-on);
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.compactItemMeta {
|
||||
display: flex;
|
||||
gap: 0.375rem;
|
||||
font-size: 0.6875rem;
|
||||
color: var(--text-secondary);
|
||||
margin-bottom: 0.25rem;
|
||||
/* A select is as wide as its longest option ("Highest Reading, Writing &
|
||||
Maths %", 281px), more than half the pane. Cap it; a long choice truncates. */
|
||||
.mapListPane .sortSelect {
|
||||
max-width: 11rem;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.compactItemMeta span:not(:last-child)::after {
|
||||
content: '·';
|
||||
margin-left: 0.375rem;
|
||||
color: var(--text-muted);
|
||||
.mapContainer {
|
||||
height: 100%;
|
||||
min-height: 0;
|
||||
}
|
||||
|
||||
.compactItemStats {
|
||||
display: flex;
|
||||
gap: 0.75rem;
|
||||
font-size: 0.6875rem;
|
||||
color: var(--text-secondary);
|
||||
}
|
||||
|
||||
.compactStat strong {
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
.compactItemActions {
|
||||
.compactList {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.25rem;
|
||||
flex-shrink: 0;
|
||||
gap: 0.625rem;
|
||||
flex: 1;
|
||||
min-height: 0;
|
||||
overflow-y: auto;
|
||||
padding: 0.125rem 1rem 1rem;
|
||||
scrollbar-width: thin;
|
||||
/* The rows lay themselves out by this list's width (SchoolRow.module.css),
|
||||
which here is always narrow, whatever the screen. */
|
||||
container: results / inline-size;
|
||||
}
|
||||
|
||||
/* A row in the list beside the map: clicking it picks its pin. */
|
||||
.mapRow {
|
||||
position: relative;
|
||||
cursor: pointer;
|
||||
border-radius: 10px;
|
||||
}
|
||||
|
||||
.mapRowSelected > :last-child {
|
||||
outline: 2px solid var(--brand);
|
||||
outline-offset: 1px;
|
||||
}
|
||||
|
||||
/* Visually hidden until focused, then a pill over the row's top edge. */
|
||||
.showOnMap {
|
||||
position: absolute;
|
||||
width: 1px;
|
||||
height: 1px;
|
||||
overflow: hidden;
|
||||
clip-path: inset(50%);
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.showOnMap:focus-visible {
|
||||
top: -0.5rem;
|
||||
right: 0.75rem;
|
||||
z-index: 1;
|
||||
width: auto;
|
||||
height: auto;
|
||||
padding: 0.375rem 0.75rem;
|
||||
overflow: visible;
|
||||
clip-path: none;
|
||||
background: var(--brand);
|
||||
color: var(--brand-on);
|
||||
border: 0;
|
||||
border-radius: 999px;
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 700;
|
||||
outline: 2px solid var(--text-primary);
|
||||
outline-offset: 2px;
|
||||
}
|
||||
|
||||
|
||||
|
||||
.sectionHeader {
|
||||
margin-bottom: 1rem;
|
||||
@@ -696,6 +734,8 @@
|
||||
flex-direction: column;
|
||||
gap: 0.5rem;
|
||||
margin-bottom: 1.25rem;
|
||||
/* The rows lay themselves out by this list's width (SchoolRow.module.css). */
|
||||
container: results / inline-size;
|
||||
}
|
||||
|
||||
/* Staggered fade-in for rows */
|
||||
@@ -744,11 +784,6 @@
|
||||
justify-content: space-between;
|
||||
}
|
||||
|
||||
.viewToggle {
|
||||
justify-content: center;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
/* The sort <select> sizes to its widest option ("Highest Reading, Writing
|
||||
& Maths %"), which overflows a phone viewport — beside the view toggle it
|
||||
ran off the right edge. Let it flex into the remaining space and shrink;
|
||||
@@ -758,67 +793,43 @@
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.mapViewContainer {
|
||||
grid-template-columns: 1fr;
|
||||
grid-template-rows: 260px auto;
|
||||
height: auto;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.mapContainer {
|
||||
height: 260px;
|
||||
}
|
||||
|
||||
.compactList {
|
||||
height: auto;
|
||||
max-height: 350px;
|
||||
padding-right: 0;
|
||||
}
|
||||
|
||||
.compactItem {
|
||||
flex-direction: column;
|
||||
align-items: stretch;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.compactItemActions {
|
||||
flex-direction: row;
|
||||
}
|
||||
|
||||
.compactItemActions > * {
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
.emptyState {
|
||||
padding: 2rem 1.25rem;
|
||||
}
|
||||
}
|
||||
|
||||
/* Highlighted List Item */
|
||||
.highlightedItem .compactItem {
|
||||
border-color: var(--brand);
|
||||
box-shadow: 0 0 0 1px var(--brand);
|
||||
background: var(--bg-secondary);
|
||||
/* ── Mobile dock ───────────────────────────────────────────────────────────
|
||||
The floating List/Map button (phones only) above the selected pin's card.
|
||||
A column, so the button always clears the card instead of covering it. */
|
||||
.mobileDock {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* Mobile Bottom Sheet */
|
||||
.bottomSheetWrapper {
|
||||
.viewFab {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.bottomSheetWrapper {
|
||||
display: block;
|
||||
.mobileDock {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
gap: 0.75rem;
|
||||
position: fixed;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
width: 100%;
|
||||
z-index: 1000;
|
||||
z-index: 1002;
|
||||
padding: 1rem;
|
||||
pointer-events: none;
|
||||
}
|
||||
|
||||
.mobileDock > * {
|
||||
pointer-events: auto;
|
||||
}
|
||||
|
||||
.bottomSheet {
|
||||
align-self: stretch;
|
||||
position: relative;
|
||||
background: var(--bg-card);
|
||||
border-radius: 12px;
|
||||
@@ -827,36 +838,37 @@
|
||||
animation: slideUpSheet 0.3s cubic-bezier(0.16, 1, 0.3, 1) forwards;
|
||||
}
|
||||
|
||||
.bottomSheet .compactItem {
|
||||
border: none;
|
||||
box-shadow: none;
|
||||
background: transparent;
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.bottomSheet .compactItem:hover {
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
/* A 30px circle, drawn by ::before, inside a 44px target (MOBILE.md). */
|
||||
.closeSheetBtn {
|
||||
position: absolute;
|
||||
top: -12px;
|
||||
right: -12px;
|
||||
width: 30px;
|
||||
height: 30px;
|
||||
background: var(--bg-card);
|
||||
border: 1px solid var(--border);
|
||||
border-radius: 50%;
|
||||
top: -19px;
|
||||
right: -15px;
|
||||
width: 44px;
|
||||
height: 44px;
|
||||
padding: 0;
|
||||
background: none;
|
||||
border: 0;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
font-size: 1.25rem;
|
||||
color: var(--text-secondary);
|
||||
cursor: pointer;
|
||||
box-shadow: 0 2px 8px rgba(var(--shadow-rgb), 0.1);
|
||||
z-index: 10;
|
||||
}
|
||||
|
||||
.closeSheetBtn::before {
|
||||
content: '';
|
||||
position: absolute;
|
||||
inset: 7px;
|
||||
z-index: -1;
|
||||
background: var(--bg-card);
|
||||
border: 1px solid var(--border);
|
||||
border-radius: 50%;
|
||||
box-shadow: 0 2px 8px rgba(var(--shadow-rgb), 0.1);
|
||||
}
|
||||
|
||||
@keyframes slideUpSheet {
|
||||
from {
|
||||
transform: translateY(120%);
|
||||
@@ -866,21 +878,76 @@
|
||||
}
|
||||
}
|
||||
|
||||
/* When map view on mobile, expand map and hide list */
|
||||
/* Map only: the pane keeps its heading, the cards give way to the pins and
|
||||
the bottom sheet. */
|
||||
.mapViewContainer {
|
||||
grid-template-columns: 1fr;
|
||||
grid-template-rows: 1fr;
|
||||
height: calc(100dvh - 280px);
|
||||
min-height: 400px;
|
||||
grid-template-columns: minmax(0, 1fr);
|
||||
grid-template-rows: auto minmax(0, 1fr);
|
||||
border-radius: var(--radius-md);
|
||||
}
|
||||
|
||||
.mapContainer {
|
||||
height: 100%;
|
||||
.mapListPane {
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.mapListPane .sortSelect,
|
||||
.compactList {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* The sheet holds one results row, which is the card itself. It is not
|
||||
inside a `results` container, so give it one: a phone-width sheet takes
|
||||
the row's narrow layout. */
|
||||
.bottomSheet {
|
||||
container: results / inline-size;
|
||||
}
|
||||
|
||||
.mapListPane .resultsHeader {
|
||||
padding: 0.625rem 0.875rem;
|
||||
}
|
||||
}
|
||||
|
||||
/* Above the tab bar, and riding with it when iOS Chrome's URL bar hides
|
||||
(MOBILE.md, check 4). */
|
||||
@media (max-width: 640px) {
|
||||
.mobileDock {
|
||||
bottom: calc(56px + env(safe-area-inset-bottom, 0px));
|
||||
padding: 0.75rem;
|
||||
transform: translate3d(0, var(--mobile-bar-offset, 0px), 0);
|
||||
}
|
||||
|
||||
.viewFab {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
min-height: 3rem;
|
||||
padding: 0 1.375rem;
|
||||
background: var(--text-primary);
|
||||
color: var(--bg-primary);
|
||||
border: 0;
|
||||
border-radius: 999px;
|
||||
box-shadow: 0 8px 20px rgba(var(--shadow-rgb), 0.32);
|
||||
font-family: var(--font-ui);
|
||||
font-size: var(--step--1);
|
||||
font-weight: 700;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
/* Room under the last card so the floating button never sits on it. */
|
||||
.hasViewFab {
|
||||
padding-bottom: 4.5rem;
|
||||
}
|
||||
|
||||
/* The map runs down to the tab bar; the button floats over the map. */
|
||||
.mapViewResults.hasViewFab {
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
.homeView {
|
||||
--map-top: calc(56px + var(--toolbar-h, 124px) + 1rem);
|
||||
--map-bottom: calc(56px + env(safe-area-inset-bottom, 0px) + 1rem);
|
||||
}
|
||||
}
|
||||
|
||||
.quickSearches {
|
||||
@@ -1466,37 +1533,6 @@
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.activeFilters {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.5rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.filterChip {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.375rem;
|
||||
padding: 0.25rem 0.625rem;
|
||||
background: var(--bg-secondary);
|
||||
border: 1px solid var(--border);
|
||||
border-radius: 999px;
|
||||
font-size: 0.8rem;
|
||||
color: var(--text-secondary);
|
||||
}
|
||||
|
||||
.chipRemove {
|
||||
color: var(--text-muted);
|
||||
text-decoration: none;
|
||||
font-size: 0.9rem;
|
||||
line-height: 1;
|
||||
transition: color var(--transition, 0.2s ease);
|
||||
}
|
||||
|
||||
.chipRemove:hover {
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
.loadMoreSection {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
|
||||
+294
-238
@@ -5,7 +5,7 @@
|
||||
|
||||
'use client';
|
||||
|
||||
import React, { useState, useEffect, useRef, useCallback } from 'react';
|
||||
import React, { useState, useEffect, useRef, useCallback, useMemo } from 'react';
|
||||
import { useSearchParams, useRouter, usePathname } from 'next/navigation';
|
||||
import { FilterBar } from './FilterBar';
|
||||
import { SchoolRow } from './SchoolRow';
|
||||
@@ -16,8 +16,8 @@ import { HeroIllustration } from './Illustration';
|
||||
import { useComparisonContext } from '@/context/ComparisonContext';
|
||||
import { fetchSchools, fetchLAaverages, fetchNationalAverages } from '@/lib/api';
|
||||
import type { SchoolsResponse, Filters, School } from '@/lib/types';
|
||||
import { schoolUrl, buildOfstedListBadge } from '@/lib/utils';
|
||||
import { track } from '@/lib/analytics';
|
||||
import { DEFAULT_RADIUS_MILES } from '@/lib/utils';
|
||||
import styles from './HomeView.module.css';
|
||||
|
||||
interface HomeViewProps {
|
||||
@@ -33,6 +33,13 @@ interface HomeViewProps {
|
||||
autosuggest?: boolean;
|
||||
}
|
||||
|
||||
/*
|
||||
* The view a postcode search opens in, on every screen size. The map is on
|
||||
* trial as the default (2026-09-30); results_view_changed shows how often
|
||||
* readers switch away from it. Name searches have no map and always list.
|
||||
*/
|
||||
const DEFAULT_LOCATION_VIEW: 'list' | 'map' = 'map';
|
||||
|
||||
function daysUntil(month: number, day: number): number {
|
||||
const today = new Date();
|
||||
today.setHours(0, 0, 0, 0);
|
||||
@@ -135,6 +142,27 @@ function CalendarIcon() {
|
||||
);
|
||||
}
|
||||
|
||||
/* List / Map glyphs for the results view switch and its floating twin. */
|
||||
function ListIcon() {
|
||||
return (
|
||||
<svg {...ICON_PROPS} width={18} height={18}>
|
||||
<path d="M9 6h11M9 12h11M9 18h11" />
|
||||
<circle cx="4.5" cy="6" r="1" />
|
||||
<circle cx="4.5" cy="12" r="1" />
|
||||
<circle cx="4.5" cy="18" r="1" />
|
||||
</svg>
|
||||
);
|
||||
}
|
||||
|
||||
function MapIcon() {
|
||||
return (
|
||||
<svg {...ICON_PROPS} width={18} height={18}>
|
||||
<path d="M9 4 3 6v14l6-2 6 2 6-2V4l-6 2-6-2Z" />
|
||||
<path d="M9 4v14M15 6v14" />
|
||||
</svg>
|
||||
);
|
||||
}
|
||||
|
||||
interface ValueProp {
|
||||
icon: React.ReactNode;
|
||||
tintClass: string;
|
||||
@@ -201,7 +229,13 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
const router = useRouter();
|
||||
const pathname = usePathname();
|
||||
const { addSchool, removeSchool, selectedSchools } = useComparisonContext();
|
||||
const [resultsView, setResultsView] = useState<'list' | 'map'>('list');
|
||||
/*
|
||||
* The reader's choice, once they make one; until then the default for the
|
||||
* kind of search. Derived rather than seeded into state, because a hero
|
||||
* search reaches the results by client-side navigation: the same instance
|
||||
* gets new props, and a state seeded on the landing page would stay "list".
|
||||
*/
|
||||
const [chosenView, setChosenView] = useState<'list' | 'map' | null>(null);
|
||||
const [selectedMapSchool, setSelectedMapSchool] = useState<School | null>(null);
|
||||
const sortOrder = searchParams.get('sort') || 'default';
|
||||
const [allSchools, setAllSchools] = useState<School[]>(initialSchools.schools);
|
||||
@@ -213,6 +247,10 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
const [mapSchools, setMapSchools] = useState<School[]>([]);
|
||||
const [isLoadingMap, setIsLoadingMap] = useState(false);
|
||||
const prevSearchParamsRef = useRef(searchParams.toString());
|
||||
const toolbarRef = useRef<HTMLDivElement>(null);
|
||||
const resultsRef = useRef<HTMLElement>(null);
|
||||
const mapListRef = useRef<HTMLDivElement>(null);
|
||||
|
||||
const mapParamsRef = useRef<string>('');
|
||||
const loadMoreController = useRef<AbortController | null>(null);
|
||||
// Identity changes even for A → B → A, so an old A response stays stale.
|
||||
@@ -260,6 +298,18 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
const isSecondaryView = currentPhase.toLowerCase().includes('secondary')
|
||||
|| (!currentPhase && secondaryCount > primaryCount);
|
||||
const isMixedView = primaryCount > 0 && secondaryCount > 0 && !currentPhase;
|
||||
const resultsView: 'list' | 'map' = chosenView ?? (isLocationSearch ? DEFAULT_LOCATION_VIEW : 'list');
|
||||
|
||||
// The map view fills the screen below the pinned toolbar, whose height
|
||||
// depends on how its controls wrap. Measure it rather than guess.
|
||||
const [toolbarHeight, setToolbarHeight] = useState<number | null>(null);
|
||||
useEffect(() => {
|
||||
const el = toolbarRef.current;
|
||||
if (!el || typeof ResizeObserver === 'undefined') return;
|
||||
const observer = new ResizeObserver(() => setToolbarHeight(Math.round(el.getBoundingClientRect().height)));
|
||||
observer.observe(el);
|
||||
return () => observer.disconnect();
|
||||
}, [isSearchActive]);
|
||||
|
||||
// Reset pagination and map cache when search params change
|
||||
useEffect(() => {
|
||||
@@ -291,6 +341,7 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
setIsLoadingMap(true);
|
||||
const params: Record<string, any> = {};
|
||||
searchParams.forEach((value, key) => { params[key] = value; });
|
||||
params.radius ??= DEFAULT_RADIUS_MILES;
|
||||
params.page = 1;
|
||||
params.page_size = 500;
|
||||
fetchSchools(params, { cache: 'no-store', signal: controller.signal })
|
||||
@@ -370,7 +421,7 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
setGeoState('idle');
|
||||
track('near_me_used', { outcome: 'granted' });
|
||||
track('search_submitted', { query: postcode, via: 'near_me', has_postcode: true, filters_active: '', filters_count: 0 });
|
||||
router.push(`/?postcode=${encodeURIComponent(postcode)}&radius=1`);
|
||||
router.push(`/?postcode=${encodeURIComponent(postcode)}&radius=${DEFAULT_RADIUS_MILES}`);
|
||||
} else {
|
||||
track('near_me_used', { outcome: 'no_postcode' });
|
||||
setGeoState('error');
|
||||
@@ -396,7 +447,7 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
);
|
||||
}, [router]);
|
||||
|
||||
const sortedSchools = [...allSchools].sort((a, b) => {
|
||||
const sortSchools = (list: School[]) => [...list].sort((a, b) => {
|
||||
if (sortOrder === 'rwm_desc') return (b.rwm_expected_pct ?? -Infinity) - (a.rwm_expected_pct ?? -Infinity);
|
||||
if (sortOrder === 'rwm_asc') return (a.rwm_expected_pct ?? Infinity) - (b.rwm_expected_pct ?? Infinity);
|
||||
if (sortOrder === 'att8_desc') return (b.attainment_8_score ?? -Infinity) - (a.attainment_8_score ?? -Infinity);
|
||||
@@ -405,6 +456,15 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
if (sortOrder === 'name_asc') return a.school_name.localeCompare(b.school_name);
|
||||
return 0;
|
||||
});
|
||||
const sortedSchools = sortSchools(allSchools);
|
||||
// The map gets a stable array (a new one rebuilds every pin and closes the
|
||||
// open card); only the list beside it is sorted.
|
||||
const mapResultSchools = mapSchools.length > 0 ? mapSchools : initialSchools.schools;
|
||||
const mapListSchools = sortSchools(mapResultSchools);
|
||||
// Two places, so a 0.25-mile search is not drawn or labelled as 0.3.
|
||||
const radiusMiles = initialSchools.location_info
|
||||
? Number((initialSchools.location_info.radius / 1.60934).toFixed(2))
|
||||
: undefined;
|
||||
|
||||
// Empty-results sentinel: track when a search returns nothing.
|
||||
useEffect(() => {
|
||||
@@ -449,11 +509,133 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
});
|
||||
}, [addSchool, selectedSchools.length]);
|
||||
|
||||
const hasViewSwitch = isLocationSearch && initialSchools.schools.length > 0;
|
||||
const compareUrns = useMemo(() => selectedSchools.map(s => s.urn), [selectedSchools]);
|
||||
|
||||
/*
|
||||
* Below 769px the map view hides its list pane (HomeView.module.css), and
|
||||
* with the map now the default on phones, every postcode search there
|
||||
* would otherwise build up to 500 hidden cards. Decided after mount, so
|
||||
* the server's HTML and the first client render still agree.
|
||||
*/
|
||||
const [listPaneShown, setListPaneShown] = useState(true);
|
||||
useEffect(() => {
|
||||
if (typeof window.matchMedia !== 'function') return;
|
||||
const query = window.matchMedia('(min-width: 769px)');
|
||||
const update = () => setListPaneShown(query.matches);
|
||||
update();
|
||||
query.addEventListener('change', update);
|
||||
return () => query.removeEventListener('change', update);
|
||||
}, []);
|
||||
const clearMapSelection = useCallback(() => setSelectedMapSchool(null), []);
|
||||
|
||||
// A pin chosen on the map brings its card into view in the list beside it.
|
||||
useEffect(() => {
|
||||
if (!selectedMapSchool) return;
|
||||
const card = mapListRef.current?.querySelector<HTMLElement>(`[data-urn="${selectedMapSchool.urn}"]`);
|
||||
if (card?.offsetParent) card.scrollIntoView({ block: 'nearest', behavior: 'smooth' });
|
||||
}, [selectedMapSchool]);
|
||||
|
||||
/*
|
||||
* Switching view from far down the list would otherwise leave the reader
|
||||
* looking at whatever now sits at that scroll offset, usually the footer,
|
||||
* because the map layout is much shorter than a long list. Bring the top of
|
||||
* the results back to just under the pinned toolbar instead.
|
||||
*/
|
||||
const changeView = (view: 'list' | 'map', via: 'toolbar' | 'floating') => {
|
||||
if (view === resultsView) return;
|
||||
setChosenView(view);
|
||||
track('results_view_changed', { view, via });
|
||||
requestAnimationFrame(() => {
|
||||
const results = resultsRef.current;
|
||||
const toolbar = toolbarRef.current;
|
||||
if (!results || !toolbar) return;
|
||||
const toolbarBottom = toolbar.getBoundingClientRect().bottom;
|
||||
const resultsTop = results.getBoundingClientRect().top;
|
||||
if (resultsTop < toolbarBottom) {
|
||||
window.scrollTo({ top: window.scrollY + resultsTop - toolbarBottom - 12 });
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
const isMapView = initialSchools.schools.length > 0 && resultsView === 'map' && isLocationSearch;
|
||||
|
||||
// One school as a results row: the list view, the list beside the map and
|
||||
// the phone's bottom sheet all draw the same thing.
|
||||
const renderRow = (school: School) => (
|
||||
school.attainment_8_score != null ? (
|
||||
<SecondarySchoolRow
|
||||
key={school.urn}
|
||||
school={school}
|
||||
isLocationSearch={isLocationSearch}
|
||||
onAddToCompare={addSchoolFromSearch}
|
||||
onRemoveFromCompare={removeSchool}
|
||||
isInCompare={compareUrns.includes(school.urn)}
|
||||
laAvgAttainment8={school.local_authority ? laAverages[school.local_authority] ?? null : null}
|
||||
/>
|
||||
) : (
|
||||
<SchoolRow
|
||||
key={school.urn}
|
||||
school={school}
|
||||
isLocationSearch={isLocationSearch}
|
||||
onAddToCompare={addSchoolFromSearch}
|
||||
onRemoveFromCompare={removeSchool}
|
||||
isInCompare={compareUrns.includes(school.urn)}
|
||||
nationalAvgRwm={nationalAvgRwm}
|
||||
/>
|
||||
)
|
||||
);
|
||||
|
||||
const schoolCount = `${initialSchools.total.toLocaleString()} school${initialSchools.total !== 1 ? 's' : ''}`;
|
||||
|
||||
// The count and the sort. Above the list in list view; at the top of the
|
||||
// list pane, beside the map, in map view.
|
||||
const resultsHeader = (
|
||||
<div className={styles.resultsHeader}>
|
||||
<h2 aria-live="polite" aria-atomic="true">
|
||||
{/* Beside the map the heading shares one line with the sort, so it
|
||||
drops the postcode, which the search box just above already shows. */}
|
||||
{isMapView && radiusMiles != null
|
||||
? `${schoolCount} within ${radiusMiles} mile${radiusMiles === 1 ? '' : 's'}`
|
||||
: isLocationSearch && radiusMiles != null && initialSchools.location_info
|
||||
? `${schoolCount} within ${radiusMiles} mile${radiusMiles === 1 ? '' : 's'} of ${initialSchools.location_info.postcode}`
|
||||
: `${schoolCount} found`
|
||||
}
|
||||
</h2>
|
||||
<div className={styles.resultsHeaderActions}>
|
||||
<select
|
||||
value={sortOrder}
|
||||
onChange={e => {
|
||||
const params = new URLSearchParams(searchParams);
|
||||
if (e.target.value === 'default') {
|
||||
params.delete('sort');
|
||||
} else {
|
||||
params.set('sort', e.target.value);
|
||||
}
|
||||
router.push(`${pathname}?${params.toString()}`);
|
||||
}}
|
||||
className={styles.sortSelect}
|
||||
>
|
||||
<option value="default">Sort: Relevance</option>
|
||||
{(!isSecondaryView || isMixedView) && <option value="rwm_desc">Highest Reading, Writing & Maths %</option>}
|
||||
{(!isSecondaryView || isMixedView) && <option value="rwm_asc">Lowest Reading, Writing & Maths %</option>}
|
||||
{(isSecondaryView || isMixedView) && <option value="att8_desc">Highest Attainment 8</option>}
|
||||
{(isSecondaryView || isMixedView) && <option value="att8_asc">Lowest Attainment 8</option>}
|
||||
{isLocationSearch && <option value="distance">Nearest first</option>}
|
||||
<option value="name_asc">Name A–Z</option>
|
||||
</select>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
|
||||
return (
|
||||
/* The landing arrangement owns its own vertical rhythm (one gap, set in
|
||||
CSS); the search arrangement is a filter bar directly above its results
|
||||
and wants none of it. */
|
||||
<div className={isSearchActive ? styles.homeView : `${styles.homeView} ${styles.landing}`}>
|
||||
<div
|
||||
className={isSearchActive ? styles.homeView : `${styles.homeView} ${styles.landing}`}
|
||||
style={toolbarHeight ? { '--toolbar-h': `${toolbarHeight}px` } as React.CSSProperties : undefined}
|
||||
>
|
||||
{/* Hero: a Sand panel with the proposition and the search on the left and
|
||||
the brand landscape bleeding to the panel edge on the right. The
|
||||
search lives inside the panel here and above the results elsewhere,
|
||||
@@ -523,15 +705,42 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
</ul>
|
||||
</div>
|
||||
) : (
|
||||
<FilterBar
|
||||
filters={filters}
|
||||
isHero={false}
|
||||
resultFilters={initialSchools.result_filters}
|
||||
onNearMe={handleNearMe}
|
||||
geoState={geoState}
|
||||
geoError={geoError}
|
||||
autosuggest={autosuggest}
|
||||
/>
|
||||
/* Pinned under the header, so the search, the filters and the List/Map
|
||||
switch stay in reach however far down the results a reader is. */
|
||||
<div ref={toolbarRef} className={styles.resultsToolbar}>
|
||||
<FilterBar
|
||||
filters={filters}
|
||||
isHero={false}
|
||||
resultFilters={initialSchools.result_filters}
|
||||
resultCount={initialSchools.total}
|
||||
onNearMe={handleNearMe}
|
||||
geoState={geoState}
|
||||
geoError={geoError}
|
||||
autosuggest={autosuggest}
|
||||
viewSwitch={hasViewSwitch && (
|
||||
<div className={styles.viewSwitch} role="group" aria-label="Results view">
|
||||
<button
|
||||
type="button"
|
||||
className={styles.viewSwitchBtn}
|
||||
aria-pressed={resultsView === 'list'}
|
||||
onClick={() => changeView('list', 'toolbar')}
|
||||
>
|
||||
<ListIcon />
|
||||
List
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
className={styles.viewSwitchBtn}
|
||||
aria-pressed={resultsView === 'map'}
|
||||
onClick={() => changeView('map', 'toolbar')}
|
||||
>
|
||||
<MapIcon />
|
||||
Map
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{/* Next admissions deadline — one bar, not four cards. */}
|
||||
@@ -583,7 +792,10 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
nothing to list — an empty <section> is still a flex child, so it was
|
||||
contributing a full section gap of blank space above the footer. */}
|
||||
{(isSearchActive || initialSchools.schools.length > 0) && (
|
||||
<section className={`${styles.results} ${resultsView === 'map' && isLocationSearch ? styles.mapViewResults : ''}`}>
|
||||
<section
|
||||
ref={resultsRef}
|
||||
className={`${styles.results} ${resultsView === 'map' && isLocationSearch ? styles.mapViewResults : ''} ${hasViewSwitch ? styles.hasViewFab : ''}`}
|
||||
>
|
||||
{!hasSearch && initialSchools.schools.length > 0 && (
|
||||
<div className={styles.sectionHeader}>
|
||||
<h2>Featured Schools</h2>
|
||||
@@ -593,77 +805,7 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
</div>
|
||||
)}
|
||||
|
||||
{hasSearch && (
|
||||
<div className={styles.resultsHeader}>
|
||||
<h2 aria-live="polite" aria-atomic="true">
|
||||
{isLocationSearch && initialSchools.location_info
|
||||
? `${initialSchools.total.toLocaleString()} school${initialSchools.total !== 1 ? 's' : ''} within ${(initialSchools.location_info.radius / 1.60934).toFixed(1)} miles of ${initialSchools.location_info.postcode}`
|
||||
: `${initialSchools.total.toLocaleString()} school${initialSchools.total !== 1 ? 's' : ''} found`
|
||||
}
|
||||
</h2>
|
||||
<div className={styles.resultsHeaderActions}>
|
||||
{isLocationSearch && initialSchools.schools.length > 0 && (
|
||||
<div className={styles.viewToggle}>
|
||||
<button
|
||||
className={`${styles.viewToggleBtn} ${resultsView === 'list' ? styles.active : ''}`}
|
||||
onClick={() => setResultsView('list')}
|
||||
>
|
||||
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" width="16" height="16">
|
||||
<line x1="8" y1="6" x2="21" y2="6"/>
|
||||
<line x1="8" y1="12" x2="21" y2="12"/>
|
||||
<line x1="8" y1="18" x2="21" y2="18"/>
|
||||
<line x1="3" y1="6" x2="3.01" y2="6"/>
|
||||
<line x1="3" y1="12" x2="3.01" y2="12"/>
|
||||
<line x1="3" y1="18" x2="3.01" y2="18"/>
|
||||
</svg>
|
||||
List
|
||||
</button>
|
||||
<button
|
||||
className={`${styles.viewToggleBtn} ${resultsView === 'map' ? styles.active : ''}`}
|
||||
onClick={() => setResultsView('map')}
|
||||
>
|
||||
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" width="16" height="16">
|
||||
<path d="M21 10c0 7-9 13-9 13s-9-6-9-13a9 9 0 0 1 18 0z"/>
|
||||
<circle cx="12" cy="10" r="3"/>
|
||||
</svg>
|
||||
Map
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
{resultsView === 'list' && (
|
||||
<select
|
||||
value={sortOrder}
|
||||
onChange={e => {
|
||||
const params = new URLSearchParams(searchParams);
|
||||
if (e.target.value === 'default') {
|
||||
params.delete('sort');
|
||||
} else {
|
||||
params.set('sort', e.target.value);
|
||||
}
|
||||
router.push(`${pathname}?${params.toString()}`);
|
||||
}}
|
||||
className={styles.sortSelect}
|
||||
>
|
||||
<option value="default">Sort: Relevance</option>
|
||||
{(!isSecondaryView || isMixedView) && <option value="rwm_desc">Highest Reading, Writing & Maths %</option>}
|
||||
{(!isSecondaryView || isMixedView) && <option value="rwm_asc">Lowest Reading, Writing & Maths %</option>}
|
||||
{(isSecondaryView || isMixedView) && <option value="att8_desc">Highest Attainment 8</option>}
|
||||
{(isSecondaryView || isMixedView) && <option value="att8_asc">Lowest Attainment 8</option>}
|
||||
{isLocationSearch && <option value="distance">Nearest first</option>}
|
||||
<option value="name_asc">Name A–Z</option>
|
||||
</select>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{isSearchActive && (
|
||||
<div className={styles.activeFilters}>
|
||||
{searchParams.get('search') && <span className={styles.filterChip}>Search: {searchParams.get('search')}<a href="/" className={styles.chipRemove} onClick={e => { e.preventDefault(); }}>×</a></span>}
|
||||
{searchParams.get('local_authority') && <span className={styles.filterChip}>{searchParams.get('local_authority')}</span>}
|
||||
{searchParams.get('school_type') && <span className={styles.filterChip}>{searchParams.get('school_type')}</span>}
|
||||
</div>
|
||||
)}
|
||||
{hasSearch && !isMapView && resultsHeader}
|
||||
|
||||
{initialSchools.schools.length === 0 && isSearchActive ? (
|
||||
<EmptyState
|
||||
@@ -676,77 +818,62 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
},
|
||||
}}
|
||||
/>
|
||||
) : initialSchools.schools.length > 0 && resultsView === 'map' && isLocationSearch ? (
|
||||
/* Map View Layout */
|
||||
) : isMapView ? (
|
||||
/* Map View Layout: the list beside the map, as one card. */
|
||||
<div className={styles.mapViewContainer}>
|
||||
<div className={styles.mapListPane}>
|
||||
{resultsHeader}
|
||||
<div ref={mapListRef} className={styles.compactList}>
|
||||
{/* The list view's own rows, so both views show the same thing.
|
||||
Clicking a row (not its links or buttons) picks its pin. */}
|
||||
{listPaneShown && mapListSchools.map((school) => (
|
||||
<div
|
||||
key={school.urn}
|
||||
data-urn={school.urn}
|
||||
className={`${styles.mapRow} ${selectedMapSchool?.urn === school.urn ? styles.mapRowSelected : ''}`}
|
||||
onClick={(e) => {
|
||||
if ((e.target as HTMLElement).closest('a, button')) return;
|
||||
setSelectedMapSchool(school);
|
||||
}}
|
||||
>
|
||||
{/* The keyboard's way to pick the pin: hidden until it has
|
||||
focus, since a pointer just clicks the row. The row
|
||||
itself cannot be the button, as it holds links and
|
||||
buttons of its own. */}
|
||||
<button
|
||||
type="button"
|
||||
className={styles.showOnMap}
|
||||
aria-pressed={selectedMapSchool?.urn === school.urn}
|
||||
onClick={() => setSelectedMapSchool(school)}
|
||||
>
|
||||
Show {school.school_name} on the map
|
||||
</button>
|
||||
{renderRow(school)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
<div className={styles.mapContainer}>
|
||||
<SchoolMap
|
||||
schools={isLoadingMap ? initialSchools.schools : mapSchools}
|
||||
schools={mapResultSchools}
|
||||
center={initialSchools.location_info?.coordinates}
|
||||
referencePoint={initialSchools.location_info?.coordinates}
|
||||
radiusMiles={radiusMiles}
|
||||
selectedUrn={selectedMapSchool?.urn ?? null}
|
||||
onMarkerClick={setSelectedMapSchool}
|
||||
onDeselect={clearMapSelection}
|
||||
onAddToCompare={addSchoolFromSearch}
|
||||
compareUrns={compareUrns}
|
||||
nationalAvgRwm={nationalAvgRwm}
|
||||
laAverages={laAverages}
|
||||
/>
|
||||
</div>
|
||||
<div className={styles.compactList}>
|
||||
{(isLoadingMap ? initialSchools.schools : mapSchools).map((school) => (
|
||||
<div
|
||||
key={school.urn}
|
||||
className={`${styles.listItemWrapper} ${selectedMapSchool?.urn === school.urn ? styles.highlightedItem : ''}`}
|
||||
>
|
||||
<CompactSchoolItem
|
||||
school={school}
|
||||
onAddToCompare={addSchoolFromSearch}
|
||||
isInCompare={selectedSchools.some(s => s.urn === school.urn)}
|
||||
nationalAvgRwm={nationalAvgRwm}
|
||||
/>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
|
||||
{/* Mobile Bottom Sheet for Selected Map Pin */}
|
||||
{selectedMapSchool && (
|
||||
<div className={styles.bottomSheetWrapper}>
|
||||
<div className={styles.bottomSheet}>
|
||||
<button className={styles.closeSheetBtn} onClick={() => setSelectedMapSchool(null)}>×</button>
|
||||
<CompactSchoolItem
|
||||
school={selectedMapSchool}
|
||||
onAddToCompare={addSchoolFromSearch}
|
||||
isInCompare={selectedSchools.some(s => s.urn === selectedMapSchool.urn)}
|
||||
nationalAvgRwm={nationalAvgRwm}
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
) : (
|
||||
/* List View Layout */
|
||||
<>
|
||||
<div className={styles.schoolList}>
|
||||
{sortedSchools.map((school) => (
|
||||
school.attainment_8_score != null ? (
|
||||
<SecondarySchoolRow
|
||||
key={school.urn}
|
||||
school={school}
|
||||
isLocationSearch={isLocationSearch}
|
||||
onAddToCompare={addSchoolFromSearch}
|
||||
onRemoveFromCompare={removeSchool}
|
||||
isInCompare={selectedSchools.some(s => s.urn === school.urn)}
|
||||
laAvgAttainment8={school.local_authority ? laAverages[school.local_authority] ?? null : null}
|
||||
/>
|
||||
) : (
|
||||
<SchoolRow
|
||||
key={school.urn}
|
||||
school={school}
|
||||
isLocationSearch={isLocationSearch}
|
||||
onAddToCompare={addSchoolFromSearch}
|
||||
onRemoveFromCompare={removeSchool}
|
||||
isInCompare={selectedSchools.some(s => s.urn === school.urn)}
|
||||
nationalAvgRwm={nationalAvgRwm}
|
||||
/>
|
||||
)
|
||||
))}
|
||||
{sortedSchools.map(renderRow)}
|
||||
</div>
|
||||
|
||||
{(hasMore || allSchools.length < initialSchools.total) && (
|
||||
@@ -769,105 +896,34 @@ export function HomeView({ initialSchools, filters, totalSchools, howItWorks, ed
|
||||
)}
|
||||
</section>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
/* Compact School Item for Map View */
|
||||
interface CompactSchoolItemProps {
|
||||
school: School;
|
||||
onAddToCompare: (school: School) => void;
|
||||
isInCompare: boolean;
|
||||
nationalAvgRwm?: number | null;
|
||||
}
|
||||
|
||||
function CompactSchoolItem({ school, onAddToCompare, isInCompare, nationalAvgRwm }: CompactSchoolItemProps) {
|
||||
const ofstedBadge = buildOfstedListBadge(school);
|
||||
const isSecondary = school.attainment_8_score != null;
|
||||
|
||||
// vs-national delta for primary schools
|
||||
const rwmDelta =
|
||||
!isSecondary && school.rwm_expected_pct != null && nationalAvgRwm != null
|
||||
? Math.round(school.rwm_expected_pct - nationalAvgRwm)
|
||||
: null;
|
||||
|
||||
const deltaStyle: React.CSSProperties =
|
||||
rwmDelta == null
|
||||
? {}
|
||||
: rwmDelta >= 2
|
||||
? { fontSize: '0.7rem', color: 'var(--status-above)', fontWeight: 600 }
|
||||
: rwmDelta <= -2
|
||||
? { fontSize: '0.7rem', color: 'var(--brand)', fontWeight: 600 }
|
||||
: { fontSize: '0.7rem', color: 'var(--text-muted)' };
|
||||
|
||||
return (
|
||||
<div className={styles.compactItem}>
|
||||
<div className={styles.compactItemContent}>
|
||||
<div className={styles.compactItemHeader}>
|
||||
<a href={schoolUrl(school.urn, school.school_name)} className={styles.compactItemName}>
|
||||
{school.school_name}
|
||||
</a>
|
||||
{school.distance !== undefined && school.distance !== null && (
|
||||
<span className={styles.distanceBadge}>
|
||||
{school.distance.toFixed(1)} mi
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
{/* Ofsted badge */}
|
||||
<div style={{ marginBottom: '0.25rem' }}>
|
||||
<span
|
||||
style={{
|
||||
display: 'inline-block',
|
||||
padding: '0.0625rem 0.375rem',
|
||||
fontSize: '0.625rem',
|
||||
fontWeight: 600,
|
||||
borderRadius: '3px',
|
||||
whiteSpace: 'nowrap',
|
||||
...(ofstedBadge.cssClass === 'ofsted1' ? { background: 'var(--status-above-bg)', color: 'var(--status-above)' } :
|
||||
ofstedBadge.cssClass === 'ofsted2' ? { background: 'var(--status-above-bg)', color: 'var(--status-above)' } :
|
||||
ofstedBadge.cssClass === 'ofsted3' ? { background: 'var(--status-below-bg)', color: 'var(--status-below)' } :
|
||||
ofstedBadge.cssClass === 'ofsted4' ? { background: 'var(--status-below)', color: 'var(--text-inverse)' } :
|
||||
ofstedBadge.cssClass === 'ofstedRc' ? { background: 'var(--phase-secondary-text)', color: 'var(--text-inverse)' } :
|
||||
ofstedBadge.cssClass === 'ofstedPending' ? { background: 'var(--bg-secondary)', color: 'var(--text-muted)' } :
|
||||
{ background: 'var(--bg-secondary)', color: 'var(--text-muted)' }),
|
||||
}}
|
||||
{/* Phones and small tablets: the selected pin's card, and on phones the
|
||||
floating List/Map button, stacked above the bottom tab bar. The
|
||||
toolbar's switch is hidden at phone width, where this replaces it. */}
|
||||
{hasViewSwitch && (
|
||||
<div className={styles.mobileDock}>
|
||||
<button
|
||||
type="button"
|
||||
className={styles.viewFab}
|
||||
aria-label={resultsView === 'list' ? 'Show map' : 'Show list'}
|
||||
onClick={() => changeView(resultsView === 'list' ? 'map' : 'list', 'floating')}
|
||||
>
|
||||
{ofstedBadge.label}
|
||||
</span>
|
||||
</div>
|
||||
{/* Headline metric + delta */}
|
||||
<div className={styles.compactItemStats}>
|
||||
<span className={styles.compactStat}>
|
||||
<strong>
|
||||
{isSecondary
|
||||
? (school.attainment_8_score != null ? school.attainment_8_score.toFixed(1) : '-')
|
||||
: (school.rwm_expected_pct != null ? `${school.rwm_expected_pct}%` : '-')}
|
||||
</strong>
|
||||
{' '}
|
||||
{isSecondary ? 'Att 8' : 'RWM'}
|
||||
</span>
|
||||
{rwmDelta != null && (
|
||||
<span style={deltaStyle}>
|
||||
{rwmDelta >= 2
|
||||
? `+${rwmDelta} pts vs national`
|
||||
: rwmDelta <= -2
|
||||
? `${rwmDelta} pts vs national`
|
||||
: '≈ national avg'}
|
||||
</span>
|
||||
{resultsView === 'list' ? <><MapIcon />Map</> : <><ListIcon />List</>}
|
||||
</button>
|
||||
{resultsView === 'map' && selectedMapSchool && (
|
||||
<div className={styles.bottomSheet}>
|
||||
<button
|
||||
className={styles.closeSheetBtn}
|
||||
onClick={() => setSelectedMapSchool(null)}
|
||||
aria-label="Close"
|
||||
>
|
||||
×
|
||||
</button>
|
||||
{renderRow(selectedMapSchool)}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
<div className={styles.compactItemActions}>
|
||||
<button
|
||||
className={isInCompare ? 'btn btn-active btn-sm' : 'btn btn-secondary btn-sm'}
|
||||
onClick={() => onAddToCompare(school)}
|
||||
>
|
||||
{isInCompare ? '✓ Comparing' : '+ Compare'}
|
||||
</button>
|
||||
<a href={schoolUrl(school.urn, school.school_name)} className="btn btn-tertiary btn-sm">
|
||||
View
|
||||
</a>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -5,213 +5,283 @@
|
||||
|
||||
'use client';
|
||||
|
||||
import { useEffect, useRef } from 'react';
|
||||
import { useEffect, useRef, useState } from 'react';
|
||||
import L from 'leaflet';
|
||||
import 'leaflet/dist/leaflet.css';
|
||||
import type { School } from '@/lib/types';
|
||||
import { schoolUrl } from '@/lib/utils';
|
||||
|
||||
// Fix for default marker icons in Next.js
|
||||
delete (L.Icon.Default.prototype as any)._getIconUrl;
|
||||
L.Icon.Default.mergeOptions({
|
||||
iconRetinaUrl: 'https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.7.1/images/marker-icon-2x.png',
|
||||
iconUrl: 'https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.7.1/images/marker-icon.png',
|
||||
shadowUrl: 'https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.7.1/images/marker-shadow.png',
|
||||
});
|
||||
import { schoolUrl, isSpecialSchool, buildOfstedListBadge, listRwmValue } from '@/lib/utils';
|
||||
|
||||
interface LeafletMapInnerProps {
|
||||
schools: School[];
|
||||
center: [number, number];
|
||||
zoom: number;
|
||||
referencePoint?: [number, number];
|
||||
/** Search radius in miles. Drawn as a dashed circle the view fits to. */
|
||||
radiusMiles?: number;
|
||||
/** The school whose pin is highlighted and, on wide screens, whose card is open. */
|
||||
selectedUrn?: number | null;
|
||||
onMarkerClick?: (school: School) => void;
|
||||
/** The open card was closed from the map itself (its × or a click elsewhere). */
|
||||
onDeselect?: () => void;
|
||||
onAddToCompare?: (school: School) => void;
|
||||
compareUrns?: number[];
|
||||
nationalAvgRwm?: number | null;
|
||||
laAverages?: Record<string, number | null>;
|
||||
}
|
||||
|
||||
const METRES_PER_MILE = 1609.344;
|
||||
|
||||
/*
|
||||
* Wide screens show the selected school as a card on the map. Narrow ones do
|
||||
* not: HomeView shows the same card as a bottom sheet there, and a popup on a
|
||||
* 390px map would cover most of it.
|
||||
*/
|
||||
const CARD_ON_MAP_QUERY = '(min-width: 769px)';
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Popup helpers (must work in plain JS string templates — no React / CSS Modules)
|
||||
// Card helpers (must work in plain JS string templates — no React / CSS Modules)
|
||||
// Class names are global and styled in SchoolMap.module.css.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function escapeHtml(s: string): string {
|
||||
return s.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"');
|
||||
}
|
||||
|
||||
interface PopupBadge {
|
||||
label: string;
|
||||
style: string;
|
||||
function pinIcon(selected: boolean): L.DivIcon {
|
||||
const size = selected ? 32 : 22;
|
||||
return L.divIcon({
|
||||
className: selected ? 'sc-pin sc-pin--selected' : 'sc-pin',
|
||||
html: '',
|
||||
iconSize: [size, size],
|
||||
iconAnchor: [size / 2, size / 2],
|
||||
});
|
||||
}
|
||||
|
||||
function buildPopupBadge(school: School): PopupBadge {
|
||||
// A report card wins over any carried-forward legacy grade — its presence is
|
||||
// signalled by ofsted_rc_date (the list has no full report_card object, and
|
||||
// ofsted_framework is the raw event grouping, never "ReportCard").
|
||||
if (school.ofsted_rc_date) {
|
||||
const rcYear = new Date(school.ofsted_rc_date).getFullYear();
|
||||
return { label: `Report Card · ${rcYear}`, style: 'background:var(--phase-secondary-text);color:var(--text-inverse)' };
|
||||
}
|
||||
const year = school.ofsted_date ? new Date(school.ofsted_date).getFullYear() : null;
|
||||
const yearStr = year ? ` · ${year}` : '';
|
||||
if (school.ofsted_grade) {
|
||||
const labels: Record<number, string> = { 1: 'Outstanding', 2: 'Good', 3: 'Req. Improvement', 4: 'Inadequate' };
|
||||
const colours: Record<number, string> = {
|
||||
1: 'background:var(--status-above-bg);color:var(--status-above)',
|
||||
2: 'background:var(--status-above-bg);color:var(--status-above)',
|
||||
3: 'background:var(--status-below-bg);color:var(--status-below)',
|
||||
4: 'background:var(--status-below);color:var(--text-inverse)',
|
||||
};
|
||||
return { label: `${labels[school.ofsted_grade]}${yearStr}`, style: colours[school.ofsted_grade] };
|
||||
}
|
||||
return { label: 'Not yet inspected', style: 'background:var(--bg-secondary);color:var(--text-muted)' };
|
||||
interface CardContext {
|
||||
inCompare: boolean;
|
||||
nationalAvgRwm?: number | null;
|
||||
laAverages?: Record<string, number | null>;
|
||||
}
|
||||
|
||||
export default function LeafletMapInner({ schools, center, zoom, referencePoint, onMarkerClick, nationalAvgRwm, laAverages }: LeafletMapInnerProps) {
|
||||
/** The headline figure and its comparison, the same rule as the list rows. */
|
||||
function metricHtml(school: School, { nationalAvgRwm, laAverages }: CardContext): string {
|
||||
const special = isSpecialSchool(school);
|
||||
if (school.attainment_8_score != null) {
|
||||
const score = school.attainment_8_score;
|
||||
const laAvg = school.local_authority ? (laAverages?.[school.local_authority] ?? null) : null;
|
||||
let delta = '';
|
||||
if (!special && laAvg != null) {
|
||||
const diff = Math.round((score - laAvg) * 10) / 10;
|
||||
// Att8 runs 0–90 in 0.1 steps; ±0.5 is meaningful, where RWM needs ±2.
|
||||
const cls = diff >= 0.5 ? 'sc-up' : diff <= -0.5 ? 'sc-down' : '';
|
||||
delta = ` <span class="${cls}">${diff >= 0 ? '+' : ''}${diff} vs LA</span>`;
|
||||
}
|
||||
return `<strong>${score.toFixed(1)}</strong> Att 8${delta}`;
|
||||
}
|
||||
const rwm = listRwmValue(school);
|
||||
if (rwm != null) {
|
||||
let delta = '';
|
||||
if (!special && nationalAvgRwm != null) {
|
||||
const diff = Math.round(rwm - nationalAvgRwm);
|
||||
const cls = diff >= 2 ? 'sc-up' : diff <= -2 ? 'sc-down' : '';
|
||||
const text = diff >= 2 ? `+${diff} pts` : diff <= -2 ? `${diff} pts` : '≈ national';
|
||||
delta = ` <span class="${cls}">${text}</span>`;
|
||||
}
|
||||
return `<strong>${rwm}%</strong> RWM${delta}`;
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
function cardHtml(school: School, ctx: CardContext): string {
|
||||
const badge = buildOfstedListBadge(school);
|
||||
const href = schoolUrl(school.urn, school.school_name);
|
||||
const distance = school.distance != null
|
||||
? `<span class="sc-dist">${school.distance.toFixed(1)} mi</span>` : '';
|
||||
const type = school.school_type
|
||||
? `<span class="sc-tag">${escapeHtml(school.school_type)}</span>` : '';
|
||||
const metric = metricHtml(school, ctx);
|
||||
const pupils = school.total_pupils != null
|
||||
? `${metric ? ' · ' : ''}${school.total_pupils.toLocaleString('en-GB')} pupils` : '';
|
||||
return `<div class="sc-card">
|
||||
<div class="sc-card-head"><a class="sc-card-name" href="${href}">${escapeHtml(school.school_name)}</a>${distance}</div>
|
||||
<div class="sc-card-tags"><span class="sc-ofsted sc-${badge.cssClass}">${escapeHtml(badge.label)}</span>${type}</div>
|
||||
${metric || pupils ? `<div class="sc-card-metric">${metric}${pupils}</div>` : ''}
|
||||
<div class="sc-card-actions">
|
||||
<a class="btn btn-tertiary btn-sm" href="${href}">View</a>
|
||||
<button type="button" class="btn ${ctx.inCompare ? 'btn-active' : 'btn-secondary'} btn-sm" data-compare>${ctx.inCompare ? '✓ Comparing' : '+ Compare'}</button>
|
||||
</div>
|
||||
</div>`;
|
||||
}
|
||||
|
||||
export default function LeafletMapInner({
|
||||
schools, center, zoom, referencePoint, radiusMiles, selectedUrn,
|
||||
onMarkerClick, onDeselect, onAddToCompare, compareUrns,
|
||||
nationalAvgRwm, laAverages,
|
||||
}: LeafletMapInnerProps) {
|
||||
const mapRef = useRef<L.Map | null>(null);
|
||||
const mapContainerRef = useRef<HTMLDivElement>(null);
|
||||
const refMarkerRef = useRef<L.Marker | null>(null);
|
||||
const markersRef = useRef<Map<number, L.Marker>>(new Map());
|
||||
const overlayRef = useRef<L.LayerGroup | null>(null);
|
||||
const popupRef = useRef<L.Popup | null>(null);
|
||||
const selectedRef = useRef<number | null>(null);
|
||||
// Bumped whenever the pins are rebuilt, for any reason, so the selection
|
||||
// effect puts the card back on the new pin rather than only when the
|
||||
// selection or the school list changes.
|
||||
const [pinsVersion, setPinsVersion] = useState(0);
|
||||
|
||||
// The popup is plain HTML outside React, so its handlers read the latest
|
||||
// props through a ref rather than closing over the render they were made in.
|
||||
const latest = useRef({ onMarkerClick, onDeselect, onAddToCompare, compareUrns, nationalAvgRwm, laAverages });
|
||||
latest.current = { onMarkerClick, onDeselect, onAddToCompare, compareUrns, nationalAvgRwm, laAverages };
|
||||
|
||||
const cardHtmlFor = (school: School) => cardHtml(school, {
|
||||
inCompare: !!latest.current.compareUrns?.includes(school.urn),
|
||||
nationalAvgRwm: latest.current.nationalAvgRwm,
|
||||
laAverages: latest.current.laAverages,
|
||||
});
|
||||
|
||||
// Map, tiles and controls: once.
|
||||
useEffect(() => {
|
||||
if (!mapContainerRef.current) return;
|
||||
if (!mapContainerRef.current || mapRef.current) return;
|
||||
const map = L.map(mapContainerRef.current, { zoomControl: false }).setView(center, zoom);
|
||||
L.control.zoom({ position: 'topright' }).addTo(map);
|
||||
L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', {
|
||||
attribution: '© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors',
|
||||
maxZoom: 19,
|
||||
}).addTo(map);
|
||||
overlayRef.current = L.layerGroup().addTo(map);
|
||||
mapRef.current = map;
|
||||
// center/zoom only seed the first view; later changes go through the
|
||||
// markers effect, which fits the view to the results.
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, []);
|
||||
|
||||
// Initialize map
|
||||
if (!mapRef.current) {
|
||||
mapRef.current = L.map(mapContainerRef.current).setView(center, zoom);
|
||||
// Search location, radius and school pins.
|
||||
useEffect(() => {
|
||||
const map = mapRef.current;
|
||||
const overlay = overlayRef.current;
|
||||
if (!map || !overlay) return;
|
||||
|
||||
L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', {
|
||||
attribution: '© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors',
|
||||
maxZoom: 19,
|
||||
}).addTo(mapRef.current);
|
||||
}
|
||||
// Forget the open card before closing it, so its close handler does not
|
||||
// read this rebuild as the reader deselecting; the selection effect below
|
||||
// reopens it on the new pin.
|
||||
popupRef.current = null;
|
||||
map.closePopup();
|
||||
overlay.clearLayers();
|
||||
markersRef.current.clear();
|
||||
|
||||
// Clear existing school markers (not the reference pin)
|
||||
mapRef.current.eachLayer((layer) => {
|
||||
if (layer instanceof L.Marker && layer !== refMarkerRef.current) {
|
||||
mapRef.current!.removeLayer(layer);
|
||||
let radiusBounds: L.LatLngBounds | null = null;
|
||||
if (referencePoint) {
|
||||
if (radiusMiles) {
|
||||
const circle = L.circle(referencePoint, {
|
||||
radius: radiusMiles * METRES_PER_MILE,
|
||||
className: 'sc-radius',
|
||||
interactive: false,
|
||||
}).addTo(overlay);
|
||||
radiusBounds = circle.getBounds();
|
||||
const label = radiusMiles === 1 ? '1 mile' : `${radiusMiles} miles`;
|
||||
L.marker([radiusBounds.getNorth(), referencePoint[1]], {
|
||||
icon: L.divIcon({ className: 'sc-radius-label', html: label, iconSize: undefined }),
|
||||
interactive: false,
|
||||
keyboard: false,
|
||||
}).addTo(overlay);
|
||||
}
|
||||
});
|
||||
|
||||
// Add reference pin (search location)
|
||||
if (refMarkerRef.current) {
|
||||
refMarkerRef.current.remove();
|
||||
refMarkerRef.current = null;
|
||||
}
|
||||
if (referencePoint && mapRef.current) {
|
||||
const refIcon = L.divIcon({
|
||||
html: `<div style="
|
||||
width: 20px; height: 20px;
|
||||
background: var(--brand);
|
||||
border: 3px solid white;
|
||||
border-radius: 50%;
|
||||
box-shadow: 0 2px 8px rgba(0,0,0,0.35);
|
||||
"></div>`,
|
||||
iconSize: [20, 20],
|
||||
iconAnchor: [10, 10],
|
||||
className: '',
|
||||
});
|
||||
refMarkerRef.current = L.marker(referencePoint, { icon: refIcon, zIndexOffset: 1000 })
|
||||
.addTo(mapRef.current)
|
||||
.bindPopup('<strong>Search location</strong>');
|
||||
L.marker(referencePoint, {
|
||||
icon: L.divIcon({ className: 'sc-home', html: '', iconSize: [16, 16], iconAnchor: [8, 8] }),
|
||||
zIndexOffset: 500,
|
||||
title: 'Search location',
|
||||
alt: 'Search location',
|
||||
}).addTo(overlay);
|
||||
}
|
||||
|
||||
// Add markers for schools
|
||||
schools.forEach((school) => {
|
||||
if (school.latitude && school.longitude && mapRef.current) {
|
||||
const marker = L.marker([school.latitude, school.longitude]).addTo(mapRef.current);
|
||||
for (const school of schools) {
|
||||
if (!school.latitude || !school.longitude) continue;
|
||||
const selected = school.urn === selectedRef.current;
|
||||
const marker = L.marker([school.latitude, school.longitude], {
|
||||
icon: pinIcon(selected),
|
||||
zIndexOffset: selected ? 1000 : 0,
|
||||
title: school.school_name,
|
||||
alt: school.school_name,
|
||||
riseOnHover: true,
|
||||
}).addTo(overlay);
|
||||
marker.on('click', () => latest.current.onMarkerClick?.(school));
|
||||
markersRef.current.set(school.urn, marker);
|
||||
}
|
||||
|
||||
// Create popup content
|
||||
const badge = buildPopupBadge(school);
|
||||
const isSecondary = school.attainment_8_score != null;
|
||||
|
||||
// Phase label
|
||||
const rawPhase = (school.phase ?? '').toLowerCase();
|
||||
const phaseLabel =
|
||||
rawPhase.includes('secondary') ? 'Secondary' :
|
||||
rawPhase === 'all-through' ? 'All-through' :
|
||||
rawPhase.includes('primary') ? 'Primary' :
|
||||
isSecondary ? 'Secondary' : 'Primary';
|
||||
|
||||
// Distance string
|
||||
const distanceStr =
|
||||
school.distance != null ? ` · ${school.distance.toFixed(1)} mi` : '';
|
||||
|
||||
// Headline metric
|
||||
let metricHtml = '';
|
||||
if (isSecondary) {
|
||||
const score = school.attainment_8_score!;
|
||||
const laAvg = school.local_authority ? (laAverages?.[school.local_authority] ?? null) : null;
|
||||
let deltaLine = '';
|
||||
if (laAvg != null) {
|
||||
const diff = Math.round((score - laAvg) * 10) / 10;
|
||||
const sign = diff >= 0 ? '+' : '';
|
||||
// Att8 scores range 0–90 in 0.1 increments; ±0.5 is meaningful here
|
||||
// vs primary RWM % where ±2 pts is the threshold
|
||||
const colour = diff >= 0.5 ? 'var(--status-above)' : diff <= -0.5 ? 'var(--brand)' : 'var(--text-muted)';
|
||||
const laName = escapeHtml(school.local_authority ?? 'LA');
|
||||
deltaLine = `<div style="font-size:11px;font-weight:600;color:${colour}">${sign}${diff} vs ${laName} avg</div>`;
|
||||
}
|
||||
metricHtml = `<div style="margin-bottom:4px">
|
||||
<span style="font-size:20px;font-weight:700;color:var(--text-primary);font-family:Georgia,serif">${score.toFixed(1)}</span>
|
||||
<span style="font-size:11px;color:var(--text-muted);margin-left:4px">Attainment 8</span>
|
||||
${deltaLine}
|
||||
</div>`;
|
||||
} else if (school.rwm_expected_pct != null) {
|
||||
const rwm = school.rwm_expected_pct;
|
||||
let deltaLine = '';
|
||||
if (nationalAvgRwm != null) {
|
||||
const diff = Math.round(rwm - nationalAvgRwm);
|
||||
const colour = diff >= 2 ? 'var(--status-above)' : diff <= -2 ? 'var(--brand)' : 'var(--text-muted)';
|
||||
const text =
|
||||
diff >= 2 ? `+${diff} pts vs national` :
|
||||
diff <= -2 ? `${diff} pts vs national` :
|
||||
'≈ national avg';
|
||||
deltaLine = `<div style="font-size:11px;font-weight:600;color:${colour}">${text}</div>`;
|
||||
}
|
||||
metricHtml = `<div style="margin-bottom:4px">
|
||||
<span style="font-size:20px;font-weight:700;color:var(--text-primary);font-family:Georgia,serif">${rwm}%</span>
|
||||
<span style="font-size:11px;color:var(--text-muted);margin-left:4px">Reading, Writing & Maths</span>
|
||||
${deltaLine}
|
||||
</div>`;
|
||||
}
|
||||
|
||||
const slug = schoolUrl(school.urn, school.school_name);
|
||||
|
||||
const popupContent = `<div style="font-family:system-ui,sans-serif;min-width:240px;max-width:280px;padding:0">
|
||||
<div style="display:flex;justify-content:space-between;align-items:flex-start;gap:8px;margin-bottom:6px">
|
||||
<strong style="font-size:13px;color:var(--text-primary);line-height:1.3">${escapeHtml(school.school_name)}</strong>
|
||||
<span style="font-size:10px;font-weight:700;padding:2px 6px;border-radius:3px;white-space:nowrap;flex-shrink:0;${badge.style}">${badge.label}</span>
|
||||
</div>
|
||||
<div style="font-size:11px;color:var(--text-muted);margin-bottom:8px">
|
||||
${phaseLabel}${school.local_authority ? ` · ${escapeHtml(school.local_authority)}` : ''}${distanceStr}
|
||||
</div>
|
||||
${metricHtml}
|
||||
<a href="${slug}" style="display:block;text-align:center;padding:6px;background:var(--status-above);color:var(--text-inverse);border-radius:5px;text-decoration:none;font-size:12px;font-weight:600;margin-top:8px">View Details →</a>
|
||||
</div>`;
|
||||
|
||||
marker.bindPopup(popupContent);
|
||||
|
||||
if (onMarkerClick) {
|
||||
marker.on('click', () => onMarkerClick(school));
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Update map view
|
||||
if (schools.length > 1) {
|
||||
const bounds = L.latLngBounds(
|
||||
schools
|
||||
.filter(s => s.latitude && s.longitude)
|
||||
.map(s => [s.latitude!, s.longitude!] as [number, number])
|
||||
);
|
||||
mapRef.current.fitBounds(bounds, { padding: [50, 50] });
|
||||
// Fit the search radius when there is one: every result lies inside it,
|
||||
// and it keeps the view the same shape whatever the pins happen to be.
|
||||
if (radiusBounds) {
|
||||
map.fitBounds(radiusBounds, { padding: [16, 16] });
|
||||
} else if (schools.length > 1) {
|
||||
const points = schools
|
||||
.filter(s => s.latitude && s.longitude)
|
||||
.map(s => [s.latitude!, s.longitude!] as [number, number]);
|
||||
if (points.length) map.fitBounds(L.latLngBounds(points), { padding: [50, 50] });
|
||||
} else {
|
||||
mapRef.current.setView(center, zoom);
|
||||
map.setView(center, zoom);
|
||||
}
|
||||
setPinsVersion(v => v + 1);
|
||||
}, [schools, center, zoom, referencePoint, radiusMiles]);
|
||||
|
||||
// Selection: restyle the pin, and on wide screens open its card.
|
||||
useEffect(() => {
|
||||
const map = mapRef.current;
|
||||
if (!map) return;
|
||||
const previous = selectedRef.current;
|
||||
selectedRef.current = selectedUrn ?? null;
|
||||
|
||||
if (previous != null && previous !== selectedUrn) {
|
||||
const old = markersRef.current.get(previous);
|
||||
old?.setIcon(pinIcon(false));
|
||||
old?.setZIndexOffset(0);
|
||||
}
|
||||
|
||||
// Cleanup
|
||||
return () => {
|
||||
// Don't destroy map on every update, just clean markers
|
||||
};
|
||||
}, [schools, center, zoom, referencePoint, onMarkerClick, nationalAvgRwm, laAverages]);
|
||||
const marker = selectedUrn != null ? markersRef.current.get(selectedUrn) : undefined;
|
||||
const school = selectedUrn != null ? schools.find(s => s.urn === selectedUrn) : undefined;
|
||||
if (!marker || !school) {
|
||||
popupRef.current = null;
|
||||
map.closePopup();
|
||||
return;
|
||||
}
|
||||
marker.setIcon(pinIcon(true));
|
||||
marker.setZIndexOffset(1000);
|
||||
|
||||
if (!window.matchMedia(CARD_ON_MAP_QUERY).matches) {
|
||||
if (!map.getBounds().contains(marker.getLatLng())) map.panTo(marker.getLatLng());
|
||||
return;
|
||||
}
|
||||
|
||||
const popup = L.popup({
|
||||
className: 'sc-popup',
|
||||
maxWidth: 300,
|
||||
minWidth: 260,
|
||||
offset: [0, -12],
|
||||
autoPanPadding: [24, 24],
|
||||
}).setLatLng(marker.getLatLng()).setContent(cardHtmlFor(school));
|
||||
popup.on('remove', () => {
|
||||
// Closed from the map, not replaced by another selection.
|
||||
if (popupRef.current === popup) {
|
||||
popupRef.current = null;
|
||||
latest.current.onDeselect?.();
|
||||
}
|
||||
});
|
||||
popupRef.current = popup;
|
||||
popup.openOn(map);
|
||||
// One listener on the card's shell: it outlives the content swaps below.
|
||||
popup.getElement()?.addEventListener('click', (e) => {
|
||||
if ((e.target as HTMLElement).closest('[data-compare]')) latest.current.onAddToCompare?.(school);
|
||||
});
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, [selectedUrn, pinsVersion]);
|
||||
|
||||
// The open card follows the compare basket and the averages as they arrive.
|
||||
useEffect(() => {
|
||||
const popup = popupRef.current;
|
||||
if (!popup || selectedUrn == null) return;
|
||||
const school = schools.find(s => s.urn === selectedUrn);
|
||||
if (school) popup.setContent(cardHtmlFor(school));
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, [compareUrns, nationalAvgRwm, laAverages]);
|
||||
|
||||
// Cleanup map on unmount
|
||||
useEffect(() => {
|
||||
|
||||
@@ -5,7 +5,9 @@
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
z-index: 1000;
|
||||
/* Above the pinned results toolbar (1001), the floating List/Map button
|
||||
(1002) and the comparison toast (2000): a modal covers the page. */
|
||||
z-index: 2100;
|
||||
padding: 1rem;
|
||||
animation: fadeIn 0.2s ease;
|
||||
}
|
||||
@@ -31,6 +33,10 @@
|
||||
border: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.modal:focus {
|
||||
outline: none;
|
||||
}
|
||||
|
||||
@keyframes slideIn {
|
||||
from {
|
||||
transform: translateY(-20px);
|
||||
@@ -96,6 +102,14 @@
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
/* Clears the iPhone home indicator when the modal is a bottom sheet. */
|
||||
.footer {
|
||||
flex-shrink: 0;
|
||||
padding: 0.75rem 1rem calc(0.75rem + env(safe-area-inset-bottom, 0px));
|
||||
border-top: 1px solid var(--border);
|
||||
background: var(--bg-card);
|
||||
}
|
||||
|
||||
/* Scrollbar styles */
|
||||
.content::-webkit-scrollbar {
|
||||
width: 8px;
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
'use client';
|
||||
|
||||
import { useEffect, useCallback, useRef } from 'react';
|
||||
import { useEffect, useCallback, useId, useRef } from 'react';
|
||||
import { createPortal } from 'react-dom';
|
||||
import styles from './Modal.module.css';
|
||||
|
||||
@@ -15,10 +15,14 @@ interface ModalProps {
|
||||
children: React.ReactNode;
|
||||
title?: string;
|
||||
size?: 'small' | 'medium' | 'large';
|
||||
/** Pinned below the scrolling content, so its actions stay in reach. */
|
||||
footer?: React.ReactNode;
|
||||
}
|
||||
|
||||
export function Modal({ isOpen, onClose, children, title, size = 'medium' }: ModalProps) {
|
||||
export function Modal({ isOpen, onClose, children, title, size = 'medium', footer }: ModalProps) {
|
||||
const overlayRef = useRef<HTMLDivElement>(null);
|
||||
const dialogRef = useRef<HTMLDivElement>(null);
|
||||
const titleId = useId();
|
||||
|
||||
const handleEscape = useCallback((e: KeyboardEvent) => {
|
||||
if (e.key === 'Escape') {
|
||||
@@ -41,6 +45,17 @@ export function Modal({ isOpen, onClose, children, title, size = 'medium' }: Mod
|
||||
};
|
||||
}, [isOpen, handleEscape]);
|
||||
|
||||
// Focus moves into the dialog when it opens and back to whatever opened it
|
||||
// when it closes. A child that has already taken focus (an autoFocus input)
|
||||
// keeps it: children's effects run before this one.
|
||||
useEffect(() => {
|
||||
if (!isOpen) return;
|
||||
const opener = document.activeElement as HTMLElement | null;
|
||||
const dialog = dialogRef.current;
|
||||
if (dialog && !dialog.contains(document.activeElement)) dialog.focus();
|
||||
return () => opener?.focus?.();
|
||||
}, [isOpen]);
|
||||
|
||||
// Pin the overlay to the VISUAL viewport, not the layout viewport. On mobile
|
||||
// the on-screen keyboard shrinks the visual viewport but not the layout one,
|
||||
// so a `position: fixed; inset: 0` overlay keeps full height — leaving the
|
||||
@@ -77,9 +92,16 @@ export function Modal({ isOpen, onClose, children, title, size = 'medium' }: Mod
|
||||
|
||||
return createPortal(
|
||||
<div ref={overlayRef} className={styles.overlay} onClick={handleOverlayClick}>
|
||||
<div className={`${styles.modal} ${styles[size]}`}>
|
||||
<div
|
||||
ref={dialogRef}
|
||||
className={`${styles.modal} ${styles[size]}`}
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-labelledby={title ? titleId : undefined}
|
||||
tabIndex={-1}
|
||||
>
|
||||
<div className={styles.header}>
|
||||
{title && <h2 className={styles.title}>{title}</h2>}
|
||||
{title && <h2 id={titleId} className={styles.title}>{title}</h2>}
|
||||
<button
|
||||
className={styles.closeButton}
|
||||
onClick={onClose}
|
||||
@@ -103,6 +125,7 @@ export function Modal({ isOpen, onClose, children, title, size = 'medium' }: Mod
|
||||
<div className={styles.content}>
|
||||
{children}
|
||||
</div>
|
||||
{footer && <div className={styles.footer}>{footer}</div>}
|
||||
</div>
|
||||
</div>,
|
||||
document.body
|
||||
|
||||
@@ -74,3 +74,173 @@
|
||||
font-size: 0.9375rem;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/* ── Results map skin ──────────────────────────────────────────────────────
|
||||
Leaflet renders these outside React, so they are global class names, scoped
|
||||
under .mapWrapper to keep this module pure. Pins are brand teal, the chosen
|
||||
one coral; the search location is ink, ringed. */
|
||||
|
||||
/* Muted tiles so the pins, not the streets, carry the colour. */
|
||||
.mapWrapper :global(.leaflet-tile-pane) {
|
||||
filter: saturate(0.45);
|
||||
}
|
||||
|
||||
/* The fullscreen button owns the top-right corner; zoom stacks under it. */
|
||||
.mapWrapper :global(.leaflet-top.leaflet-right) {
|
||||
top: 2.75rem;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-pin) {
|
||||
box-sizing: border-box;
|
||||
border-radius: 50%;
|
||||
background: var(--brand);
|
||||
border: 2.5px solid var(--bg-card);
|
||||
box-shadow: 0 2px 5px rgba(var(--shadow-rgb), 0.35);
|
||||
transition: transform 0.12s ease;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-pin:hover) {
|
||||
transform: scale(1.15);
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-pin--selected) {
|
||||
background: var(--action);
|
||||
border-width: 3px;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-pin:focus-visible) {
|
||||
outline: 3px solid var(--text-primary);
|
||||
outline-offset: 2px;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-home) {
|
||||
border-radius: 50%;
|
||||
background: var(--text-primary);
|
||||
box-shadow: 0 0 0 6px rgba(var(--shadow-rgb), 0.18);
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-radius) {
|
||||
stroke: var(--brand);
|
||||
stroke-width: 2px;
|
||||
stroke-dasharray: 6 6;
|
||||
fill: var(--brand);
|
||||
fill-opacity: 0.05;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-radius-label) {
|
||||
width: auto !important;
|
||||
height: auto !important;
|
||||
transform-origin: center;
|
||||
translate: -50% -50%;
|
||||
padding: 0.125rem 0.625rem;
|
||||
background: var(--bg-card);
|
||||
border: 1px solid var(--brand);
|
||||
border-radius: 999px;
|
||||
font-family: var(--font-ui);
|
||||
font-size: 0.75rem;
|
||||
font-weight: 700;
|
||||
color: var(--brand-strong);
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
/* The selected school's card, drawn as a card rather than a speech bubble. */
|
||||
.mapWrapper :global(.sc-popup .leaflet-popup-content-wrapper) {
|
||||
border-radius: 14px;
|
||||
box-shadow: 0 10px 28px rgba(var(--shadow-rgb), 0.22);
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-popup .leaflet-popup-content) {
|
||||
margin: 0.875rem 1rem;
|
||||
font-family: var(--font-ui);
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-card) {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-card-head) {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: flex-start;
|
||||
gap: 0.5rem;
|
||||
padding-right: 1rem; /* clear of the popup's × */
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-card-name) {
|
||||
font-family: var(--font-display);
|
||||
font-size: 0.9375rem;
|
||||
font-weight: 700;
|
||||
line-height: 1.3;
|
||||
color: var(--text-primary);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-card-name:hover) {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-dist) {
|
||||
flex-shrink: 0;
|
||||
padding: 0.125rem 0.375rem;
|
||||
border-radius: 4px;
|
||||
background: var(--brand);
|
||||
color: var(--brand-on);
|
||||
font-size: 0.75rem;
|
||||
font-weight: 700;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-card-tags) {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.375rem;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-ofsted),
|
||||
.mapWrapper :global(.sc-tag) {
|
||||
padding: 0.125rem 0.4375rem;
|
||||
border-radius: 4px;
|
||||
font-size: 0.6875rem;
|
||||
font-weight: 600;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-tag) {
|
||||
background: var(--bg-secondary);
|
||||
color: var(--text-secondary);
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-ofsted1),
|
||||
.mapWrapper :global(.sc-ofsted2) { background: var(--status-above-bg); color: var(--status-above); }
|
||||
.mapWrapper :global(.sc-ofsted3) { background: var(--status-below-bg); color: var(--status-below); }
|
||||
.mapWrapper :global(.sc-ofsted4) { background: var(--status-below); color: var(--text-inverse); }
|
||||
.mapWrapper :global(.sc-ofstedRc) { background: var(--phase-secondary-text); color: var(--text-inverse); }
|
||||
.mapWrapper :global(.sc-ofstedInspected) { background: var(--phase-primary-bg); color: var(--phase-primary-text); }
|
||||
.mapWrapper :global(.sc-ofstedPending) { background: var(--border); color: var(--text-muted); }
|
||||
|
||||
.mapWrapper :global(.sc-card-metric) {
|
||||
font-size: 0.8125rem;
|
||||
color: var(--text-secondary);
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-card-metric strong) {
|
||||
font-size: 0.9375rem;
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-up) { color: var(--status-above); font-weight: 600; }
|
||||
.mapWrapper :global(.sc-down) { color: var(--status-below); font-weight: 600; }
|
||||
|
||||
.mapWrapper :global(.sc-card-actions) {
|
||||
display: flex;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.mapWrapper :global(.sc-card-actions > *) {
|
||||
flex: 1;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
}
|
||||
@@ -6,7 +6,7 @@
|
||||
'use client';
|
||||
|
||||
import dynamic from 'next/dynamic';
|
||||
import { useRef, useState, useEffect, useCallback } from 'react';
|
||||
import { useRef, useState, useEffect, useCallback, useMemo } from 'react';
|
||||
import type { School } from '@/lib/types';
|
||||
import styles from './SchoolMap.module.css';
|
||||
|
||||
@@ -26,12 +26,17 @@ interface SchoolMapProps {
|
||||
center?: [number, number];
|
||||
zoom?: number;
|
||||
referencePoint?: [number, number];
|
||||
radiusMiles?: number;
|
||||
selectedUrn?: number | null;
|
||||
onMarkerClick?: (school: School) => void;
|
||||
onDeselect?: () => void;
|
||||
onAddToCompare?: (school: School) => void;
|
||||
compareUrns?: number[];
|
||||
nationalAvgRwm?: number | null;
|
||||
laAverages?: Record<string, number | null>;
|
||||
}
|
||||
|
||||
export function SchoolMap({ schools, center, zoom = 13, referencePoint, onMarkerClick, nationalAvgRwm, laAverages }: SchoolMapProps) {
|
||||
export function SchoolMap({ schools, center, zoom = 13, referencePoint, onMarkerClick, nationalAvgRwm, laAverages, ...selection }: SchoolMapProps) {
|
||||
const wrapperRef = useRef<HTMLDivElement>(null);
|
||||
const [nativeFullscreen, setNativeFullscreen] = useState(false);
|
||||
// iOS Safari has no Element.requestFullscreen — fall back to a fixed-position
|
||||
@@ -80,8 +85,9 @@ export function SchoolMap({ schools, center, zoom = 13, referencePoint, onMarker
|
||||
}
|
||||
}, [fallbackFullscreen]);
|
||||
|
||||
// Calculate center if not provided
|
||||
const mapCenter: [number, number] = center || (() => {
|
||||
// Calculate center if not provided. Memoised: a fresh array on every render
|
||||
// would make the map refit and rebuild every pin each time.
|
||||
const mapCenter = useMemo<[number, number]>(() => center || (() => {
|
||||
if (schools.length === 0) return [51.5074, -0.1278];
|
||||
if (schools.length === 1 && schools[0].latitude && schools[0].longitude) {
|
||||
return [schools[0].latitude, schools[0].longitude];
|
||||
@@ -90,8 +96,8 @@ export function SchoolMap({ schools, center, zoom = 13, referencePoint, onMarker
|
||||
if (validSchools.length === 0) return [51.5074, -0.1278];
|
||||
const avgLat = validSchools.reduce((sum, s) => sum + (s.latitude || 0), 0) / validSchools.length;
|
||||
const avgLng = validSchools.reduce((sum, s) => sum + (s.longitude || 0), 0) / validSchools.length;
|
||||
return [avgLat, avgLng];
|
||||
})();
|
||||
return [avgLat, avgLng] as [number, number];
|
||||
})(), [center, schools]);
|
||||
|
||||
return (
|
||||
<div ref={wrapperRef} className={`${styles.mapWrapper} ${isFullscreen ? styles.fullscreen : ''} ${fallbackFullscreen ? styles.fsFallback : ''}`}>
|
||||
@@ -123,6 +129,7 @@ export function SchoolMap({ schools, center, zoom = 13, referencePoint, onMarker
|
||||
onMarkerClick={onMarkerClick}
|
||||
nationalAvgRwm={nationalAvgRwm}
|
||||
laAverages={laAverages}
|
||||
{...selection}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
|
||||
@@ -220,7 +220,16 @@
|
||||
.vsNationalFlat { font-size: 0.7rem; color: var(--text-muted); }
|
||||
|
||||
/* ── Mobile ──────────────────────────────────────────── */
|
||||
@media (max-width: 640px) {
|
||||
/*
|
||||
* Narrow: content full width, actions in a row beneath. Keyed to the list the
|
||||
* row sits in, not the screen, because the same row fills the phone list and
|
||||
* the ~430px list beside the map on desktop. HomeView makes its lists a
|
||||
* `results` container; outside one, the row keeps its wide layout, which is
|
||||
* why rowContainerGuard.test.ts fails if anything else renders this row.
|
||||
* 608px is exact: below 769px the page pads 1rem each side, so a 640px screen
|
||||
* gives a 608px list, matching the old max-width: 640px media query.
|
||||
*/
|
||||
@container results (max-width: 608px) {
|
||||
.row {
|
||||
flex-wrap: wrap;
|
||||
padding: 0.875rem;
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
*/
|
||||
|
||||
import type { School } from '@/lib/types';
|
||||
import { formatPercentage, calculateTrend, getPhaseStyle, schoolUrl, buildOfstedListBadge, formatAgeRange, isProposedToClose, isSpecialSchool } from '@/lib/utils';
|
||||
import { formatPercentage, calculateTrend, getPhaseStyle, schoolUrl, buildOfstedListBadge, formatAgeRange, isProposedToClose, isSpecialSchool, listRwmValue } from '@/lib/utils';
|
||||
import styles from './SchoolRow.module.css';
|
||||
|
||||
interface SchoolRowProps {
|
||||
@@ -38,18 +38,10 @@ export function SchoolRow({
|
||||
school.religious_denomination &&
|
||||
school.religious_denomination !== 'Does not apply';
|
||||
|
||||
// A placeholder all-zero row (every subject 0 — a special/suppressed
|
||||
// signature, matching SchoolDetailView's ks2Placeholder) isn't a real score,
|
||||
// so its figure is hidden. A genuine 0% combined (some pupils met individual
|
||||
// subjects but not all three) is NOT all-zero and stays shown.
|
||||
const rwmPlaceholder =
|
||||
school.rwm_expected_pct === 0 &&
|
||||
(school.reading_expected_pct ?? 0) === 0 &&
|
||||
(school.writing_expected_pct ?? 0) === 0 &&
|
||||
(school.maths_expected_pct ?? 0) === 0;
|
||||
// The school's OWN figure and its year-over-year trend are same-school
|
||||
// measures — shown whenever there's a real value, special schools included.
|
||||
const showRwmValue = school.rwm_expected_pct != null && !rwmPlaceholder;
|
||||
// measures — shown whenever there's a real value (not the all-zero
|
||||
// placeholder, see listRwmValue), special schools included.
|
||||
const showRwmValue = listRwmValue(school) != null;
|
||||
// The vs-England delta is a mainstream benchmark: additionally dropped for
|
||||
// special schools / PRUs / AP, whose pupils aren't measured against it fairly.
|
||||
const rwmDelta =
|
||||
|
||||
@@ -232,7 +232,16 @@
|
||||
}
|
||||
|
||||
/* ── Mobile ──────────────────────────────────────────── */
|
||||
@media (max-width: 640px) {
|
||||
/*
|
||||
* Narrow: content full width, actions in a row beneath. Keyed to the list the
|
||||
* row sits in, not the screen, because the same row fills the phone list and
|
||||
* the ~430px list beside the map on desktop. HomeView makes its lists a
|
||||
* `results` container; outside one, the row keeps its wide layout, which is
|
||||
* why rowContainerGuard.test.ts fails if anything else renders this row.
|
||||
* 608px is exact: below 769px the page pads 1rem each side, so a 640px screen
|
||||
* gives a 608px list, matching the old max-width: 640px media query.
|
||||
*/
|
||||
@container results (max-width: 608px) {
|
||||
.row {
|
||||
flex-wrap: wrap;
|
||||
padding: 0.875rem;
|
||||
|
||||
@@ -33,7 +33,8 @@ export type EventName =
|
||||
| 'compare_focus_school'
|
||||
// Operational
|
||||
| 'api_error'
|
||||
| 'results_load_more';
|
||||
| 'results_load_more'
|
||||
| 'results_view_changed';
|
||||
|
||||
type Primitive = string | number | boolean;
|
||||
type Payload = Record<string, Primitive>;
|
||||
|
||||
@@ -484,6 +484,12 @@ export interface RankingsResponse {
|
||||
local_authority?: string;
|
||||
}
|
||||
|
||||
/** A filter option whose URL value differs from what a parent reads. */
|
||||
export interface FilterOption {
|
||||
value: string;
|
||||
label: string;
|
||||
}
|
||||
|
||||
export interface Filters {
|
||||
local_authorities: string[];
|
||||
school_types: string[];
|
||||
@@ -491,6 +497,9 @@ export interface Filters {
|
||||
phases: string[];
|
||||
genders: string[];
|
||||
admissions_policies: string[];
|
||||
/** Parent-facing school type groups; the URL's school_type takes their value. */
|
||||
school_type_groups?: FilterOption[];
|
||||
faiths?: FilterOption[];
|
||||
}
|
||||
|
||||
export interface NationalAveragesYear {
|
||||
@@ -567,6 +576,7 @@ export interface SchoolSearchParams {
|
||||
gender?: string;
|
||||
admissions_policy?: string;
|
||||
has_sixth_form?: string;
|
||||
faith?: string;
|
||||
}
|
||||
|
||||
export interface RankingsParams {
|
||||
|
||||
@@ -235,6 +235,9 @@ export function getVariabilityLabel(stdDev: number | null): string {
|
||||
// Validation
|
||||
// ============================================================================
|
||||
|
||||
/** Radius a postcode search uses until the user picks another. */
|
||||
export const DEFAULT_RADIUS_MILES = 0.5;
|
||||
|
||||
/**
|
||||
* Validate UK postcode format
|
||||
*/
|
||||
@@ -898,3 +901,27 @@ export function isSpecialSchool(school: { school_type?: string | null }): boolea
|
||||
const t = (school.school_type ?? '').toLowerCase();
|
||||
return /\bspecial\b/.test(t) || /pupil referral/.test(t) || /alternative provision/.test(t);
|
||||
}
|
||||
|
||||
/**
|
||||
* The school's combined Reading, Writing & Maths figure, or null when there is
|
||||
* no real one to show.
|
||||
*
|
||||
* A placeholder all-zero row (every subject 0, the special/suppressed
|
||||
* signature that SchoolDetailView calls ks2Placeholder) is not a score. A
|
||||
* genuine 0% combined, where some pupils met individual subjects but not all
|
||||
* three, is not all-zero and stays shown.
|
||||
*/
|
||||
export function listRwmValue(school: {
|
||||
rwm_expected_pct?: number | null;
|
||||
reading_expected_pct?: number | null;
|
||||
writing_expected_pct?: number | null;
|
||||
maths_expected_pct?: number | null;
|
||||
}): number | null {
|
||||
if (school.rwm_expected_pct == null) return null;
|
||||
const placeholder =
|
||||
school.rwm_expected_pct === 0 &&
|
||||
(school.reading_expected_pct ?? 0) === 0 &&
|
||||
(school.writing_expected_pct ?? 0) === 0 &&
|
||||
(school.maths_expected_pct ?? 0) === 0;
|
||||
return placeholder ? null : school.rwm_expected_pct;
|
||||
}
|
||||
Reference in new issue
Block a user