Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Open unlimited polygon does not restrict crossing sides. #1896

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

catandthemachines
Copy link
Member

@catandthemachines catandthemachines commented Nov 20, 2024

Summary:

For keyboard users if they're drowing a polygon and it places a point at 0,0. There are cases where it could cross the sides of the polygon they are actively creating and cause the polygon to break. Mouse uses can get around this a bit. But it's not idea.

This fix checks whether the polygon type allows intersecting sides and disables the rejection logic.

Issue: LEMS-2618

Test plan:

Go to /?path=/story/perseus-widgets-interactive-graph--unlimited-polygon-with-mafs in Storybook.
Use your keyboard to add points.
Move a few points in a way that a new point would cause the sides to intersect.
Add a new point and make sure you can still move points on the polygon.

@catandthemachines catandthemachines self-assigned this Nov 20, 2024
@khan-actions-bot khan-actions-bot requested a review from a team November 20, 2024 23:45
@khan-actions-bot
Copy link
Contributor

khan-actions-bot commented Nov 20, 2024

Gerald

Required Reviewers
  • @Khan/perseus for changes to .changeset/chilled-pianos-cheat.md, packages/perseus/src/widgets/interactive-graphs/mafs-graph.tsx, packages/perseus/src/widgets/interactive-graphs/reducer/interactive-graph-reducer.test.ts, packages/perseus/src/widgets/interactive-graphs/reducer/interactive-graph-reducer.ts

Don't want to be involved in this pull request? Comment #removeme and we won't notify you of further changes.

Copy link
Contributor

github-actions bot commented Nov 20, 2024

npm Snapshot: Published

Good news!! We've packaged up the latest commit from this PR (5831675) and published it to npm. You
can install it using the tag PR1896.

Example:

yarn add @khanacademy/perseus@PR1896

If you are working in Khan Academy's webapp, you can run:

./dev/tools/bump_perseus_version.sh -t PR1896

Copy link
Contributor

github-actions bot commented Nov 20, 2024

Size Change: +134 B (+0.01%)

Total Size: 1.29 MB

Filename Size Change
packages/perseus/dist/es/index.js 425 kB +134 B (+0.03%)
ℹ️ View Unchanged
Filename Size
packages/kas/dist/es/index.js 39 kB
packages/keypad-context/dist/es/index.js 760 B
packages/kmath/dist/es/index.js 4.27 kB
packages/math-input/dist/es/index.js 77.9 kB
packages/math-input/dist/es/strings.js 1.79 kB
packages/perseus-core/dist/es/index.js 1.48 kB
packages/perseus-editor/dist/es/index.js 698 kB
packages/perseus-linter/dist/es/index.js 22.2 kB
packages/perseus/dist/es/strings.js 3.57 kB
packages/pure-markdown/dist/es/index.js 3.66 kB
packages/simple-markdown/dist/es/index.js 12.5 kB

compressed-size-action

Copy link
Contributor

@nishasy nishasy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat! A couple of non-blocking suggestions, but overall looks good to me.

@@ -440,7 +446,7 @@ const renderPolygonGraphControls = (props: {
width: "100%",
marginLeft: "20px",
}}
tabIndex={0}
tabIndex={coords.length < 3 ? -1 : 0}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a comment explaining why the tab index depends on the coords length being less than 3?

@@ -483,8 +483,13 @@ function doMovePoint(
newValue: newValue,
});

// Reject the move if it would cause the sides of the polygon to cross
if (polygonSidesIntersect(newCoords)) {
// Boolean value to tract whether we can let the polygon sides interact.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Boolean value to tract whether we can let the polygon sides interact.
// Boolean value to track whether we can let the polygon sides interact.

@@ -301,6 +304,9 @@ export const MafsGraph = (props: MafsGraphProps) => {
{interactionPrompt && (
<View
style={{
display: interactionPrompt
? undefined
: "hidden",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Can you add a brief note in your PR description saying that this change is also in your PR even though it's not the main focus? It's helpful for me to follow PR expectations that way, and I think it's nice to document for posterity.

Copy link
Member

@benchristel benchristel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens when closing the polygon is what causes the sides to cross? Can you then untangle the points using the keyboard, or are they stuck?

I think we might need some logic like "if the polygon's sides currently cross, don't reject a move that results in the sides still crossing."

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes to this file seem unrelated to the rest of the PR. Are they supposed to be included?

Copy link
Member

@benchristel benchristel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed with Cat in Slack. It sounds like Caitlyn is aware of the "lines crossing" behavior and is okay with it for now. LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants