From: Michał Gołębiowski-Owczarek <m.goleb@gmail.com>
Date: Tue, 19 Sep 2023 23:29:05 +0000 (+0200)
Subject: Core: Add more info about named exports
X-Git-Tag: 4.0.0-beta~29
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=5f869590924b7dea6a16d176b18700939f4b5290;p=jquery.git

Core: Add more info about named exports

Also, fix an example importing from `jquery/src/css.js` as that is supposed
to use named exports now.

Closes gh-5328
---

diff --git a/build/fixtures/README.md b/build/fixtures/README.md
index 9e4f68913..b64c9bca5 100644
--- a/build/fixtures/README.md
+++ b/build/fixtures/README.md
@@ -21,12 +21,30 @@ Below are some of the most common ways to include jQuery.
 
 or, to use the jQuery ECMAScript module:
 
+```html
+<script type="module">
+	import { $ } from "https://code.jquery.com/jquery-@VERSION.min.js";
+</script>
+```
+
+or:
+
+```html
+<script type="module">
+	import { jQuery } from "https://code.jquery.com/jquery-@VERSION.min.js";
+</script>
+```
+
+All jQuery modules export named `$` & `jQuery` tokens; the further examples will just show `$`. The default import also works:
+
 ```html
 <script type="module">
 	import $ from "https://code.jquery.com/jquery-@VERSION.min.js";
 </script>
 ```
 
+However, named imports provide better interoperability across tooling and are therefore recommended.
+
 Sometimes you don’t need AJAX, or you prefer to use one of the many standalone libraries that focus on AJAX requests. And often it is simpler to use a combination of CSS, class manipulation or the Web Animations API. Similarly, many projects opt into relying on native browser promises instead of jQuery Deferreds. Along with the regular version of jQuery that includes the `ajax`, `callbacks`, `deferred`, `effects` & `queue` modules, we’ve released a “slim” version that excludes these modules. You can load it as a regular script:
 
 ```html
@@ -37,7 +55,7 @@ or as a module:
 
 ```html
 <script type="module">
-	import $ from "https://code.jquery.com/jquery-@VERSION.slim.min.js";
+	import { $ } from "https://code.jquery.com/jquery-@VERSION.slim.min.js";
 </script>
 ```
 
@@ -60,7 +78,7 @@ Now, the following will work to get the full version:
 
 ```html
 <script type="module">
-	import $ from "jquery";
+	import { $ } from "jquery";
 	// Use $ here
 </script>
 ```
@@ -69,7 +87,7 @@ and the following to get the slim one:
 
 ```html
 <script type="module">
-	import $ from "jquery/slim";
+	import { $ } from "jquery/slim";
 	// Use $ here
 </script>
 ```
@@ -93,7 +111,7 @@ npm install jquery
 In the script, including jQuery will usually look like this:
 
 ```js
-import $ from "jquery";
+import { $ } from "jquery";
 ```
 
 If you need to use jQuery in a file that's not an ECMAScript module, you can use the CommonJS syntax:
@@ -115,7 +133,7 @@ Remember that some modules have other dependencies (e.g. the `event` module depe
 Example usage:
 
 ```js
-import $ from "jquery/src/css.js"; // adds the `.css()` method
+import { $ } from "jquery/src/css.js"; // adds the `.css()` method
 import "jquery/src/event.js"; // adds the `.on()` method; pulls "selector" as a dependency
 $( ".toggle" ).on( "click", function() {
 	$( this ).css( "color", "red" );