[SR] Circle - Add the interactive elements circle description to the whole graph container

.changeset/little-beds-tickle.md

@@ -0,0 +1,5 @@
+---
+"@khanacademy/perseus": patch
+---
+
+[SR] Circle - Add interactive Circle element to full graph description

packages/perseus/src/components/i18n-context.tsx

@@ -10,7 +10,7 @@ import {mockStrings} from "../strings";
 
 import type {PerseusStrings} from "../strings";
 
-type I18nContextType = {
+export type I18nContextType = {
     strings: PerseusStrings;
     locale: string;
 };

packages/perseus/src/widgets/interactive-graphs/graphs/circle.test.tsx

@@ -5,9 +5,12 @@ import * as React from "react";
 import {Dependencies} from "@khanacademy/perseus";
 
 import {testDependencies} from "../../../../../../testing/test-dependencies";
+import {mockPerseusI18nContext} from "../../../components/i18n-context";
 import {MafsGraph} from "../mafs-graph";
 import {getBaseMafsGraphPropsForTests} from "../utils";
 
+import {describeCircleGraph} from "./circle";
+
 import type {InteractiveGraphState} from "../types";
 import type {UserEvent} from "@testing-library/user-event";
 
@@ -163,3 +166,57 @@ describe("Circle graph screen reader", () => {
         expect(radiusPoint).toHaveAttribute("aria-live", "off");
     });
 });
+
+describe("describeCircleGraph", () => {
+    test("describes a default circle", () => {
+        // Arrange
+
+        // Act
+        const strings = describeCircleGraph(
+            baseCircleState,
+            mockPerseusI18nContext,
+        );
+
+        // Assert
+        expect(strings.srCircleGraph).toBe("A circle on a coordinate plane.");
+        expect(strings.srCircleShape).toBe(
+            "Circle. The center point is at 0 comma 0.",
+        );
+        expect(strings.srCircleRadiusPoint).toBe("Radius point at 1 comma 0.");
+        expect(strings.srCircleRadius).toBe("Circle radius is 1.");
+        expect(strings.srCircleOuterPoints).toBe(
+            "Points on the circle at 1 comma 0, 0 comma 1, -1 comma 0, 0 comma -1.",
+        );
+        expect(strings.srCircleInteractiveElement).toBe(
+            "Interactive elements: Circle. The center point is at 0 comma 0. Circle radius is 1.",
+        );
+    });
+
+    test("describes a circle with updated values", () => {
+        // Arrange
+
+        // Act
+        const strings = describeCircleGraph(
+            {
+                ...baseCircleState,
+                center: [2, 3],
+                radiusPoint: [7, 3],
+            },
+            mockPerseusI18nContext,
+        );
+
+        // Assert
+        expect(strings.srCircleGraph).toBe("A circle on a coordinate plane.");
+        expect(strings.srCircleShape).toBe(
+            "Circle. The center point is at 2 comma 3.",
+        );
+        expect(strings.srCircleRadiusPoint).toBe("Radius point at 7 comma 3.");
+        expect(strings.srCircleRadius).toBe("Circle radius is 5.");
+        expect(strings.srCircleOuterPoints).toBe(
+            "Points on the circle at 7 comma 3, 2 comma 8, -3 comma 3, 2 comma -2.",
+        );
+        expect(strings.srCircleInteractiveElement).toBe(
+            "Interactive elements: Circle. The center point is at 2 comma 3. Circle radius is 5.",
+        );
+    });
+});

packages/perseus/src/widgets/interactive-graphs/graphs/circle.tsx

@@ -16,6 +16,7 @@ import {
     useTransformVectorsToPixels,
 } from "./use-transform";
 
