Audit experimental APIs for WP 6.3 #51315
Comments
tellthemachines
added
Gutenberg Plugin
|
Hi! __experimentalInteractivityAPI Should not go into WP 6.3, as we are planning to remove that experimental setting from Gutenberg. __experimentalInjectInteractivityRuntime Should not go into WP 6.3 too, as is an option to bundle the interactivity API in Gutenberg. It is a temporary fix that should be updated when the Interactivity API is moved to its own package. |
|
Unfortunately, the block.json and theme.json can't use private APIs, so experimental/internal prefixes are still useful for these. |
|
We will most likely revert this, so won't be going into 6.3. |
|
I wonder if it'd be helpful for future versions of the script generating this list to split out already deprecated APIs (such as __experimentalUseEntityRecord) into a separate section? That might help speed up the triage a bit? |
That would be helpful, but is there any way we can tell for sure an API has been deprecated? Even if we check that it appears within a Relatedly, do we have any policy for removing deprecated APIs altogether? So, if we work out a way of splitting the deprecated APIs out, would it still be useful to output them as a separate list? |
|
The point you made about reliable detection is valid - it would be tricky.
I think even without the policy, there's some value in being able to parse the list and know at a glance that certain APIs have already been triaged and have stable counterparts. In those cases (for now) the deprecation is just a back-compat accommodation. There could even be argument that those APIs shouldn't be included in this post if they've already been "handled". |
|
Update:
(See #51434) |
|
Hi, I'd like to raise that we could potentially stabilize components from These components seem stable as they don't change for the last couple of versions and the Inspector Controls and we don't see issues or limitations in regards to them. Components that we rely on: Note: for some reason in the API list above, they're listed under |
|
Thanks @kmanijak ! As we're fast approaching Beta 3 it might be a bit late in the cycle to get these done, but perhaps we can start work on them for 6.4. @mirka what do you think?
It's a very simple script that generates these entries, and it picks the first package it finds mention of the API in 🙂 |
Sure. We've recently started to consider versioning components in order to introduce major breaking changes in a sustainable way. So it's looking hopeful! |
|
Closing this issue as RC1 is next week; we're past the time for stabilising further APIs for 6.3 😅 Thanks everyone! |
New APIs since 6.2
Here are all the non-private uses of
__experimentalthat are new since 6.4 (for reference, the previous API audit was in #47196):__experimentalDisableBlockOverlay@youknowriad__experimentalHasContentRoleAttribute@jorgefilipecosta (this refers to the one in theblockspackage; the more recent one inblock-editoris already marked private)__experimentalInteractivityAPI@c4rl0sbr4v0 (this is a Gutenberg experiment)__experimentalEnableGroupGridVariation@tellthemachines (also a Gutenberg experiment)__experimentalEnablePatternEnhancements@glendaviesnz (also a Gutenberg experiment)__experimentalAutoSelectFirstMatch@dinhtungdu (components package)__experimentalNavigatorToParentButton@youknowriad__experimentalInjectInteractivityRuntime@gziolo (webpack related)Could you folks take a look at these and see if they're ready for stabilisation, if they should go into 6.3 at all, or if they can be marked private?
New private APIs since 6.2
For these there's no action needed for now, unless they are ready to be stabilised!
__experimentalPopoverLegacyPositionToPlacement__experimentalUpdateSettingsIf I missed anything in the lists above please feel free to add to them as needed.
All experimental APis
Generated using @noisysocks' script from #28157Edit: I updated the list below to remove duplicate entries with the aid of #51341 (thanks @mcsf!)
Cc @WordPress/gutenberg-core is there anything in the list below that can be stabilised, marked private or removed?
Complete list of experimental APIs
lib__experimentalBorder__experimentalDefault__experimentalDuotone__experimentalEnableColorRandomizer__experimentalEnableGroupGridVariation__experimentalEnableListBlockV2__experimentalEnablePatternEnhancements__experimentalEnableQuoteBlockV2__experimentalEnableZoomedOutView__experimentalFeatures__experimentalFontFamily__experimentalFontStyle__experimentalFontWeight__experimentalInteractivityAPI__experimentalLayout__experimentalLetterSpacing__experimentalSelector__experimentalSettings__experimentalStyle__experimentalStyles__experimentalTextDecoration__experimentalTextTransformpackages/annotations__experimentalAddAnnotation__experimentalCreateOnChangeEditableValue__experimentalCreatePrepareEditableTree__experimentalGetAllAnnotationsForBlock__experimentalGetAnnotations__experimentalGetAnnotationsForBlock__experimentalGetAnnotationsForRichText__experimentalGetPropsForEditableTreeChangeHandler__experimentalGetPropsForEditableTreePreparation__experimentalRemoveAnnotation__experimentalRemoveAnnotationsBySource__experimentalUpdateAnnotationRangepackages/block-directory__experimentalIsFocusablepackages/block-editor__experimentalAlignmentMatrixControl__experimentalAppenderTagName__experimentalBlockAlignmentMatrixControl__experimentalBlockDirectory__experimentalBlockFullHeightAligmentControl__experimentalBlockPatternCategories__experimentalBlockPatternSetup__experimentalBlockPatterns__experimentalBlockPatternsList__experimentalBlockVariationPicker__experimentalBlockVariationTransforms__experimentalBorderBoxControl__experimentalBorderRadiusControl__experimentalBoxControl__experimentalCanUserUseUnfilteredHTML__experimentalCaptureToolbars__experimentalCloneSanitizedBlock__experimentalColorGradientControl__experimentalColorGradientSettingsDropdown__experimentalConvertBlockToStatic__experimentalDateFormatPicker__experimentalDefaultBlock__experimentalDefaultControls__experimentalDirectInsert__experimentalDisableBlockOverlay__experimentalDragComponent__experimentalDropdownContentWrapper__experimentalDuotoneControl__experimentalExposeControlsToChildren__experimentalFetchLinkSuggestions__experimentalFetchReusableBlocks__experimentalFetchRichUrlData__experimentalFilterValue__experimentalFirstVisibleItemClass__experimentalFontAppearanceControl__experimentalFontFamilyControl__experimentalGetAccessibleBlockLabel__experimentalGetActiveBlockIdByBlockNames__experimentalGetAllowedBlocks__experimentalGetAllowedPatterns__experimentalGetBlockAttributesNamesByRole__experimentalGetBlockLabel__experimentalGetBlockListSettingsForBlocks__experimentalGetBorderClassesAndStyles__experimentalGetColorClassesAndStyles__experimentalGetDirectInsertBlock__experimentalGetElementClassName__experimentalGetGapCSSValue__experimentalGetGlobalBlocksByName__experimentalGetGradientClass__experimentalGetGradientObjectByGradientValue__experimentalGetLastBlockAttributeChanges__experimentalGetMatchingVariation__experimentalGetParsedPattern__experimentalGetPatternTransformItems__experimentalGetPatternsByBlockTypes__experimentalGetReusableBlockTitle__experimentalGetSpacingClassesAndStyles__experimentalGlobalStylesBaseStyles__experimentalGrid__experimentalGroup__experimentalHStack__experimentalHandleURLSuggestions__experimentalHasContentRoleAttribute__experimentalHasSplitBorders__experimentalHeading__experimentalHideChildBlockControls__experimentalHint__experimentalImageEditor__experimentalImageSizeControl__experimentalImageURLInputUI__experimentalInitialIndex__experimentalInitialPosition__experimentalInsertionIndex__experimentalInspectorPopoverHeader__experimentalIsDefinedBorder__experimentalIsQuick__experimentalIsRenderedInSidebar__experimentalItem__experimentalItemGroup__experimentalLabel__experimentalLastVisibleItemClass__experimentalLayoutStyle__experimentalLetterSpacingControl__experimentalLibrary__experimentalLinkControl__experimentalLinkControlSearchInput__experimentalLinkControlSearchItem__experimentalLinkControlSearchResults__experimentalListView__experimentalMetadata__experimentalMinHeight__experimentalNavigatorBackButton__experimentalNavigatorButton__experimentalNavigatorProvider__experimentalNavigatorScreen__experimentalNumberControl__experimentalOnIndexChange__experimentalOnlyMediaLibrary__experimentalPadding__experimentalPanelColorGradientSettings__experimentalParentSelector__experimentalParseQuantityAndUnitFromRawValue__experimentalPopoverLegacyPositionToPlacement__experimentalPreferPatternsOnRoot__experimentalPreferredStyleVariations__experimentalPreviewOptions__experimentalPublishDateTimePicker__experimentalRecursionProvider__experimentalRenderControl__experimentalRenderSuggestions__experimentalResponsiveBlockControl__experimentalReusableBlocks__experimentalRichText__experimentalRole__experimentalSelectBlock__experimentalSetIsInserterOpened__experimentalShareWithChildBlocks__experimentalShouldInsertAtTheTop__experimentalShowInitialSuggestions__experimentalShowSelectedHint__experimentalSkipSerialization__experimentalSlashInserter__experimentalSpacer__experimentalSpacingSizesControl__experimentalStyleProvider__experimentalText__experimentalTextDecorationControl__experimentalTextTransformControl__experimentalToggleGroupControl__experimentalToggleGroupControlOption__experimentalToggleGroupControlOptionIcon__experimentalToolbar__experimentalToolbarContext__experimentalToolsPanel__experimentalToolsPanelContext__experimentalToolsPanelItem__experimentalTransferDataType__experimentalTreeGrid__experimentalTreeGridCell__experimentalTreeGridItem__experimentalTreeGridRow__experimentalTruncate__experimentalUndo__experimentalUnitControl__experimentalUpdateSelection__experimentalUpdateSettings__experimentalUseBlockOverlayActive__experimentalUseBlockPreview__experimentalUseBorderProps__experimentalUseColorProps__experimentalUseCustomSides__experimentalUseCustomUnits__experimentalUseDropZone__experimentalUseFixedWindowList__experimentalUseGradient__experimentalUseHasRecursion__experimentalUseMultipleOriginColorsAndGradients__experimentalUseResizeCanvas__experimentalUseSlotFills__experimentalVStack__experimentalVersion__experimentalView__experimentalZStack__experimentaluseLayoutClasses__experimentaluseLayoutStylespackages/block-library__experimentalConvert__experimentalDiscussionSettings__experimentalGetCoreBlocks__experimentalGetDefaultTemplatePartAreas__experimentalInputControl__experimentalIsEditingReusableBlock__experimentalOnEnter__experimentalRegisterExperimentalCoreBlocks__experimentalShowHowTo__experimentalShowTooltip__experimentalTooltipPropspackages/blocks__experimentalGetUnprocessedBlockTypes__experimentalReapplyBlockTypeFilters__experimentalRegisterBlockType__experimentalSanitizeBlockAttributespackages/commands__experimentalHideHeaderpackages/components__experimentalApplyValueToSides__experimentalAutoSelectFirstMatch__experimentalBorderControl__experimentalConfirmDialog__experimentalDimensionControl__experimentalDivider__experimentalElevation__experimentalExpandOnFocus__experimentalInputControlPrefixWrapper__experimentalInputControlSuffixWrapper__experimentalInvalid__experimentalIsEmptyBorder__experimentalNavigation__experimentalNavigationBackButton__experimentalNavigationGroup__experimentalNavigationItem__experimentalNavigationMenu__experimentalNavigatorToParentButton__experimentalPaletteEdit__experimentalRadio__experimentalRadioGroup__experimentalRenderItem__experimentalScrollable__experimentalSurface__experimentalTheme__experimentalToggleGroupControlOptionBase__experimentalUseDialog__experimentalUseDragging__experimentalUseFocusOutside__experimentalUseNavigator__experimentalUseSlot__experimentalValidateInputpackages/compose__experimentalWidthProviderpackages/core-data__experimentalBatch__experimentalFetchUrlData__experimentalGetCurrentGlobalStylesId__experimentalGetCurrentThemeBaseGlobalStyles__experimentalGetCurrentThemeGlobalStylesVariations__experimentalGetDirtyEntityRecords__experimentalGetEntitiesBeingSaved__experimentalGetEntityRecordNoResolver__experimentalGetTemplateForLink__experimentalNoFetch__experimentalReceiveCurrentGlobalStylesId__experimentalReceiveThemeBaseGlobalStyles__experimentalReceiveThemeGlobalStyleVariations__experimentalSaveSpecifiedEntityEdits__experimentalUseEntityRecord__experimentalUseEntityRecords__experimentalUseResourcePermissionspackages/customize-widgets__experimentalGetInsertionPointpackages/date__experimentalGetSettingspackages/dependency-extraction-webpack-plugin__experimentalInjectInteractivityRuntimepackages/e2e-test-utils__experimentalActivatePlugin__experimentalDeactivatePlugin__experimentalRestpackages/edit-post__experimentalFullscreenModeClose__experimentalGetPreviewDeviceType__experimentalMainDashboardButton__experimentalSetPreviewDeviceTypepackages/edit-site__experimentalAdditionalBlockPatternCategories__experimentalAdditionalBlockPatterns__experimentalDashboardLink__experimentalGetDefaultTemplateTypes__experimentalGetTemplateInfopackages/editor__experimentalCreatePageEntity__experimentalGetDefaultTemplateType__experimentalTearDownEditor__experimentalUserCanCreatePagespackages/reusable-blocks__experimentalConvertBlocksToReusable__experimentalDeleteReusableBlock__experimentalSetEditingReusableBlockThe text was updated successfully, but these errors were encountered: