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

[Locked Labels] Count lone unescaped $ as regular dollar signs #1875

Open
wants to merge 6 commits into
base: labels-util-function
Choose a base branch
from

Conversation

nishasy
Copy link
Contributor

@nishasy nishasy commented Nov 16, 2024

Summary:

Right now, if you type "$1" into the locked label input, it
shows up as "undefined1" in the graph TeX.

  • Update the parsed content to count a lone unescaped $
    as a regular $.

Issue: https://khanacademy.atlassian.net/browse/LEMS-2591

Test plan:

yarn jest packages/perseus/src/widgets/interactive-graphs/utils.test.ts

Storybook

Demo

Screen.Recording.2024-11-15.at.5.46.21.PM.mov

Right now, if you type "$1" into the locked label input, it
shows up as "undefined1" in the graph TeX.

- Update the parsed content to count a lone unescaped $
  as a regular $.

Issue: https://khanacademy.atlassian.net/browse/LEMS-2591

Test plan:
`yarn jest packages/perseus/src/widgets/interactive-graphs/utils.test.ts`

Storybook
- Go to http://localhost:6006/?path=/story/perseuseditor-widgets-interactive-graph--interactive-graph-with-aria-label
- Create a new locked figure
- Add a label "$1" and confirm it shows up as "$1" in the preview
- Play around with different escaped and unescaped dollar signs
  and confirm they work as expected
Copy link
Contributor

github-actions bot commented Nov 16, 2024

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1875

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

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

Copy link
Contributor

github-actions bot commented Nov 16, 2024

Size Change: -264 B (-0.02%)

Total Size: 1.29 MB

Filename Size Change
packages/perseus/dist/es/index.js 424 kB -264 B (-0.06%)
ℹ️ 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

@nishasy nishasy marked this pull request as ready for review November 16, 2024 01:58
@khan-actions-bot
Copy link
Contributor

khan-actions-bot commented Nov 16, 2024

Gerald

Required Reviewers
  • @Khan/perseus for changes to .changeset/small-owls-relate.md, packages/perseus/src/widgets/interactive-graphs/interactive-graph.test.tsx, packages/perseus/src/widgets/interactive-graphs/mafs-graph.test.tsx, packages/perseus/src/widgets/interactive-graphs/utils.test.ts, packages/perseus/src/widgets/interactive-graphs/utils.ts

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

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.

LGTM!

${"$1"} | ${"\\text{\\$1}"}
${"1$"} | ${"\\text{1\\$}"}
${"$$1$"} | ${"\\text{1\\$}"}
${"$1$$"} | ${"1\\text{\\$}"}
Copy link
Member

Choose a reason for hiding this comment

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

This is a nice set of test cases :)

@nishasy nishasy marked this pull request as draft November 18, 2024 20:00
@nishasy nishasy marked this pull request as ready for review November 20, 2024 23:27
expect(screen.getByText("1/2")).toBeInTheDocument();
expect(screen.getByText("3/4")).toBeInTheDocument();
expect(screen.getByText("\\text{$1/2$}")).toBeInTheDocument();
expect(screen.getByText("\\text{$3/4$}")).toBeInTheDocument();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@anakaren-rojas I think my update affected some of your recent changes. Does this look okay to you?

Copy link
Contributor

@anakaren-rojas anakaren-rojas Nov 20, 2024

Choose a reason for hiding this comment

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

EDIT: Yes, looks good
For these, I think it would be

Copy link
Contributor

Choose a reason for hiding this comment

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

$\frac{1}{2}$ renders correctly when I test it out in storybook, so the functionality updates you made look right

Copy link
Contributor

@anakaren-rojas anakaren-rojas left a comment

Choose a reason for hiding this comment

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

Double checked the axis labels and they render correctly when I tried a few different variations of TeX 🎉

expect(screen.getByText("1/2")).toBeInTheDocument();
expect(screen.getByText("3/4")).toBeInTheDocument();
expect(screen.getByText("\\text{$1/2$}")).toBeInTheDocument();
expect(screen.getByText("\\text{$3/4$}")).toBeInTheDocument();
Copy link
Contributor

@anakaren-rojas anakaren-rojas Nov 20, 2024

Choose a reason for hiding this comment

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

EDIT: Yes, looks good
For these, I think it would be

expect(screen.getByText("1/2")).toBeInTheDocument();
expect(screen.getByText("3/4")).toBeInTheDocument();
expect(screen.getByText("\\text{$1/2$}")).toBeInTheDocument();
expect(screen.getByText("\\text{$3/4$}")).toBeInTheDocument();
Copy link
Contributor

Choose a reason for hiding this comment

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

$\frac{1}{2}$ renders correctly when I test it out in storybook, so the functionality updates you made look right

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.

5 participants