Docs: Add available script handles #10510

ajitbohra · 2018-10-11T12:37:05Z

Doc all available script handles under References > Scripts

chrisvanpatten

Great idea for the handbook! Left some grammar notes and questions.

chrisvanpatten · 2018-10-11T12:40:52Z

docs/reference/scripts.md

@@ -0,0 +1,60 @@
+# Scripts
+
+Editor provides several vendor and custom script to plugin developers. Script name, handle and usage are mentioned in below table. 


Small rewrite on this:

The editor provides several vendor and internal scripts to plugin developers. Script names, handles, and descriptions are documented in the table below.

chrisvanpatten · 2018-10-11T12:42:09Z

docs/reference/scripts.md

+
+## WP Scripts
+
+Editor includes number of custom scripts to enable various funcationality and utilities. Plugin developers can utilize them to create blocks, editor plugins or generic plugings utilizing them. All the avilable scripts are listed in below table. 


The editor includes a number of packages to enable various pieces of functionality. Plugin developers can utilize them to create blocks, editor plugins, or generic plugins.

Slightly simpler this way :)

docs/reference/scripts.md

chrisvanpatten · 2018-10-11T12:44:12Z

docs/reference/scripts.md

+
+## Vendor Script
+
+By default, editor includes some popular scripts commonly used by web developers and editor itself. All of them are listed in the table below. Plugin developers can utilize these scripts without adding up to bundle size


The editor also uses some popular third-party packages and scripts. Plugin developers can use these scripts as well without bundling them in their code (and increasing file sizes).

chrisvanpatten · 2018-10-11T12:44:28Z

docs/reference/scripts.md

