An open source design system that's fully customizable and agent ready
TypeScript
docs(core): the role test's header and the motion README's files name the internal roles (#8502)
Christopher Chedeau9d7cffe4f842
diff --git a/.changeset/motion-roles-docs-followup.md b/.changeset/motion-roles-docs-followup.mdnew file mode 100644index 0000000000..d6da78855c--- /dev/null+++ b/.changeset/motion-roles-docs-followup.md@@ -0,0 +1,7 @@+---+'@astryxdesign/core': patch+---++[chore] Internal: the motion roles test's header and the motion README's files table name the internal motion roles, exactly the ones `spec:AST-094` FR4 lists. Documentation only; no behavior change.++@vjeuxdiff --git a/packages/core/src/motion/README.md b/packages/core/src/motion/README.mdindex b052a57755..4315e523a3 100644--- a/packages/core/src/motion/README.md+++ b/packages/core/src/motion/README.md@@ -19,7 +19,8 @@ so each keeps its measured value; no shipped component reads the roles yet.| `uikit/timing.ts` | Non-spring clocks and curves: press highlight, Core Animation's named curves, keyboard, Reduced Motion cross-fade. || `uikit/navigation.ts` | UINavigationController: push velocity, parallax, dimming, transition clock, interactive pop finish rule. || `uikit/gestures.ts` | Gesture recognizer thresholds, the velocity filter and haptic stand-ins, as `{value, unit}` entries (sources in JSDoc). |-| `roles.ts` | Motion roles: each spring, duration and curve of a registered table, named by its path, and its CSS variable. |+| `roles.ts` | The internal motion roles: the springs, durations and curves `spec:AST-094` FR4 names, registered by the shared tables, and a role's CSS form read back. |+| `roleValue.ts` | A role's CSS form, written: a spring's duration and bounce, a duration in ms, a curve's `cubic-bezier()`. || `resolveMotion.ts` | A role's value: its table value, as the per-role tables stay internal (`spec:AST-094` DEC-15). || `MEASUREMENTS.md` | The UIKit reference captures each unconfirmed value still needs. || `spring.ts` | Closed-form damped spring, every Apple parameterization, settling duration, a spring chasing a moving target. |diff --git a/packages/core/src/motion/roles.test.ts b/packages/core/src/motion/roles.test.tsindex c64145e4ac..2bedd65028 100644--- a/packages/core/src/motion/roles.test.ts+++ b/packages/core/src/motion/roles.test.ts@@ -2,10 +2,11 @@/*** @file roles.test.ts- * @input roles.ts and the shared UIKit tables (registered on import)- * @output Proof that each spring, duration and curve of a registered table is- * a role named by its path, that non-motion values are not, and that a- * role's CSS value reads back as the same motion+ * @input roles.ts and the shared UIKit tables (registered by this test)+ * @output Proof that the registered roles are exactly the ones spec:AST-094+ * FR4 names, each by its table path; that every other table value, a+ * component's measured spring included, is no role; and that a role's CSS+ * value reads back as the same motion* @position Testing for /packages/core/src/motion/roles.ts*/