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

Remove dart:html page #6345

Merged
merged 10 commits into from
Jan 22, 2025
Merged

Remove dart:html page #6345

merged 10 commits into from
Jan 22, 2025

Conversation

MaryaBelanger
Copy link
Contributor

@MaryaBelanger MaryaBelanger commented Jan 21, 2025

  • Removed dart:html page from sidenav
  • Removed dart:html from libraries overview page
    • Replaced with dart:js_interop
  • Add prev/next to js interop pages
    • (so the js interop overview page will lead to the rest of the js content, even from its place in the libraries section)

Fixes #6314

@dart-github-bot
Copy link
Collaborator

dart-github-bot commented Jan 21, 2025

Visit the preview URL for this PR (updated for commit 0253bae):

https://dart-dev--pr6345-rm-html-0n7vheaq.web.app

@MaryaBelanger
Copy link
Contributor Author

@parlough So I removed the dart:html page from the side nav, but didn't address the redirects: one in firebase.json, many in library-tour-redirector.js. I wasn't sure what to do, especially with the latter, because it's pointing to specific sections on the dart:html page that don't necessarily have equivalents on the package:web page. Should we address that or is it safe to leave it alone?

@MaryaBelanger
Copy link
Contributor Author

MaryaBelanger commented Jan 21, 2025

@srujzs Can you advise on the deprecation wording I left in a couple places:

  • On the libraries Overview page
     dart:js_interop
         DOM and other APIs for browser-based apps. dart:js_interop replaces dart:html.
    
  • And on the dart:html page (which still exists but won't be discoverable):
     The dart:html library is deprecated. Instead, use dart:js_interop or package:web.
    

I'm mostly wondering if I should say "dart:js_interop and package:web replace dart:html"? Or does the former imply the latter? Is "replace" the right word, or should we be saying more?

Edit: Another I just added:

  • On the Overview page:
    * HTML elements and other resources for web-based applications that need to
    interact with the browser and the Document Object Model (DOM)
    (`dart:js_interop` and `package:web`)
    

@parlough
Copy link
Member

@parlough So I removed the dart:html page from the side nav, but didn't address the redirects: one in firebase.json, many in library-tour-redirector.js. I wasn't sure what to do, especially with the latter, because it's pointing to specific sections on the dart:html page that don't necessarily have equivalents on the package:web page. Should we address that or is it safe to leave it alone?

+1 Good idea to remove it from the sidenav and keep it around for now :)

I think it's safe to leave library-tour-redirector.js alone. It's handling old, outdated links and we'll eventually remove it.

As for the existing redirects in firebase.json, consider updating them to point the package:web page?

Copy link
Member

@parlough parlough left a comment

Choose a reason for hiding this comment

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

Thanks Marya! Just a few small suggestions to consider.


Continuing our long good bye of dart:html 👋 🥹

src/content/libraries/index.md Outdated Show resolved Hide resolved
src/content/libraries/dart-html.md Outdated Show resolved Hide resolved
src/content/language/libraries.md Outdated Show resolved Hide resolved
firebase.json Outdated Show resolved Hide resolved
src/content/interop/js-interop/index.md Show resolved Hide resolved
@MaryaBelanger MaryaBelanger requested a review from srujzs January 21, 2025 22:19
@srujzs
Copy link
Contributor

srujzs commented Jan 22, 2025

"dart:js_interop and package:web replace dart:html"

I prefer this. While it's true dart:js_interop/_unsafe is the only interop mechanism users can or should use anymore, the natural question will be "where are all the browser APIs?" :).

Copy link
Contributor

@srujzs srujzs left a comment

Choose a reason for hiding this comment

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

Thanks Marya!

src/content/libraries/dart-html.md Show resolved Hide resolved
@MaryaBelanger MaryaBelanger merged commit 9b3d96a into main Jan 22, 2025
9 of 10 checks passed
@MaryaBelanger MaryaBelanger deleted the rm-html branch January 22, 2025 19:41
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.

Remove dart:html page from the overview and libraries section
4 participants