+| [Formdata Polyfill](https://www.npmjs.com/package/formdata-polyfill) | wp-polyfill-formdata| Polyfill conditionally replaces the native implementation |
+| [Node Contains Polyfill](https://polyfill.io) | wp-polyfill-node-contains |Polyfill for Node.contains |
+| [Element Closest Polyfill](https://www.npmjs.com/package/element-closest) | wp-polyfill-element-closest| Return the closest element matching a selector up the DOM tree |
+| [Ecmascript Polyfill](https://babeljs.io/docs/en/babel-polyfill) | wp-polyfill-ecmascript | Emulate a full ES2015+ environment |


I think this should probably be ECMAScript

chrisvanpatten · 2018-10-11T12:44:55Z

docs/reference/scripts.md

+| [React](https://reactjs.org) | react  | React is a JavaScript library for building user interfaces |
+| [React Dom](https://reactjs.org/docs/react-dom.html) | react-dom | Serves as the entry point to the DOM and server renderers for React, intended to be paired with React |	
+| [Moment](https://momentjs.com/) | moment| Parse, validate, manipulate, and display dates and times in JavaScript |
+| [Tinymce Lists](https://www.tiny.cloud/docs/plugins/lists/) | tinymce-latest-lists| The `lists` plugin allows you to add numbered and bulleted lists to TinyMC |


TinyMCE is capitalised wrong at the start here, and misspelled at the end :)

docs/reference/scripts.md

ajitbohra · 2018-10-11T13:20:08Z

@chrisvanpatten thanks for the quick review have updated copy & typos :)

chrisvanpatten · 2018-10-11T13:24:59Z

@ajitbohra Looks great!

I think my only reservation would be to get polyfills their own section, especially if they're things that users won't have to actively engage with. (I think most of them are just automatic, right? Except maybe the ES5 polyfill which works with babel, yes?)

chrisvanpatten

One small thing, then I think we're good 👍 Thanks @ajitbohra!

chrisvanpatten · 2018-10-11T19:57:28Z

docs/reference/scripts.md

+
+## Polyfill Scripts
+
+The editor also uses some polyfill for compatibility with major browsers.


The editor also provides polyfills for certain features that may not be available in all modern browsers.

Small change on this that also tries to address what a polyfill is.

ajitbohra · 2018-10-12T12:08:12Z

@chrisvanpatten polyfill description updated 👍

chrisvanpatten

👍 LGTM!

aduth · 2018-10-12T12:58:35Z

docs/manifest.json

@@ -245,6 +245,12 @@
 		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/packages.md",
 		"parent": null
 	},
+	{


I think this is meant to be added to root-manifest.json. There are local changes on master (removing this) when running npm run docs:build.

my bad you are right needs to be added to root-manifest.json.

What's the difference between the two, just so I understand for the future?

The root-manifest.json file contains all markdown files from the /docs folder. The npm run docs:build command generates the manifest.json file from the root-manifest.json file and adds docs from packages, data and components to it.

Maybe we should document it somewhere...

Soean · 2018-10-12T14:35:31Z

Here it is: https://wordpress.org/gutenberg/handbook/reference/scripts/

docs/reference/scripts.md

gziolo · 2018-10-12T19:44:27Z

Nice work! Thanks for wrangling it 👍

Did we miss wp-polyfill?

ajitbohra · 2018-10-15T11:16:14Z

all wp-polyfill scripts are grouped in a separate section here https://github.com/WordPress/gutenberg/blob/master/docs/reference/scripts.md#polyfill-scripts

let me know if we have missed any thing ?

gziolo · 2018-10-15T11:33:49Z

all wp-polyfill scripts are grouped in a separate section here

Yes, but we also expose wp-polyfill as a script your code can depend on.

ajitbohra · 2018-10-15T11:56:55Z

can you help me with some info, i guess its here

gutenberg/lib/client-assets.php

Line 102 in 45bc8e4

wp_register_script(

wp-polyfill seems to be aliases to wp-polyfill-ecmascript and loads various polyfills.

Where should we add this under polyfill section or under main WP Scripts section ?

gziolo · 2018-10-15T12:02:47Z

https://github.com/WordPress/gutenberg/blob/6da6d69fee01e0e38828f4ac20ea5a8ad72a5ca4/docs/reference/scripts.md#polyfill-scripts

Inside Polyfill scripts, I think. Yes, it groups them together. /cc @aduth

aduth · 2018-10-15T13:01:13Z

As mentioned in some previous #core-js meetings, we can look to encourage wp-polyfill as the single simple entry-point for developers to reference as a dependency. We could potentially emphasize this in the docs. Otherwise, I think it's fine to include in the "Polyfill" section.

ajitbohra · 2018-10-17T16:35:56Z

Missing wp-polyfill added with a recommendation to use it over individual polyfills #10694

Docs: Add available script handles

cac0308

ajitbohra requested review from tofumatt, youknowriad and aduth October 11, 2018 12:37

chrisvanpatten suggested changes Oct 11, 2018

View reviewed changes

chrisvanpatten added [Type] Enhancement A suggestion for improvement. [Type] Developer Documentation Documentation for developers labels Oct 11, 2018

Fix: Copy

a52eaa9

ajitbohra mentioned this pull request Oct 11, 2018

Docs: Improve packages readme #10527

Closed

92 tasks

Fix: Seperate polyfill into new section

07e52b8

chrisvanpatten suggested changes Oct 11, 2018

View reviewed changes

Docs: Update polyfill description copy

6da6d69

chrisvanpatten approved these changes Oct 12, 2018

View reviewed changes

ajitbohra added this to the 4.1 milestone Oct 12, 2018

ajitbohra merged commit e950522 into master Oct 12, 2018

ajitbohra deleted the add/docs-script-handlers branch October 12, 2018 12:23

aduth reviewed Oct 12, 2018

View reviewed changes

aduth mentioned this pull request Oct 12, 2018

Fix docs manifest #10555

Merged

aduth mentioned this pull request Oct 12, 2018

Testing: Fail CI build if local changes exist #10234

Merged

gziolo reviewed Oct 12, 2018

View reviewed changes

docs/reference/scripts.md Show resolved Hide resolved

ajitbohra mentioned this pull request Oct 17, 2018

Add wp-polyfill to scripts.md #10694

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Add available script handles #10510

Docs: Add available script handles #10510

ajitbohra commented Oct 11, 2018 •

edited

Loading

chrisvanpatten left a comment

chrisvanpatten Oct 11, 2018 •

edited

Loading

chrisvanpatten Oct 11, 2018

chrisvanpatten Oct 11, 2018

chrisvanpatten Oct 11, 2018

chrisvanpatten Oct 11, 2018

ajitbohra commented Oct 11, 2018

chrisvanpatten commented Oct 11, 2018

chrisvanpatten left a comment

chrisvanpatten Oct 11, 2018

ajitbohra commented Oct 12, 2018

chrisvanpatten left a comment

aduth Oct 12, 2018

ajitbohra Oct 12, 2018

chrisvanpatten Oct 12, 2018

Soean Oct 12, 2018 •

edited

Loading

Soean commented Oct 12, 2018

gziolo commented Oct 12, 2018

ajitbohra commented Oct 15, 2018

gziolo commented Oct 15, 2018

ajitbohra commented Oct 15, 2018

gziolo commented Oct 15, 2018

aduth commented Oct 15, 2018

ajitbohra commented Oct 17, 2018 •

edited

Loading

		@@ -0,0 +1,60 @@
		# Scripts

		Editor provides several vendor and custom script to plugin developers. Script name, handle and usage are mentioned in below table.


		## WP Scripts

		Editor includes number of custom scripts to enable various funcationality and utilities. Plugin developers can utilize them to create blocks, editor plugins or generic plugings utilizing them. All the avilable scripts are listed in below table.


		## Vendor Script

		By default, editor includes some popular scripts commonly used by web developers and editor itself. All of them are listed in the table below. Plugin developers can utilize these scripts without adding up to bundle size


		## Polyfill Scripts

		The editor also uses some polyfill for compatibility with major browsers.

Docs: Add available script handles #10510

Docs: Add available script handles #10510

Conversation

ajitbohra commented Oct 11, 2018 • edited Loading

chrisvanpatten left a comment

Choose a reason for hiding this comment

chrisvanpatten Oct 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajitbohra commented Oct 11, 2018

chrisvanpatten commented Oct 11, 2018

chrisvanpatten left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajitbohra commented Oct 12, 2018

chrisvanpatten left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Soean Oct 12, 2018 • edited Loading

Choose a reason for hiding this comment

Soean commented Oct 12, 2018

gziolo commented Oct 12, 2018

ajitbohra commented Oct 15, 2018

gziolo commented Oct 15, 2018

ajitbohra commented Oct 15, 2018

gziolo commented Oct 15, 2018

aduth commented Oct 15, 2018

ajitbohra commented Oct 17, 2018 • edited Loading

ajitbohra commented Oct 11, 2018 •

edited

Loading

chrisvanpatten Oct 11, 2018 •

edited

Loading

Soean Oct 12, 2018 •

edited

Loading

ajitbohra commented Oct 17, 2018 •

edited

Loading