+import type {I18nContextType} from "../../../components/i18n-context";
 import type {
     AriaLive,
     CircleGraphState,
@@ -30,7 +31,7 @@ export function renderCircleGraph(
 ): InteractiveGraphElementSuite {
     return {
         graph: <CircleGraph graphState={state} dispatch={dispatch} />,
-        interactiveElementsDescription: null,
+        interactiveElementsDescription: CircleGraphDescription({state}),
     };
 }
 
@@ -51,40 +52,25 @@ function CircleGraph(props: CircleGraphProps) {
     const outerPointsId = id + "-outer-points";
 
     // Aria label strings
-    const circleGraphAriaLabel = strings.srCircleGraph;
-    const circleShapeAriaLabel = strings.srCircleShape({
-        centerX: srFormatNumber(center[0], locale),
-        centerY: srFormatNumber(center[1], locale),
-    });
-    const circleRadiusPointAriaLabel = strings.srCircleRadiusPoint({
-        radiusPointX: srFormatNumber(radiusPoint[0], locale),
-        radiusPointY: srFormatNumber(radiusPoint[1], locale),
-    });
-    const circleRadiusDescription = strings.srCircleRadius({
-        radius,
-    });
-    const circleOuterPointsDescription = strings.srCircleOuterPoints({
-        point1X: srFormatNumber(center[0] + radius, locale),
-        point1Y: srFormatNumber(center[1], locale),
-        point2X: srFormatNumber(center[0], locale),
-        point2Y: srFormatNumber(center[1] + radius, locale),
-        point3X: srFormatNumber(center[0] - radius, locale),
-        point3Y: srFormatNumber(center[1], locale),
-        point4X: srFormatNumber(center[0], locale),
-        point4Y: srFormatNumber(center[1] - radius, locale),
-    });
+    const {
+        srCircleGraph,
+        srCircleShape,
+        srCircleRadiusPoint,
+        srCircleRadius,
+        srCircleOuterPoints,
+    } = describeCircleGraph(graphState, {strings, locale});
 
     return (
         <g
             // Outer circle minimal description
-            aria-label={circleGraphAriaLabel}
+            aria-label={srCircleGraph}
             aria-describedby={`${circleId} ${radiusId} ${outerPointsId}`}
         >
             <MovableCircle
                 id={circleId}
                 // Focusable circle aria label reads with every update
                 // because of the aria-live property in the circle <g>.
-                ariaLabel={circleShapeAriaLabel}
+                ariaLabel={srCircleShape}
                 // Aria-describedby describes additional info on focus.
                 ariaDescribedBy={`${radiusId} ${outerPointsId}`}
                 center={center}
@@ -96,7 +82,7 @@ function CircleGraph(props: CircleGraphProps) {
             />
             <MovablePoint
                 // Radius point aria label reads with every update.
-                ariaLabel={`${circleRadiusPointAriaLabel} ${circleRadiusDescription}`}
+                ariaLabel={`${srCircleRadiusPoint} ${srCircleRadius}`}
                 // Aria-describedby describes additional info on focus.
                 ariaDescribedBy={`${outerPointsId}`}
                 // The radius point's aria-live property is set to "off" when
@@ -116,10 +102,10 @@ function CircleGraph(props: CircleGraphProps) {
             {/* Hidden elements to provide the descriptions for the
                 circle and radius point's `aria-describedby` properties. */}
             <g id={radiusId} style={{display: "hidden"}}>
-                {circleRadiusDescription}
+                {srCircleRadius}
             </g>
             <g id={outerPointsId} style={{display: "hidden"}}>
-                {circleOuterPointsDescription}
+                {srCircleOuterPoints}
             </g>
         </g>
     );
@@ -221,3 +207,60 @@ function crossProduct<A, B>(as: A[], bs: B[]): [A, B][] {
     }
     return result;
 }
+
+function CircleGraphDescription({state}: {state: CircleGraphState}) {
+    // The reason that CircleGraphDescription is a component (rather than a
+    // function that returns a string) is because it needs to use a
+    // hook: `usePerseusI18n`.
+    const i18n = usePerseusI18n();
+    const strings = describeCircleGraph(state, i18n);
+
+    return strings.srCircleInteractiveElement;
+}
+
+// Exported for testing
+export function describeCircleGraph(
+    state: CircleGraphState,
+    i18n: I18nContextType,
+): Record<string, string> {
+    const {strings, locale} = i18n;
+    const {center, radiusPoint} = state;
+    const radius = getRadius(state);
+
+    // Aria label strings
+    const srCircleGraph = strings.srCircleGraph;
+    const srCircleShape = strings.srCircleShape({
+        centerX: srFormatNumber(center[0], locale),
+        centerY: srFormatNumber(center[1], locale),
+    });
+    const srCircleRadiusPoint = strings.srCircleRadiusPoint({
+        radiusPointX: srFormatNumber(radiusPoint[0], locale),
+        radiusPointY: srFormatNumber(radiusPoint[1], locale),
+    });
+    const srCircleRadius = strings.srCircleRadius({
+        radius,
+    });
+    const srCircleOuterPoints = strings.srCircleOuterPoints({
+        point1X: srFormatNumber(center[0] + radius, locale),
+        point1Y: srFormatNumber(center[1], locale),
+        point2X: srFormatNumber(center[0], locale),
+        point2Y: srFormatNumber(center[1] + radius, locale),
+        point3X: srFormatNumber(center[0] - radius, locale),
+        point3Y: srFormatNumber(center[1], locale),
+        point4X: srFormatNumber(center[0], locale),
+        point4Y: srFormatNumber(center[1] - radius, locale),
+    });
+
+    const srCircleInteractiveElement = strings.srInteractiveElements({
+        elements: [srCircleShape, srCircleRadius].join(" "),
+    });
+
+    return {
+        srCircleGraph,
+        srCircleShape,
+        srCircleRadiusPoint,
+        srCircleRadius,
+        srCircleOuterPoints,
+        srCircleInteractiveElement,
+    };
+}