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(aria): avoid throwing error in SSR mode #19892

Merged
merged 2 commits into from
May 6, 2024

Conversation

OverflowCat
Copy link
Contributor

Brief Information

This pull request is in the type of:

  • bug fixing
  • new feature
  • others

What does this PR do?

Skip setting aria label attribute when in SSR mode.

Fixed issues

#19191: [Bug] SVG ARIA doesn’t work with SSR

Details

Before: What was the problem?

aria-label was set on the DOM element, but in SSR there is no DOM element, so it would throw when enabling aria or locals in options when using SSR, because the dom variable in code is null.

Also, this makes the last example in this release note (Two color locals) not working in SSR.

html demo

After: How does it behave after the fixing?

No aria label was added, but locals are working in SSR.

Document Info

One of the following should be checked.

  • This PR doesn't relate to document changes
  • The document should be updated later
  • The document changes have been made in apache/echarts-doc#xxx

Misc

ZRender Changes

  • This PR depends on ZRender changes (ecomfe/zrender#xxx).

Related test cases or examples to use the new APIs

N.A.

Others

Merging options

  • Please squash the commits into a single one when merging.

Other information

Copy link

echarts-bot bot commented May 4, 2024

Thanks for your contribution!
The community will review it ASAP. In the meanwhile, please checkout the coding standard and Wiki about How to make a pull request.

plainheart
plainheart previously approved these changes May 6, 2024
Copy link
Member

@plainheart plainheart left a comment

Choose a reason for hiding this comment

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

I will approve this PR as a temporary NPE fix. But we still need to support ARIA for SSR mode in the future.

@plainheart plainheart added this to the 5.5.1 milestone May 6, 2024
@plainheart plainheart changed the title fix: aria throws error in SSR (#19191) fix(aria): avoid throwing error in SSR mode (#19191) May 6, 2024
Copy link
Contributor

github-actions bot commented May 6, 2024

The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-19892@872ac99

@plainheart plainheart merged commit 832cc51 into apache:master May 6, 2024
2 checks passed
Copy link

echarts-bot bot commented May 6, 2024

Congratulations! Your PR has been merged. Thanks for your contribution! 👍

@plainheart plainheart changed the title fix(aria): avoid throwing error in SSR mode (#19191) fix(aria): avoid throwing error in SSR mode May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants