Audit Experimental APIs for WP 6.2 #47196
Comments
ntsekouras
added
Gutenberg Plugin
|
I would like to understand what the procedure for From my perspective, the latter would be much preferred because several components have been experimental for a very long time and are so crucial that they have been used relatively widely. For example, the In order to prevent these kinds of things I'm 100% ob board with locking new introductions so they cannot get used before they are stable. But because weren't using this approach before there just are many components that are getting used relatively widely even when they shouldn't have been. |
|
@fabiankaegy the |
|
Definitely agree we should use API in #46131 to I'd personally be on board with then considering all pre-6.2 experimental APIs as "stable but discouraged". But not a strong opinion—I know it's a contentious issue 😅 Thinking that we should also reevaluate these posts. They don't seem to work—the list grows longer each release. Not sure what would work best. Perhaps assigning each experimental API an owner might work to remove any bystander effect. Or perhaps we don't need to audit experimental APIs at all. |
|
Sorry for the massive ping, but I've updated the description to pinpoint the new APIs for |
|
This component isn't publicly exported from the package yet so it should be fine. But I just realized that the readme isn't excluded from the public docs, so I'll get that fixed asap 🙊 |
|
Thanks @ntsekouras. I edited the issue to bury the unimportant stuff in a This is a much more manageable list. We should do it this way for future releases 🙂 |
|
Thanks for the ping @ntsekouras !
These are closely tied to the Layout block support which is also still an experimental API. I'm looking at stabilising it together with these smaller pieces soon, but I'm not sure it will be done in time for 6.2. |
|
Noting that this PR landed #46131 |
@tellthemachines should we rename the new ones to lose the prefix then? |
|
@ntsekouras not yet! There's still some work to do to make the layout API more usable before we stabilise it, and I think these functions shouldn't be stabilised before that as they might still change. |
I had a look at making these APIs private in #47375, but couldn't get the locking system working. Any advice on using the new API would be appreciated! |
@joshuatf how has this been working out for you? We need to make a call on whether to make it stable or make it harder to access for WordPress 6.2. |
|
I've opened up a PR to explore stabilising this one in #47475 — happy for feedback, though, as I was a little on the fence as to which way to go, but wound up leaning toward stabilising + documenting since it hasn't needed any changes over the past couple of months. |
Shouldn't these use the new locking system for experimental APIs, @tellthemachines? If they ship with the |
|
Quick question — does any of the work related to this issue require a dev note? If so, should the need be assessed on a PR-per-PR basis, or should we have just one dev note the whole bunch of changes? |
For locking new APIs that never made it into core, we don't need any dev note. For introducing new APIs we need dev notes. |
|
When we stabilize an existing API and rename it by removing the |
That's a good question. I'd need some feedback for this one. --cc @priethor @youknowriad |
|
Do we need a dev note about the lock()/unlock() api? I don’t think one makes sense - do you? |
They probably need a dev note. Even if there were a dev note for the |
|
The point of |
These are already in Core so I guess they technically are stable now 😅 |
|
I've made this |
I could do with some advice on what to do with #43986. It introduces the So how does one Note there are also some utilities (not selectors) that access that setting such as |
|
Howdy folks! In case it's useful, I wanted to share with you some Gutenberg
|
@getdave there's no systemic solution yet, but here's what you could do: export function hasBlockMetadataSupport( blockType, feature = '' ) {
+ if ( ! blockType.startsWith('core/') ) {
+ return false;
+ }
const support = getBlockSupport( blockType, '__experimentalMetadata' );
return !! ( true === support || support?.[ feature ] );
} |
…wordpress/experiments (#47229) ## What? Part of #47196. Uses `@wordpress/experiments` (#46131) to make `__experimentalShowSelectedHint` in `CustomSelectControl` private. ## Why? We don't want to add any new experimental APIs to 6.2 as part of an effort to no longer expose experimental APIs in Core. ## How? https://github.com/WordPress/gutenberg/blob/trunk/docs/contributors/code/coding-guidelines.md#experimental-react-component-properties ## Testing Instructions 1. Use a block theme with more than 5 font sizes or manually edit `theme.json` to contain more than 5 font sizes in `settings.typography.fontSizes`. 2. Open the site editor. Appearance → Editor → Edit. 3. Go to Styles → Typography → Headings. 4. Select a heading level. 5. Toggle off the custom font size picker. 6. You should see a hint alongside the selected font size preset. Co-authored-by: Adam Zieliński <adam@adamziel.com>
|
|
…wordpress/experiments (#47229) ## What? Part of #47196. Uses `@wordpress/experiments` (#46131) to make `__experimentalShowSelectedHint` in `CustomSelectControl` private. ## Why? We don't want to add any new experimental APIs to 6.2 as part of an effort to no longer expose experimental APIs in Core. ## How? https://github.com/WordPress/gutenberg/blob/trunk/docs/contributors/code/coding-guidelines.md#experimental-react-component-properties ## Testing Instructions 1. Use a block theme with more than 5 font sizes or manually edit `theme.json` to contain more than 5 font sizes in `settings.typography.fontSizes`. 2. Open the site editor. Appearance → Editor → Edit. 3. Go to Styles → Typography → Headings. 4. Select a heading level. 5. Toggle off the custom font size picker. 6. You should see a hint alongside the selected font size preset. Co-authored-by: Adam Zieliński <adam@adamziel.com>
|
Closing this issue as there are no more things to be done at this stage of Let's track the remaining work in this issue: #48743. |
|
Great work everyone here, thank you! |
Cc @WordPress/gutenberg-core
APIs that never released in a stable WP version
This is a first pass of the new APIs based on this diff that compares the APIs in
6.1.lockit. See Experiments: sharing private APIs with lock() and unlock() #46131.All experimental APIs
Generated using @noisysocks' script from #28157, with a small tweak to add each API only once, in the first package it was found.
I'm sharing the suggestions from previous similar issues(example) for older WP versions by @youknowriad in #31416, although we need to evaluate per case the proper handling:
__unstableinsteadThe list will be updated again, since APIs might change before the last GB version to be included in 6.2.
List of experimental APIs
packages/annotations__experimentalAddAnnotation__experimentalCreateOnChangeEditableValue__experimentalCreatePrepareEditableTree__experimentalGetAllAnnotationsForBlock__experimentalGetAnnotations__experimentalGetAnnotationsForBlock__experimentalGetAnnotationsForRichText__experimentalGetPropsForEditableTreeChangeHandler__experimentalGetPropsForEditableTreePreparation__experimentalRemoveAnnotation__experimentalRemoveAnnotationsBySource__experimentalUpdateAnnotationRangepackages/block-directory__experimentalIsFocusablepackages/block-editor__experimentalAlignmentMatrixControl__experimentalAppenderTagName__experimentalApplyValueToSides__experimentalBlockAlignmentMatrixControl__experimentalBlockDirectory__experimentalBlockFullHeightAligmentControl__experimentalBlockPatternCategories__experimentalBlockPatternSetup__experimentalBlockPatterns__experimentalBlockPatternsList__experimentalBlockVariationPicker__experimentalBlockVariationTransforms__experimentalBorder__experimentalBorderBoxControl__experimentalBorderRadiusControl__experimentalBoxControl__experimentalCanUserUseUnfilteredHTML__experimentalCaptureToolbars__experimentalCloneSanitizedBlock__experimentalColorGradientControl__experimentalColorGradientSettingsDropdown__experimentalConvertBlockToStatic__experimentalDateFormatPicker__experimentalDefaultBlock__experimentalDefaultControls__experimentalDirectInsert__experimentalDragComponent__experimentalDropdownContentWrapper__experimentalDuotone__experimentalDuotoneControl__experimentalEnableOffCanvasNavigationEditor__experimentalExposeControlsToChildren__experimentalFeatures__experimentalFetchLinkSuggestions__experimentalFetchReusableBlocks__experimentalFetchRichUrlData__experimentalFilterValue__experimentalFirstVisibleItemClass__experimentalFontAppearanceControl__experimentalFontFamily__experimentalFontFamilyControl__experimentalFontStyle__experimentalFontWeight__experimentalGetAccessibleBlockLabel__experimentalGetActiveBlockIdByBlockNames__experimentalGetAllowedBlocks__experimentalGetAllowedPatterns__experimentalGetBlockAttributesNamesByRole__experimentalGetBlockLabel__experimentalGetBlockListSettingsForBlocks__experimentalGetBorderClassesAndStyles__experimentalGetColorClassesAndStyles__experimentalGetDirectInsertBlock__experimentalGetElementClassName__experimentalGetGapCSSValue__experimentalGetGlobalBlocksByName__experimentalGetGradientClass__experimentalGetGradientObjectByGradientValue__experimentalGetLastBlockAttributeChanges__experimentalGetMatchingVariation__experimentalGetParsedPattern__experimentalGetPatternTransformItems__experimentalGetReusableBlockTitle__experimentalGetSpacingClassesAndStyles__experimentalGlobalStylesBaseStyles__experimentalGroup__experimentalHStack__experimentalHandleURLSuggestions__experimentalHasSplitBorders__experimentalHeading__experimentalHideChildBlockControls__experimentalHint__experimentalImageEditor__experimentalImageSizeControl__experimentalImageURLInputUI__experimentalInitialIndex__experimentalInitialPosition__experimentalInsertionIndex__experimentalInspectorPopoverHeader__experimentalIsDefinedBorder__experimentalIsItemGroup__experimentalIsQuick__experimentalIsRenderedInSidebar__experimentalItem__experimentalItemGroup__experimentalLabel__experimentalLastVisibleItemClass__experimentalLayout__experimentalLayoutStyle__experimentalLetterSpacing__experimentalLetterSpacingControl__experimentalLibrary__experimentalLinkControl__experimentalLinkControlSearchInput__experimentalLinkControlSearchItem__experimentalLinkControlSearchResults__experimentalListView__experimentalMinHeight__experimentalNavigatorBackButton__experimentalNavigatorButton__experimentalNavigatorProvider__experimentalNavigatorScreen__experimentalNumberControl__experimentalOnIndexChange__experimentalOnlyMediaLibrary__experimentalPadding__experimentalPanelColorGradientSettings__experimentalParentSelector__experimentalParseQuantityAndUnitFromRawValue__experimentalPreferPatternsOnRoot__experimentalPreferredStyleVariations__experimentalPreviewOptions__experimentalPublishDateTimePicker__experimentalRecursionProvider__experimentalRenderControl__experimentalRenderSuggestions__experimentalResponsiveBlockControl__experimentalReusableBlocks__experimentalRichText__experimentalRole__experimentalSelectBlock__experimentalSetIsInserterOpened__experimentalSettings__experimentalShareWithChildBlocks__experimentalShouldInsertAtTheTop__experimentalShowInitialSuggestions__experimentalSkipSerialization__experimentalSlashInserter__experimentalSpacer__experimentalSpacingSizesControl__experimentalStyleProvider__experimentalText__experimentalTextDecoration__experimentalTextDecorationControl__experimentalTextTransform__experimentalTextTransformControl__experimentalToggleGroupControl__experimentalToggleGroupControlOption__experimentalToggleGroupControlOptionIcon__experimentalToolbar__experimentalToolbarContext__experimentalToolsPanel__experimentalToolsPanelContext__experimentalToolsPanelItem__experimentalTransferDataType__experimentalTreeGrid__experimentalTreeGridCell__experimentalTreeGridItem__experimentalTreeGridRow__experimentalTruncate__experimentalUndo__experimentalUnitControl__experimentalUpdateSelection__experimentalUseBlockOverlayActive__experimentalUseBlockPreview__experimentalUseBorderProps__experimentalUseColorProps__experimentalUseCustomSides__experimentalUseCustomUnits__experimentalUseDropZone__experimentalUseFixedWindowList__experimentalUseGradient__experimentalUseHasRecursion__experimentalUseMultipleOriginColorsAndGradients__experimentalUseResizeCanvas__experimentalUseSlot__experimentalVStack__experimentalVersion__experimentalViewpackages/block-library__experimentalConvert__experimentalDefault__experimentalDiscussionSettings__experimentalGetCoreBlocks__experimentalGetDefaultTemplatePartAreas__experimentalHideHeader__experimentalIsEditingReusableBlock__experimentalOnEnter__experimentalRegisterExperimentalCoreBlocks__experimentalSelector__experimentalShowHowTo__experimentalShowTooltip__experimentalStyle__experimentalTooltipPropspackages/blocks__experimentalGetUnprocessedBlockTypes__experimentalReapplyBlockTypeFilters__experimentalRegisterBlockType__experimentalSanitizeBlockAttributespackages/components__experimentalBorderControl__experimentalConfirmDialog__experimentalDimensionControl__experimentalDivider__experimentalElevation__experimentalExpandOnFocus__experimentalGrid__experimentalInputControl__experimentalInputControlPrefixWrapper__experimentalInputControlSuffixWrapper__experimentalInvalid__experimentalIsEmptyBorder__experimentalNavigation__experimentalNavigationBackButton__experimentalNavigationGroup__experimentalNavigationItem__experimentalNavigationMenu__experimentalPaletteEdit__experimentalRadio__experimentalRadioGroup__experimentalRenderItem__experimentalScrollable__experimentalSurface__experimentalToggleGroupControlOptionBase__experimentalUseDialog__experimentalUseDragging__experimentalUseFocusOutside__experimentalUseNavigator__experimentalValidateInput__experimentalZStackpackages/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/e2e-test-utils__experimentalActivatePlugin__experimentalDeactivatePlugin__experimentalRestpackages/edit-post__experimentalFullscreenModeClose__experimentalGetPreviewDeviceType__experimentalMainDashboardButton__experimentalSetPreviewDeviceTypepackages/edit-site__experimentalAdditionalBlockPatternCategories__experimentalAdditionalBlockPatterns__experimentalEnableColorRandomizer__experimentalEnableGlobalStylesCustomCSS__experimentalEnableZoomedOutView__experimentalGetDefaultTemplateTypes__experimentalGetTemplateInfo__experimentalGlobalStylesCustomCSSpackages/editor__experimentalCreatePageEntity__experimentalGetDefaultTemplateType__experimentalTearDownEditor__experimentalUserCanCreatePagespackages/eslint-plugin__experimentalFoo__experimentalSafe__experimentalUnsafepackages/experiments__experimentalFunctionpackages/reusable-blocks__experimentalConvertBlocksToReusable__experimentalDeleteReusableBlock__experimentalSetEditingReusableBlocklib__experimentalEnableListBlockV2__experimentalEnableQuoteBlockV2The text was updated successfully, but these errors were encountered: