Docs: Add information about polyfills for each package that needs them

WordPress · Aug 24, 2018 · 70d46ad · 70d46ad
1 parent 9d62bc7
commit 70d46ad
Show file tree

Hide file tree

Showing 64 changed files with 564 additions and 481 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -141,7 +141,7 @@ When creating a new package you need to provide at least the following:
 		"module": "build-module/index.js",
 		"react-native": "src/index",
 		"dependencies": {
-			"@babel/runtime-corejs2": "7.0.0-beta.56"
+			"@babel/runtime-corejs2": "7.0.0-rc.2"
 		},
 		"publishConfig": {
 			"access": "public"

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -58,8 +58,8 @@
 		"rememo": "3.0.0"
 	},
 	"devDependencies": {
-		"@babel/core": "7.0.0-rc.1",
-		"@babel/runtime-corejs2": "7.0.0-rc.1",
+		"@babel/core": "7.0.0-rc.2",
+		"@babel/runtime-corejs2": "7.0.0-rc.2",
 		"@wordpress/babel-plugin-import-jsx-pragma": "file:packages/babel-plugin-import-jsx-pragma",
 		"@wordpress/babel-plugin-makepot": "file:packages/babel-plugin-makepot",
 		"@wordpress/babel-preset-default": "file:packages/babel-preset-default",

diff --git a/packages/a11y/README.md b/packages/a11y/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/a11y --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## speak
 
 Allows you to easily announce dynamic interface updates to screen readers using ARIA live regions. This module is inspired by the `speak` function in wp-a11y.js

diff --git a/packages/a11y/package.json b/packages/a11y/package.json
@@ -21,7 +21,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/dom-ready": "file:../dom-ready"
 	},
 	"publishConfig": {

diff --git a/packages/api-fetch/README.md b/packages/api-fetch/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/api-fetch --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Usage
 
 ```js

diff --git a/packages/api-fetch/package.json b/packages/api-fetch/package.json
@@ -20,7 +20,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/hooks": "file:../hooks",
 		"@wordpress/i18n": "file:../i18n"
 	},

diff --git a/packages/autop/README.md b/packages/autop/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/autop --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ### Usage
 
 Import the desired function(s) from `@wordpress/autop`:

diff --git a/packages/autop/package.json b/packages/autop/package.json
@@ -19,7 +19,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1"
+		"@babel/runtime": "7.0.0-rc.2"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/babel-plugin-import-jsx-pragma/package.json b/packages/babel-plugin-import-jsx-pragma/package.json
@@ -26,14 +26,14 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1"
+		"@babel/runtime": "7.0.0-rc.2"
 	},
 	"devDependencies": {
-		"@babel/core": "7.0.0-rc.1",
-		"@babel/plugin-syntax-jsx": "7.0.0-rc.1"
+		"@babel/core": "7.0.0-rc.2",
+		"@babel/plugin-syntax-jsx": "7.0.0-rc.2"
 	},
 	"peerDependencies": {
-		"@babel/core": "7.0.0-rc.1"
+		"@babel/core": "7.0.0-rc.2"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/babel-plugin-makepot/package.json b/packages/babel-plugin-makepot/package.json
@@ -25,16 +25,16 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"gettext-parser": "^1.3.1",
 		"lodash": "^4.17.10"
 	},
 	"devDependencies": {
-		"@babel/core": "7.0.0-rc.1",
-		"@babel/traverse": "7.0.0-rc.1"
+		"@babel/core": "7.0.0-rc.2",
+		"@babel/traverse": "7.0.0-rc.2"
 	},
 	"peerDependencies": {
-		"@babel/core": "7.0.0-rc.1"
+		"@babel/core": "7.0.0-rc.2"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/babel-preset-default/package.json b/packages/babel-preset-default/package.json
@@ -23,17 +23,17 @@
 	},
 	"main": "index.js",
 	"dependencies": {
-		"@babel/plugin-proposal-async-generator-functions": "7.0.0-rc.1",
-		"@babel/plugin-proposal-object-rest-spread": "7.0.0-rc.1",
-		"@babel/plugin-transform-react-jsx": "7.0.0-rc.1",
-		"@babel/plugin-transform-runtime": "7.0.0-rc.1",
-		"@babel/preset-env": "7.0.0-rc.1",
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/plugin-proposal-async-generator-functions": "7.0.0-rc.2",
+		"@babel/plugin-proposal-object-rest-spread": "7.0.0-rc.2",
+		"@babel/plugin-transform-react-jsx": "7.0.0-rc.2",
+		"@babel/plugin-transform-runtime": "7.0.0-rc.2",
+		"@babel/preset-env": "7.0.0-rc.2",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/browserslist-config": "file:../browserslist-config",
 		"babel-core": "^7.0.0-bridge.0"
 	},
 	"peerDependencies": {
-		"@babel/core": "^7.0.0-rc.1"
+		"@babel/core": "^7.0.0-rc.2"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/blob/package.json b/packages/blob/package.json
@@ -19,7 +19,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1"
+		"@babel/runtime": "7.0.0-rc.2"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/block-library/README.md b/packages/block-library/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/block-library --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Usage
 
 ```js

diff --git a/packages/block-library/package.json b/packages/block-library/package.json
@@ -20,7 +20,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/api-fetch": "file:../api-fetch",
 		"@wordpress/autop": "file:../autop",
 		"@wordpress/blob": "file:../blob",

diff --git a/packages/blocks/README.md b/packages/blocks/README.md
@@ -14,6 +14,16 @@ blog.
 The following documentation outlines steps you as a developer will need to
 follow to add your own custom blocks to WordPress's editor interfaces.
 
+## Installation
+
+Install the module
+
+```bash
+npm install @wordpress/bocks --save
+```
+
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Getting Started
 
 If you're not already accustomed to working with JavaScript in your WordPress

diff --git a/packages/blocks/package.json b/packages/blocks/package.json
@@ -20,7 +20,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/autop": "file:../autop",
 		"@wordpress/blob": "file:../blob",
 		"@wordpress/block-serialization-spec-parser": "file:../block-serialization-spec-parser",

diff --git a/packages/components/README.md b/packages/components/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/components --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Usage
 
 Within Gutenberg, these components can be accessed by importing from the `components` root directory:

diff --git a/packages/components/package.json b/packages/components/package.json
@@ -20,7 +20,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/a11y": "file:../a11y",
 		"@wordpress/api-fetch": "file:../api-fetch",
 		"@wordpress/compose": "file:../compose",

diff --git a/packages/compose/README.md b/packages/compose/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/compose --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Usage
 
 ```js

diff --git a/packages/compose/package.json b/packages/compose/package.json
@@ -21,7 +21,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/element": "file:../element",
 		"@wordpress/is-shallow-equal": "file:../is-shallow-equal",
 		"lodash": "^4.17.10"

diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -12,6 +12,8 @@ Install the module
 npm install @wordpress/core-data --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Example
 
 Below is an example of a component which simply renders a list of authors:

diff --git a/packages/core-data/package.json b/packages/core-data/package.json
@@ -21,7 +21,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/api-fetch": "file:../api-fetch",
 		"@wordpress/data": "file:../data",
 		"@wordpress/url": "file:../url",

diff --git a/packages/custom-templated-path-webpack-plugin/package.json b/packages/custom-templated-path-webpack-plugin/package.json
@@ -24,7 +24,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"escape-string-regexp": "^1.0.5"
 	},
 	"devDependencies": {

diff --git a/packages/data/README.md b/packages/data/README.md
@@ -12,6 +12,8 @@ Install the module
 npm install @wordpress/data --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Registering a Store
 
 Use the `registerStore` function to add your own store to the centralized data registry. This function accepts two arguments: a name to identify the module, and an object with values describing how your state is represented, modified, and accessed. At a minimum, you must provide a reducer function describing the shape of your state and how it changes in response to actions dispatched to the store.

diff --git a/packages/data/package.json b/packages/data/package.json
@@ -21,7 +21,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/compose": "file:../compose",
 		"@wordpress/deprecated": "file:../deprecated",
 		"@wordpress/element": "file:../element",

diff --git a/packages/date/README.md b/packages/date/README.md
@@ -10,4 +10,6 @@ Install the module
 npm install @wordpress/date --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
diff --git a/packages/date/package.json b/packages/date/package.json
@@ -19,7 +19,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"moment": "^2.22.1",
 		"moment-timezone": "^0.5.16"
 	},

diff --git a/packages/deprecated/README.md b/packages/deprecated/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/deprecated --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Usage
 
 ```js

diff --git a/packages/deprecated/package.json b/packages/deprecated/package.json
@@ -19,7 +19,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1"
+		"@babel/runtime": "7.0.0-rc.2"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/dom-ready/README.md b/packages/dom-ready/README.md
@@ -10,6 +10,8 @@ Install the module
 npm install @wordpress/dom-ready --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ### Usage
 
 ```JS

diff --git a/packages/dom-ready/package.json b/packages/dom-ready/package.json
@@ -19,7 +19,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1"
+		"@babel/runtime": "7.0.0-rc.2"
 	},
 	"publishConfig": {
 		"access": "public"

diff --git a/packages/dom/package.json b/packages/dom/package.json
@@ -20,7 +20,7 @@
 	"main": "build/index.js",
 	"module": "build-module/index.js",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"element-closest": "^2.0.2",
 		"lodash": "^4.17.10"
 	},

diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -1,5 +1,19 @@
 # Editor
 
+Building blocks for WordPress editors.
+
+## Installation
+
+Install the module
+
+```bash
+npm install @wordpress/editor --save
+```
+
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
+## How it works
+
 The logic flow concerning the editor includes: inferring a block representation of the post content (parsing); describing the state of a post (representation); rendering of the post to the DOM (rendering); attaching controls to manipulate the content a.k.a blocks (UI).
 
 ![Diagram](https://docs.google.com/drawings/d/1iuownt5etcih7rMMvPvh0Mny8zUA1Z28saxjxaWmfJ0/pub?w=1234&h=453)

diff --git a/packages/editor/package.json b/packages/editor/package.json
@@ -20,7 +20,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"@wordpress/a11y": "file:../a11y",
 		"@wordpress/api-fetch": "file:../api-fetch",
 		"@wordpress/blob": "file:../blob",

diff --git a/packages/element/README.md b/packages/element/README.md
@@ -21,6 +21,8 @@ Install the module
 npm install @wordpress/element --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ## Usage
 
 Let's render a customized greeting into an empty element:

diff --git a/packages/element/package.json b/packages/element/package.json
@@ -21,7 +21,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"dependencies": {
-		"@babel/runtime": "7.0.0-rc.1",
+		"@babel/runtime": "7.0.0-rc.2",
 		"lodash": "^4.17.10",
 		"react": "^16.4.1",
 		"react-dom": "^16.4.1"

diff --git a/packages/hooks/README.md b/packages/hooks/README.md
@@ -10,7 +10,10 @@ Install the module
 npm install @wordpress/hooks --save
 ```
 
+_This package assumes that your code will run in an ES5 environment. If you're using an environment that has limited or no support for ES5 such as lower versions of IE then using [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
 ### Usage
+
 In your JavaScript project, use hooks as follows:
 ```javascript
 import { createHooks } from '@wordpress/hooks';