-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Bundle the icons package instead of using it as an external #19809
Conversation
f1df223
to
a5e0740
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 I reviewed the webpack changes and they make sense (with one correction). I have not manually tested.
If you'd like to test this, you could add an import of @wordpress/icons
to the tests, maybe here:
gutenberg/packages/dependency-extraction-webpack-plugin/test/fixtures/with-externs/index.js
Lines 4 to 5 in 1f3ea11
import { isBlobURL } from '@wordpress/blob'; | |
import { isURL } from '@wordpress/url'; |
@@ -1,4 +1,5 @@ | |||
const WORDPRESS_NAMESPACE = '@wordpress/'; | |||
const BUNDLED_PACKAGES = '@wordpress/icons'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you meant to use an array of packages here:
const BUNDLED_PACKAGES = '@wordpress/icons'; | |
const BUNDLED_PACKAGES = [ '@wordpress/icons' ]; |
This seems to only be relevant for packages in the @wordpress
namespace (if we want to bundle other packages, they wouldn't be included below). We might lest those and handle them as needed:
const BUNDLED_PACKAGES = '@wordpress/icons'; | |
const BUNDLED_PACKAGES = [ 'icons' ]; |
and changes below would become:
if ( request.startsWith( WORDPRESS_NAMESPACE ) ) {
const packageName = request.substring( WORDPRESS_NAMESPACE.length );
if ( BUNDLED_PACKAGES.includes( packageName ) ) {
return undefined;
}
return [ 'wp', camelCaseDash( packageName ) ];
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might trip any package that has the word icons
in it.
Co-Authored-By: Jon Surrell <[email protected]>
Hey folks! Is there any chance we could move away from SVG-in-JS for the icons, and instead adopt an SVG spritemap approach, like what is currently being done in Calypso for (at least; maybe there are others) gridicons and material-icons? Tree-shaken JS is obviously better than including a full bundle of icons, but it's still SVG data encoded as JS. JS bytes are much more work for the browser than image bytes, as the latter go through fewer steps, and easier ones at that. Besides the image decoding and rendering (which needs to happen in both cases), a JS-encoded image still has to go through JS parsing, JS compilation, and JS execution. In addition, unless care is specifically taken, this JS will end up being critical to the bundle it's included in. That is, the rest of the code will not execute until the image data JS is parsed, compiled, and executed as well. When using an external image resource, the browser will continue execution as normal and fill in the blank space when the resource finishes loading. In general, browsers have a number of heuristics and hardcoded optimisations around resource prioritisation, but when an image is encoded in JS and treated as other code, they cannot be made use of. An SVG spritemap approach is a good middle ground between using individual SVG files for everything (harder to maintain, potentially too many connections, but extremely cacheable) and embedding SVGs directly (no cacheability, but no extra connections either). It's a single SVG file containing all icons, and they are referenced through a SVG spritemaps are easy to generate, and could easily be kept up to date in clients with a build-time cache-busting mechanism that hashes the file and includes the hash in the filename, as we currently do with all static external resources in Calypso. I'm happy to help everyone with implementing this approach if that helps! |
Here's an example of what making use of an external spritemap in a React component looks like: return (
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
className={ iconClass }
height={ size }
width={ size }
onClick={ onClick }
{ ...otherProps }
>
<use xlinkHref={ `/public/the-sprite-map.svg#${ iconName }` } />
</svg>
); |
@sgomes Right now in Gutenberg, we're in a very bad state where icons are all over the place and that icons package move us to a better solution. An SVG sprite sounds like an interesting solution for the most commonly used icons in WordPress but one of the goals as well is to be able to provide thousands of consistent icons to third-party block authors. Unless, I'm mistaken we don't want third-party block authors to load the entire set when they use just a custom icon for their block, so a tree-shaking based approach is needed any way I think. |
@youknowriad Thank you for the explanation! I'm not sure I follow, however. Presumably, these third-party blocks will run in the Gutenberg environment, so if the full set of icons were already being loaded as an external resource by Gutenberg itself, that would actually be a great saving for third-party blocks, as they wouldn't incur any extra costs. Perhaps I'm missing some context? |
Do you think loading the whole sprite of say 2000 of icons is reasonable while only 100 are used? Third party blocks will pick one or two icons and Core will use a hundred (random numbers) |
One of the ideas is to make available the entirety of the Material icon set for developers to use any or multiple of the icons there: https://material.io/resources/icons/?style=outline (that's 4200+ icons, and while will probably not include all of them, the point is to provide a set that is so vast that no developer should have to look elsewhere, or need to reuse an existing icon because no alternative exists) In that hypothetical, a subset of those icons would then be redrawn in the style explored in #18667, those are likely the ones that would be included. Note also that as of writing, we are still supporting IE11, which I believe is not able to use spritesheets and recolor the icons also. |
@sgomes, thanks for sharing this very interesting idea. I have two questions:
|
I'm not able to estimate that very easily based on number of icons, I'm afraid, as the key thing would be file size and compressibility. I would expect a large spritemap to compress very well (lots of repeated textual data), which may well be an improvement over the tree-shaken SVG-in-JS approach by itself. Beyond that, we need to look at cacheability and the compound effect in bytes over time that it produces. In a project like Calypso, JS changes much more frequently than image resources, with JS bundles being deployed multiple times a day. I don't know how things are on the Gutenberg side of things in that regard, but every time a new JS bundle is deployed, you're essentially causing all users to redownload all of the image resources in that bundle, since the whole bundle gets invalidated. I'm happy to collaborate in getting some actual estimates if you're interested! |
I just edited in my comment, but should have probably commented instead. Looking at https://github.com/google/material-design-icons there are more than 4200 SVG icons. While downloading a zip file of that repository is in no way an accurate representation of cacheability and resulting filesize, but for what it's worth the zip file is 64mb. |
It is, through the |
I think we should think of this in WP scale. Basically on each WordPress release, I expect the JS to change, but I also expect at least one icon to be added or changed. That said, I agree that it's better addressed with actual numbers but I don't want to start with a sprite because it's a public API we won't be able to change later, while a bundled module is something we can break and change at any moment. So I'm thinking we should start with a bundled module, add as much icons as we want and we start evaluating. how's that sound? |
Using an SVG spritemap is a simple as referencing it externally. You create an SVG in your site (in vanilla HTML, React, or whatever you're using) that includes a The resulting SVG can be styled normally, as long as you're styling the whole thing, and not styling specific elements inside the icon (in that case, you can't do it with an external resource). That said, I don't think that use-case comes up very often in an icon library, as it's sort of a violation of abstraction, and would require you to know the internals of icons.
What most icon projects tend to do is to ship both the individual SVGs and a generated spritemap, and sometimes other formats too, like pre-rendered PNGs. Consumers can then make use of what works best for them. The icon project can set up a build process that does this automatically as part of deploying a new version, for example. Gridicons is a good example. |
The material icons documentation states:
This is for the use-case where a known subset of icons is being used, and can be optimised by the consumer. In cases where the subset of icons to be used is unknown, and the consumer may want all of them, they have prepared per-category spritemaps in https://github.com/google/material-design-icons/tree/master/sprites/svg-sprite Those files come to a total of around 160KB when gzipped. This would be a perfectly reasonable size for an external image resource. And of course, the same approach of doing it per-category could be maintained for greater granularity and an overall smaller download. |
@sgomes I like the initiative but I think we need to shift the way we’re looking at this, while you’re trying to handle this as a project using icons, that is, all the icons you’re bundling will be used, we should shift it to a library (think FontAwesome, Material Icons...) kind of problem, 160kb of gizipped icons is still a lot, Icons use cases are not limited to inside the editor, some projects share icons between the frontend and the editor, a great motivator for this package is to enable people to insert icons and use them on the frontend. 4000 might compress, but what if we want to offer 8000, or 16000 icon. Granted, your solution can somehow be placed on top of this package, as in, a plugin developer can select all the icons he needs from this package and implement a sprint to be used in his plugin, but I don’t see a way for this package to be presented that way. |
Ah, sorry, I didn't realise this was in its early stages. I assumed you were looking at tree-shaking as a way of moving closer to being production-ready, not as part of a more experimental stage. Yes, please consider my advice only in the context of making a production-ready project 🙂 |
Once again, I may be misunderstanding the wider context and constraints you're working with, so yes, please do take any suggestions of mine with a grain of salt 🙂 As I see it, a library of icons is possible and compatible with multiple approaches. As is a generic React component that makes use of it. A library can be split up in categories if it gets too large. This is the approach that material icons takes. It can be packaged as individual icons, pre-rendered images, svg spritemaps, or a combination of all of them. Which is also what material icons does. These resources can be distributed as npm packages, ZIP files, or hosted on a CDN depending on developer needs. As for a generic icon component, it could have two props: one for the stylesheet location, and one for the icon name inside said stylesheet. This would make it easily extensible, with a developer being able to point to icons from library A, library B, or their own set. These are just ideas, and I'm not sure how well they fit into the constraints of WordPress as a project, Gutenberg, and the community developing third party blocks. And I may be picking this PR as the wrong place to comment on this, and I apologise if that's the case. But in general, I don't see any fundamental issue with an SVG spritemap approach vs an SVG-in-JS one. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's give it a try and iterate later.
@sgomes - I like your proposal as the long term goal. First, we need to resolve existing issues with the current configuration and what Riad is working on addresses them. The issue is a lot of duplication of inlined SVG icons in code. The approach taken is moving code in one place which only makes it easier to work on further refinements. The idea of using an internal WordPress package leaves us space for further refactorings because it doesn't expose public API. Let's keep the discussion going as we want to have the best possible setup once it gets promoted into |
* Use Select: Fix render queue. (#19286) * Use Select: Fix render queue issues. * Use Select: Make `isMounted` more informative. * Framework: Reset lockfile changes to dependencies Co-authored-by: Andrew Duthie <[email protected]> * Project Management: Run pull request automation on closed (#19742) * Try/group block custom text color (#19181) * Add text color selector to group block to allow setting a text colour that applies to all children of the group to avoid having to set text colour on every individual child * Block Editor: Handle LinkControl submission via form handler (#19651) * Block Editor: Handle LinkControl submission via form handler * E2E Tests: Unskip intermittent buttons test failure * Added conditions and new translation strings for BlockMover (#19757) * Added conditions and new translation strings for BlockMover * Moved translator comments into sprintf function * Storybook: Add Placeholder component story (#19734) * Add Placeholder story for storybook * Update storybook test snapshot * Project Management: Fix pull request merge automation errors (#19768) * Framework: Use fixed version of checkout action Avoid unintended breaking changes. To a lesser extent, helps clarify that this tag refers to the _version of the action_, not the branch being checked out. * Framework: Configure PR automation checkout to master branch * Add post requests documentation for apiFetch (#19759) * Multi-select: don't focus first selected block (#19762) * Multi-select: don't focus first selected block * Move CopyHandler outside WritingFlow * Fix click appender * Remove useless line * Update: Readme.txt Link to changelog instead of adding it inline(#19761) * Fix: Media & Text: "Crop image to fill entire column" reset on image change (#19765) * Build: Include JSON files in zip archive (#19772) * Build: Include JSON files * Zip build script: Include json files in `build/block-library/blocks/` Co-Authored-By: Jorge Bernal <[email protected]> Co-authored-by: Jorge Bernal <[email protected]> * Makes appenders visible only for the current selection (#19598) * makes appenders visible only for the current selection * adds smaller footprint to appenders in navigation, only shows them if item has descendants * align appender to level of the menu item, remove useless CSS * Core-data: do not publish outdated state to subscribers during updates (#19752) * Core-data: do not publish outdated state to subscribers during updates Calling `saveEntityRecord` with an update does the following: 1. Calls `getEntityRecord` to fetch the current persisted state of the entity record 2. Calls `receiveEntityRecords` with the new up-to-date state to render the updates 3. Sends an API fetch with the update patch to persist the update 4. Calls `receiveEntityRecords` again with the new up-to-date *persisted* state The issue here, is that point 1 (Calling `getEntityRecord`) not only fetches the persisted state, but it also internally calls `receiveEntityRecords` itself . This results in the persisted outdated server state to be rendered on the UI, causing a flickering effect, that jumps pack when point 2 takes turn. This commit removes the call to getEntityRecord, and instead, it just calls receiveEntityRecords with the local up-to-date state of the entity record. This fixes the flickering issue. * Core-data: update tests to match saveEntityRecord yeilded actions Given `saveEntityRecord` no longer selects `getEntityRecord`, which itself triggers a SELECT action, two SELECTs are no longer yielded. This commit removes the expectation of these two SELECTs. * Core-data: Introduce getEntityRecordNoResolver selector To allow saveEntityRecord access the latest local full version of an entity without issung an API request. This prevents propogating outdating states to subscribers when saveEntityRecord is called. See: #19752 (comment) * Address review comments at #19752: 1. Capitalize alll added comment messages 2. Alias getEntityRecord with getEntityRecordNoResolver instead of copying it 3. Use describe.each instaed of looping manually in selectors tests * Add WordPress primitives package (#19781) * navigation-link: set page id in the attrs (#18641) * Project management: Add step that updates CHANGELOG files before npm releases (#19764) * Navigation Block: Add submenu chevron w/ setting (#19601) * Initialize setting in the nav block settings panel * Add submenu icon * Register "showSubmenuIcon" attributes * Add submenu icon to front-end of the page * Update submenu icon setting description * Don't use <span> for RichText element * Isolate NavigationLink icons * Clean up a little * Use <span> for NavigationLink contents * Rename `$level_zero` to `$is_level_zero` * Add missing spaces * Update submenu icon selector in style.scss * Add comment about span-wrapping * Fix phpcs errors * Remove unused styles * Fix failing e2e tests * Update failing snapshots * Embed: Fix failure placeholder alignment/sizing (#19673) * Fix error message sizing + alignment in Embed Placeholder * Fix Table placeholder input vs button alignment * Adjust spacing between error message and buttons * Fix card component sub-component example code (#19802) * Introduce the Icons package (#17055) * Expose @wordpress/icons to react-native (#19810) * Block popover: allow scrolling over (#19769) * Block popover: allow scrolling over * Clean up * Fix overlapping inserter popover * Better comment * Multi select: keep selection after move (#19784) * Multi select: keep selection after move * Add e2e test * Change e2e test * Address feedback * Fix snapshots * Bump plugin version to 7.3.0 * Navigation: Select parent navigation block on handleCreateFromExistingPages() action (#19817) * Paragraph block: remove dead CSS (#19821) * Bundle the icons package instead of using it as an external (#19809) * Move a dozen of block icons to the icons package (#19808) * Chore: Improve package-lock.json configuration * Add mkevins and pinarol as code owners for gallery block (#19829) * Added shippedProposals (#19065) * Added shippedProposals * Setting shippedProposals during init * Rich text: remove is-selected class (#19822) * Rich text: prefix is-selected class * Adjust more cases * Remove the class * Move more block SVGs to the icons package (#19834) * Block: use context to provide selected element (#19782) * Block: use context to provide selected element * Include multi selection nodes * Add comment * Popover: clean up requestAnimationFrame (#19771) * Popover: clean up requestAnimationFrame * Cancel the last request before a new request * Update: Removed editor store usage from native mobile block ed… (#18794) * Navigation: Manage navigation link appender visibility based on current selection (#19846) Show the navigation link appender when the selected item has descendants and is selected, or if it's the parent of the selected block. * Remove editor dependency from the block library (#16160) * Add AnglePicker Component; Add useDragging hook (#19637) This commit adds a component to pick angles and a hook to make dragging things easier to implement. Some components will be refactored to use the new hook e.g: the custom gradient picker. * Testing: Use deterministic selectors for incremented IDs (#19844) * Innerblock Templates Docs Link Typo Issue Fixed (#19813) * Innerblock Templates Docs Link Typo Issue Fixed * Innerblock Templates Docs Link Typo Issue Fixed * Rich text: enable if multi selection is aborted (#19839) * Block Directory: Refactor the reducer by breaking out the block management actions into their own reducer. (#19330) * Block Directory: Refactory the reducer by break out the block management actions into their own reducer. * Moved hasPermission into its own reducer. * Also remove the 'items' list as it's not being used * Update the getInstalledBlockTypes selector to point to the new reducer that manages installs. * Update typo in test. * Remove the lodash dependency in the selectors. It isn\'t necessary. * Fix panel header styles (#19842) * Move more block icons to the icons package (#19838) * Bump @babel/preset-env to 7.8.3 (Optional Chaining!) (#19831) * Bump babel to 7.8.3 * Added test for optional chaining * Bump other babel packages. * Fix * Changelog Update CHANGELOG.md * Update package-lock.json Co-authored-by: Grzegorz (Greg) Ziółkowski <[email protected]> * Style improvements for template previews (#19763) * First scaffold for template previews (mobile only) * WIP: managed to make the preview show, saving as a checkpoint - BlockEditorProvider needs an update so it uses the subRegistry - We need a better way to only render the picker on the main block list - We need to make the bottom sheet full height, and adapt the block preview accordingly * Set a fixed height for the template preview * Move template picker to the toolbar * Read only block list * Lint fixes * Made scrolling sort of working with read only block list * A longer template to test scrolling * Replace BottomSheet with Modal for previews * Allow closing previews with back button on Android * Revert changes to BlockList that were required for bottom sheet integration * Revert changes to BottomSheet * Add usage example for ModalHeaderBar * Improve accessibility of template preview * Improve accessibility of ModalHeaderBar * Remove unused imports * Added missing web file * RNMobile - Page template picker: apply layout from the preview * RNMobile - Layout preview: apply action * RNMobile - Page templates - set layout action * Remove mobile action from docs * New components for modal header buttons * Fix alignment of modal header buttons * Fix metrics for iOS modal header * Add subtitle to preview header * Use named color for modal header button * Updated modal title color and weight * Make Apply button bolder on iOS * Make Apply button bolder on iOS * Fix vertical alignment for close button * Allow modal rotation on iOS * Fix modal background on dark mode * Fixed dark mode for template previews * Revert changes to editor store after bad merge * Add material close icon for modal header * Tweak modal title colors * Lint fixes Co-authored-by: Gerardo Pacheco <[email protected]> * [RNMobile] Release v1.21.0 to master (#19854) * Adding empty function to RichText children call. (#19818) This fixes a crash originated on this PR: #19536 ` * Disable gallery image size options on mobile (#19828) * Revert "Disable gallery image size options on mobile (#19828)" This reverts commit 47b74aa. Co-authored-by: Matthew Kevins <[email protected]> * Packages: New create-block package for block scaffolding (#19773) * Packages: New create-block package for block scaffolding * Promote action handler to async to make implementation simpler * Pass the prop for selection color. (#19635) * Do not use the deprecated package editor for InnerBlocks component (#19869) * Remove dead is-hovered selectors (#19870) * Move is-navigate-mode class to WritingFlow (#19868) * [RNmobile] Upgrade to RN 0.61.5 (#19369) * `focusable` replaced `clickable See facebook/react-native#25274 * Provide a native colors.native.scss * Upgrade React Native version in Gutenberg web repo * Jest doesn't have hasteImplModulePath anymore * Work around other regressions. Will revert when those fixed * Bump react-native version to 0.61.5 * Update babel-jest to try fixing babel-plugin-jest-hoist jest.mock issue * Update jest to try fixing babel-plugin-jest-hoist jest.mock issue * Pin xmldom to older version to bypass license file ambiguity With newer versions, the license check script doesn't recognise that the package is dual licenced and is reporting it as incompatible. This commit pins the package to an older version. There is no functional difference between the two versions, see xmldom/xmldom@v0.1.27...v0.1.30 * Revert "Provide a native colors.native.scss" This reverts commit b05f1e4. This shouldn't be needed anymore after wordpress-mobile/gutenberg-mobile#1683 * Revert "Pin xmldom to older version to bypass license file ambiguity" This reverts commit 7e3c2b5. * Cater for lowercase OR in licenses types Props to @pento for the solution #19369 (comment) * Update package-lock.json via npm v6.13.6 * Check for the same "or" format as we're splitting Otherwise, the 'or' in `GPL-2.0-or-later` causes an infinite recursion. See error in https://travis-ci.com/WordPress/gutenberg/jobs/278348885. * Update package-lock.json after running run check-local-changes * Fix package-lock.json conflicts by keeping Jest to 24.9.0, Babel to 7.8.3 * Update package-lock by running npm install * Update README.md (#19876) Fix typo * Multi selection: fix intermittent e2e failure (#19865) * Move more block icons to the icons library (#19862) * Paragraph block: remove min-height (#19835) * Paragraph block: remove min-height * Use lineheight to set drop cap min height * Framework: Fix server-registered fixtures script (#19884) * Env: Format run output only for terminal display * Framework: Fix server-registered fixtures script * Testing: Regenerate server-registered fixtures * Testing: Regenerate navigation block fixture * Env: Fix CHANGELOG typo "or" * Shortcode Design Review (#19852) * Update style of shortcode based on design review * Fix title colors * Update component to components in CONTRIBUTING.md (#19914) * Apply sentence case formatting to PanelBody titles (#19901) * Color Settings -> Color settings * Block PanelBody titles: Settings -> settings * Clarify when isEligible function is called (#19899) Added a note that isEligible is only used for valid blocks and is not called for invalid blocks. * Block Editor: Refactor ObserveTyping as function component (#19881) * Block Editor: Refactor ObserveTyping as function component * Block Editor: ObserveTyping: Avoid persisting event * Remove unnecessary import from playground (#19893) * Documentation: Organize Contributors Guide (#19853) * Simplify CONTRIBUTING.md to be just guidelines We don't need to include too much here because the real information for contributing is in the handbook. This page is a standard page for Github repos, so trimming it down to just a few links to sections in the handbook. Plus the policies for code of conduct and GPL. * Add design contribution from CONTRIBUTING.md to design page * Cleanup and organize Contributors Guide * Use consistent Contributors Guide title * Move Principles and catch-all docs to Project Overview section * Switch background to more relevant repository management * Apply suggestions from code review Thanks for the fixes 👍 Co-Authored-By: Chris Van Patten <[email protected]> * Fix extra newlines * Standardize on Contributor Guide, matches core handbook * Update manifest Co-authored-by: Chris Van Patten <[email protected]> * [RNMobile] Correct isMobile condition in nested Media&Text (#19778) * Correct isMobile condition in nested Media&Text * Do not export BREAKPOINTS * Blocks: Match blocks in the inserter using keywords from patterns (#19243) * Blocks: Match blocks in the inserter using keywords from patterns * Ensure that matched patterns with the search term are marked * Introduce scopes for block patterns * Make it possible to apply initial attributes and inner blocks directly from the inserter * Update block preview in the inserter to use attributes from the variation * Change the way patterns are handled in the inserter * Update packages/block-editor/src/components/block-types-list/index.js Co-Authored-By: Miguel Fonseca <[email protected]> * Improve the way patterns are added to the inserter * Rename pattern label to patter title to align with block types * Inserter: Don't auto-add block if it has variations Co-authored-by: Miguel Fonseca <[email protected]> * Block editor: Alt+F10 shouldn't scroll to top (#19896) * Add e2e test * Leave fixed position until position can be set * Multi-selection: fix clearing with side click (#19787) * Multi-selection: fix clearing with side click * Add e2e test * [RNMobile] fix show appender and separator in Group block (#19908) * fix appender to duplicate separator line * Add docs for LocalAutosaveMonitor and __experimentalUpdateLocalAutosaveInterval (#19915) * [RNMobile] Add media edit icon to image block (#19723) * Creates a MediaEdit component that shows a picker * Add Gridicon's customize icon * Show a button in images block that displays a picker * Fix lint issues * Fix no-shadow error * Fix the name of the params * When "Edit" is selected, request the Media Editor * Fix lint issues * Change media editor ID to a constant * When "Replace" is tapped, show all available media options * Fix lint issues * Avoid destructuring * Block Library: Handle Popover onClose for LinkControl (#19885) * Block Library: Handle Popover onClose for LinkControl * E2E Tests: Verify link popover Escape handling * Disable Autocomplete in shortcode block (#19848) * Disable Autocomplete in shortcode block * RichText API: Limit `prefix` transformations to Paragraph (#19727) … and any consumer of RichText that provides experimental prop `__unstableAllowPrefixTransformations.` * Block Editor: LinkControl: Resolve error when undefined value, "view" state (#19856) * Block Editor: LinkControl: Resolve error when undefined value, "view" state * Block Editor: LinkControl: Document only url, title, opensInNewTab value properties * Block Editor: LinkControl: Change documented example to reference known value property * [RNMobile] Revert change to fix Action Sheet (#19934) * Revert "Avoid destructuring" This reverts commit e113310. * Fix the var name * Add background color support to Columns block (#17813) * Add attributes * Update edit function * Update save function * Add .has-background style * Improve has-background and backgroundColor.class checks * Try passing the columns block e2e test * Refactor to use __experimentalUseColors * Normalize has-background padding with variables * Remove extra bit * Fix RTL styling for Media Text block (#18764) * Add proper !rtl ignore comments to maintain styling on RTL * Tweak comment * Add direction: ltr (not ignored) to the content container * change order of composing style in svg primitive (#19927) * Add Prettier formatting script (#18048) * Add Prettier NPM dependency to packages/scripts and top-level * Scripts: export the fromProjectRoot function from scripts/utils module * Scripts: Add Prettier formatting script * ESLint config: use default (linebreak before ternary op) config for operator-linebreak rule * ESLint: disable formatting rules in the recommended config Adds `eslint-config-prettier` to the recommended config and creates an alternative `recommended-with-formatting` config for project that want to keep ESLint formatting rules and opt-out of Prettier. * Scripts: the format-js script checks if Prettier is present and has top-level config Prettier presence in a `wp-scripts`-powered project is optional, and the `format-js` script checks if it's there and if it's indeed the fork (`wp-prettier`). Will report error otherwise. Also, require a top-level Prettier config to be present. We can't default to the one inside `wp-scripts`, because IDE and editor integrations won't find it there and will use the Prettier defaults. * Bump the minimum required version of npm to 6.9.0 * Add ESLint config changes notice to changelog * Update package-lock.json * Regenerate package-lock.json Co-authored-by: Grzegorz (Greg) Ziółkowski <[email protected]> * Components: FontSizePicker: Adjust Select Button sizing (#19479) * Documentation: fix typo "Th" to "The" (#19833) * [RNMobile] Long-press on inserter to show options for "add above" and "add below" (#18791) * Add onLongPress prop to Button * Show inserter menu on long press * Make onLongPress a prop of toggle * Make withSelect of Inserter return destinationRootClientId * Insert default block before the selected one on long press * Add add canReplaceBlock key to the insertionPoint state * Hide a block in list only if it can be replaced * Move insertion index logic from menu to inserter * Update selector tests for newly added key in state * Add insertionIndexAfter and isAnyBlockSelected props with selector * Update docs for newly added key in state * Add insertionType to component state and map to insertion index * Refactor insertion index logic * Show BottomSheet on long press to choose to insert before or after * Update UI strings to be title case * Hide cancel button from Bottom Sheet on Android * Add icons to Bottom Sheet options on Android * Add “Replace Current Block” option to menu on long-press * Scroll to newly added block if it doesn't trigger keyboard to open * Change “Replace Current Block” menu icon on Android * Use shorter syntax for setState * Rename getShouldReplaceBlock method to shouldReplaceBlock * Revert "Scroll to newly added block if it doesn't trigger keyboard to open" This reverts commit 9c1c71d25eb573427ca09761bd3154286d19539b. * Revert “Add canReplaceBlock key to the insertionPoint state" * Remove Block show/hide logic from BlockList * Update Inserter local state to store block insertion information * Make InserterMenu add/remove unmodified default block during replace * Handle replacing last remaining block * Fix Inserter test * Fix code style issue * Move insertion options into getInsertionOptions function * Add comment about removing last block case * Use findByProps instead of toJSON when testing Inserter * Docs: Add details for format-js to @wordpress/scripts package (#19946) * Docs: Add details for format-js to @wordpress/scripts package * Update README.md * Update packages/eslint-plugin/CHANGELOG.md Co-Authored-By: Marcus Kazmierczak <[email protected]> Co-authored-by: Marcus Kazmierczak <[email protected]> * Fix: Crash when creating a hierarchical post without title (#19936) * Fix: Color Gradients component was not able to handle only gra… (#19925) * Add markdownlint script to lint docs markup (#19855) * Add markdownlint script to lint docs markup Adds a new script `lint-md-docs` that runs markdownlint to lint markdown files for proper syntax. A default `.markdownlint.json` config is included, it will require some testing to tune. Fixes #12426 * Clarify naming of lint-md scripts js and docs - Updates lint-md scripts to lint-md-js for linting source included in the document and lint-md-docs for linting the markup of the document itself. - Update scripts changelog - Update readme with commands * Apply suggestions from code review Co-Authored-By: Grzegorz (Greg) Ziółkowski <[email protected]> * Fix URL for markdownlint CLI * Add -i check, details around ignore on CLI * Check for additional project config files * Update script commands to all for lint:* * Local changes applied to package-lock.json * Update packages/scripts/README.md Co-Authored-By: Grzegorz (Greg) Ziółkowski <[email protected]> * Apply suggestions from code review Thanks for the review and updates 👍 Co-Authored-By: Grzegorz (Greg) Ziółkowski <[email protected]> Co-authored-by: Grzegorz (Greg) Ziółkowski <[email protected]> * Use require.resolve() instead of <rootDir> in @wordpress/jest-preset-default (#19957) * use require.resolve() instead of <rootDir> * formatted * added changelog entry (#19958) * Move the insert dashicon to the icons package (#19943) * Replace all occurences of the yes dashicon with the check icon from the icons package (#19926) * Build: Include block.json files in the build output (#19786) * Block Editor: LinkControl: Prevent focus loss in edit mode toggle (#19931) * Block Editor: LinkControl: Prevent focus loss in edit mode toggle * Block Library: Remove custom focus loss protection Previously used effect lifecycle to anticipate and respond to focus loss. Now, focus loss is prevented by LinkControl. See: 722a4d6dec * Block Editor: Rephrase and move forced input rendering comment * Block Editor: Ensure isEndingEditWithFocus always assigned as boolean * Move Alignment, movers and trash icons to the icons package (#19944) * Navigation Block: Move the link description panel below the SEO panel because this is likely to be used signficantly less than the SEO panel. (#19917) * Update hover and focus selectors for Move to Trash to ensure they're always red (#19974) - Updates the selectors in .editor-post-trash to use similar specificity as .components-button.is-link for the hover and focus states to ensure that they are always red. * Create block: Code quality improvements for the block scaffolding (#19867) * Create block: Code quality improvements for the block scaffolding * Improve the strucutre and handling of templates Props to @aduth for the proposal: #19773 (comment). * Ensure that package-lock.json file is refreshed with the changes from master * Docs: Add a note about version and help options * Code style: Run Prettier formatting on the package files * Create block: Align .editorconfig with Gutenberg settings * Fix: Use the description provided to fill the `description` field in `package.json` file in ESNext template * Fix: Ensure that values provided for slug and namespace get converted to lower case * Fix: Simplify the logic for transforming slug to title * Update packages/create-block/lib/templates.js Co-Authored-By: Andrew Duthie <[email protected]> Co-authored-by: Andrew Duthie <[email protected]> * Code quality: Enable linting for JS files starting with . * Popover: fix typo in removing event listener (#19978) * Eslint Plugin: Lint code formatting. (#19963) * Eslint Plugin: Lint code formatting. * Gutenberg: Add code formatting pre-commit hook. * Eslint Plugin: Update docs. * Gutenberg: Format code. * Storybook: Update snapshots. * [RNMobile] Show the media edit icon only if the block is selected (#19961) * Only shows the media edit icon if the block is selected Also, matches the style of the native gallery block buttons * Fix lint * Fix: Admin menu collapses for 960px width but editor doesn't (#19970) * Chore: Fix differences in package-lock.json file * RichText: try using hooks for wrapper component (#19095) * Components: Apply width-based modifier classes to Placeholder only when width is known (#19825) * Components: Apply `is-small` modifier class to Placeholder only when width known * E2E Tests: Wait for placeholder error display in embed tests * Testing: Update snapshots for Placeholder class assignment * Eslint: set line width to 80 (#19992) * Update config * npm run lint-js:fix * Move eslint comments * Update snapshots * Editor: Remove post title escaping (#19955) * Add: Global styles css variables generation mechanism (#19883) * Navigation: Change UX to move focus to navigation link label and close the LinkControl (#19686) * When adding a link via the LinkControl, selects/highlights nav link label text if it's url-like. Focuses if not. Automatically adds url-like labels as the label. * Adds @wordpress/dom to package-lock.json * Removed test for awaiting for Link Control focus after pressing Enter, as the focus should now be on the navigation link text with the Link Control closed * Lib: Limit `pre_render_block` extension. (#19989) * Lib: Limit `pre_render_block` extension. * Update lib/compat.php Co-Authored-By: Andrew Duthie <[email protected]> Co-authored-by: Andrew Duthie <[email protected]> * Fix, update, and sort _rc_ `hasProjectFile` filenames (#19994) * Update and fix `hasProjectFile` filenames * Sort `hasProjectFile` filenames * Update CHANGELOG.md * Docs: Include CHANGELOG entries from the relocated create-wordpress-block package * Blocks: Rename patterns to variations in the Block API (#19966) * Blocks: Rename patterns to variations in the Block API * Fix: Remove ESLint errors and warnings related to block variations * [Mobile] Fix gallery upload sync (#19941) * Invoke mediaUploadSync for gallery in React hook * Use integer type explicitly for gallery image id * Set state before attributes on upload success in gallery image * Use ref hook for concurrency in media placeholder * Extract dedup function and add comments in media placeholder * Fix lint * Use explicit radix with parseInt Co-Authored-By: Gerardo Pacheco <[email protected]> * Import useRef from @wordpress/element * Fix lint * Fix lint / prettier Co-authored-by: Gerardo Pacheco <[email protected]> * [Mobile] Fix blank image size labels on mobile (#19800) (#20045) * Fix blank image size labels on mobile * Use name instead of label in default imageSizes * [RNMobile] Enable Dismiss on PlainText in Android (#20095) * Add flag for determining if running on Android * Enable Dismiss button on PlainText. Enable show keyboard in Android on PlainText mount * Enable Dismiss button on PlainText. Enable show keyboard in Android on PlainText mount Co-authored-by: Enrique Piqueras <[email protected]> Co-authored-by: Andrew Duthie <[email protected]> Co-authored-by: Glen Davies <[email protected]> Co-authored-by: Christopher Reece <[email protected]> Co-authored-by: Marcus Kazmierczak <[email protected]> Co-authored-by: Ella van Durpe <[email protected]> Co-authored-by: Jorge Costa <[email protected]> Co-authored-by: Bernie Reiter <[email protected]> Co-authored-by: Jorge Bernal <[email protected]> Co-authored-by: andrei draganescu <[email protected]> Co-authored-by: Omar Alshaker <[email protected]> Co-authored-by: Riad Benguella <[email protected]> Co-authored-by: Damián Suárez <[email protected]> Co-authored-by: Grzegorz (Greg) Ziółkowski <[email protected]> Co-authored-by: Bart Kalisz <[email protected]> Co-authored-by: Jon Quach <[email protected]> Co-authored-by: Edi Amin <[email protected]> Co-authored-by: Seghir Nadir <[email protected]> Co-authored-by: Jerry Jones <[email protected]> Co-authored-by: Matthew Kevins <[email protected]> Co-authored-by: Abdelmajid HAMDANI <[email protected]> Co-authored-by: Delowar Hossain <[email protected]> Co-authored-by: Steven Dufresne <[email protected]> Co-authored-by: Adam Boro <[email protected]> Co-authored-by: Kukhyeon Heo <[email protected]> Co-authored-by: Gerardo Pacheco <[email protected]> Co-authored-by: etoledom <[email protected]> Co-authored-by: Sérgio Estêvão <[email protected]> Co-authored-by: Florian TIAR <[email protected]> Co-authored-by: Chip <[email protected]> Co-authored-by: Haz <[email protected]> Co-authored-by: Rich Tabor <[email protected]> Co-authored-by: Benjamin Intal <[email protected]> Co-authored-by: Rostislav Wolný <[email protected]> Co-authored-by: Chris Van Patten <[email protected]> Co-authored-by: Luke Walczak <[email protected]> Co-authored-by: Miguel Fonseca <[email protected]> Co-authored-by: jbinda <[email protected]> Co-authored-by: Leandro Alonso <[email protected]> Co-authored-by: Jarda Snajdr <[email protected]> Co-authored-by: Martin Posselt <[email protected]> Co-authored-by: Ceyhun Ozugur <[email protected]> Co-authored-by: James Newell <[email protected]> Co-authored-by: Andy Peatling <[email protected]> Co-authored-by: Andrew Serong <[email protected]> Co-authored-by: Stephen Edgar <[email protected]>
The design team plan to add hundreds/thousands of icons to this package for third-party users. That makes it impossible to load it as its own script (bundle size). Instead we should encourage its usage via npm and tree-shaking.
This PR avoid creating a WordPress script entirely for this package and bundle it when used. The advantage also is that we can iterate on the package without making it a public API (so all breaking changes allowed) until we're certain of the result.