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

Fixed issue in EditorStartup.init() where $qq will not work if the editor is in a Web Component #1028

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

Conversation

mscherotter
Copy link
Contributor

@mscherotter mscherotter commented Mar 2, 2025

PR description

in EditorStartup init(),
this.$svgEditor = $qq('.svg_editor')
will return undefined if the editor is in a web component, Changing the line to
this.$svgEditor = this.$container.querySelector('.svg_editor')
will make the code work whether it is in a web component or not.

Checklist

Note that we require UI tests to ensure that the added feature will not be
nixed by some future fix and that there is at least some test-as-documentation
to indicate how the fix or enhancement is expected to behave.

  • - Added Cypress UI tests
  • - Ran npm test, ensuring linting passes and that Cypress UI tests keep
    coverage to at least the same percent (reflected in the coverage badge
    that should be updated after the tests run)
  • - Added any user documentation. Though not required, this can be a big
    help both for future users and for the PR reviewer.

Copy link

sourcery-ai bot commented Mar 2, 2025

Reviewer's Guide by Sourcery

This pull request addresses an issue where the $qq selector in EditorStartup.init() fails when the editor is within a Web Component. It replaces the selector with this.$container.querySelector('.svg_editor') to ensure compatibility. Additionally, it enhances accessibility by adding alt attributes to img elements and modifies the shadow DOM mode of the SESpinInput component to closed.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Modified the shadow DOM mode of the SESpinInput component to closed.
  • Changed mode from open to closed in this.attachShadow().
src/editor/components/seSpinInput.js
Added alt attributes to img elements for accessibility.
  • Added alt='No color' to the img element in SEPalette component.
  • Added alt='Zoom dropdown' to the img element in seZoom component.
  • Added alt='logo' to the img element in SeMenu component.
src/editor/components/sePalette.js
src/editor/components/seZoom.js
src/editor/components/seMenu.js
Modified the way the $svgEditor element is selected in the EditorStartup class to ensure compatibility with Web Components.
  • Replaced $qq('.svg_editor') with this.$container.querySelector('.svg_editor').
src/editor/EditorStartup.js

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @mscherotter - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Good job adding alt attributes to the img elements.
  • Consider using const instead of let for variables that are not reassigned after initialization.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Collaborator

@jfhenon jfhenon left a comment

Choose a reason for hiding this comment

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

need to check linter issue

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.

2 participants