Audit Experimental APIs WP 5.8 #31416
Comments
youknowriad
added
[Status] In Progress
|
@youknowriad I'm not sure if this list is up to date? For example I think I see what's happening, the script might be picking up changelog notes. Maybe exclude |
|
@nerrad good catch, I updated the list by excluding markdown files, how does it look now? |
|
I can't speak to everything but |
|
I did a quick first pass.. I believe these should remain
These feel like they could become stable: |
If these are the ones in the block-editor package, I think they should remain experimental because the patterns directory could have an impact there. |
|
I think I saw some discussion about grouping some of these under "typography" ? it would make sense to be but I agree that we can probably stabilize these now, they are a good complement to theme.json for block authors. UI is not a blocker to stabilize things though for me, it can be iterated on. |
That might be what you're thinking of, from #27331. Part of it is to group tools logically, part of it is to avoid a proliferation of panels. |
|
@nosolosw I think useEditorFeature is something we should stabilize, though I don't like the naming of the hook, maybe more |
Oh, this would be very different to what was implemented at first. Does it mean that it no longer checks the settings in block This one is hardcoded to always return It makes me wonder, how block authors can opt in for the feautes like gutenberg/lib/experimental-default-theme.json Line 178 in 0343eda Will they need to define the hook that updates all settings? I see an override for the Button block in gutenberg/lib/experimental-default-theme.json Lines 221 to 227 in 0343eda What is the story for custom block creators? |
It's the other way around:
So ultimately, the final decision belongs to the theme author. My post also explains this a bit https://riad.blog/2021/05/05/introduction-to-wordpresss-global-styles-and-global-settings/ |
From the post:
Thank you for sharing this post. It clarified all misconceptions I had based on the initial development efforts I was involved in. |
|
This is used not only in richtext but also in the Navigation editor and block. It is slightly unorthodox because it lives in Core Data but is not using the |
Right, the idea was to move into the place where it can be shared between all those places. The plan is to find it a better home in the future. @gwwar might have better insights on how to move forward with making it stable. |
Not sure if this is what you mean but it is already in Currently, the I'm not sure what criteria are required to consider this API stable? Do we need to migrate the format to utilise the generator based data fetching mechanics of
Definitely, a good idea to have Kerry's input 👍 Also @talldan if he has a moment. |
|
For This function is a default implementation specific to WP, and passed through to editor settings on init (post/site/widget/navigation). Folks can currently override this in their custom editor instance, by passing through a different function. Is it worth making these specific default implementations public? (This one is specific to WP). If the answer is yes, I'd prefer not removing the If we don't think there's value to exposing the default implementations, we could perhaps change the prefix to Note that we can probably stabilize the left side of this for editor settings: gutenberg/packages/edit-site/src/index.js Lines 26 to 27 in 73af997 |
|
I'm going to close this now as we're passed feature freeze. I think I expected a bit more updates here. Anyway, let's continue doing non stop (and not wait for the last moment in the release cycle). Thanks folks. |
This is the list of experimental APIs we have generated by the @noisysocks's script from #28157
The list is long and we doesn't have to go through the entire list but I suggest that If you introduced/used one of these APIs, to follow the following steps: cc @WordPress/gutenberg-core
__unstableinsteadOur goal after a couple weeks should be to change the status of a dozen of APIs (whether it's marking them unstable or stable).
packages/annotations__experimentalAddAnnotation__experimentalCreateOnChangeEditableValue__experimentalCreatePrepareEditableTree__experimentalGetAllAnnotationsForBlock__experimentalGetAnnotations__experimentalGetAnnotationsForBlock__experimentalGetAnnotationsForRichText__experimentalGetPropsForEditableTreeChangeHandler__experimentalGetPropsForEditableTreePreparation__experimentalRemoveAnnotation__experimentalRemoveAnnotationsBySource__experimentalUpdateAnnotationRangepackages/block-directory__experimentalInserterMenuExtension#31417packages/block-editor__experimentalAlignmentMatrixControl__experimentalAppenderTagName__experimentalBlock#31419__experimentalBlockAlignmentMatrixControl__experimentalBlockDirectory__experimentalBlockFullHeightAligmentControl__experimentalBlockNavigationBlockFill__experimentalBlockNavigationEditor__experimentalBlockNavigationTree__experimentalBlockPatternCategories__experimentalBlockPatternSetup__experimentalBlockPatterns__experimentalBlockSettingsMenuFirstItem#31420__experimentalBlockVariationPicker__experimentalBlockVariationTransforms__experimentalBorder__experimentalBorderStyleControl__experimentalBoxControl__experimentalCanUserUseUnfilteredHTML__experimentalCaptureToolbars__experimentalCloneSanitizedBlock__experimentalColorGradientControl__experimentalConvertBlockToStatic__experimentalDragComponent__experimentalDuotone__experimentalDuotoneControl__experimentalFeatures__experimentalFetchLinkSuggestions__experimentalFontAppearanceControl__experimentalFontFamily__experimentalFontFamilyControl__experimentalFontStyle__experimentalFontWeight__experimentalGetAccessibleBlockLabel__experimentalGetActiveBlockIdByBlockNames__experimentalGetAllowedBlocks__experimentalGetAllowedPatterns__experimentalGetBlockLabel__experimentalGetBlockListSettingsForBlocks__experimentalGetBorderClassesAndStyles__experimentalGetColorClassesAndStyles__experimentalGetGradientClass__experimentalGetGradientObjectByGradientValue__experimentalGetLastBlockAttributeChanges__experimentalGetMatchingVariation__experimentalGetParsedPattern__experimentalGetParsedReusableBlock__experimentalGetPatternTransformItems__experimentalGetPatternsByBlockTypes__experimentalGetReusableBlockTitle__experimentalGradientPicker__experimentalGradientPickerControl__experimentalGradientPickerPanel__experimentalHandleURLSuggestions__experimentalImageSizeControl__experimentalImageURLInputUI__experimentalInitialIndex__experimentalInserterMenuExtension__experimentalInsertionIndex__experimentalIsQuick__experimentalLayout__experimentalLayoutStyle__experimentalLibrary__experimentalLinkControl__experimentalLinkControlSearchInput__experimentalLinkControlSearchItem__experimentalLinkControlSearchResults__experimentalLive__experimentalNoWrapper__experimentalOnClick__experimentalOnIndexChange__experimentalOnlyMediaLibrary__experimentalPadding__experimentalPanelColorGradientSettings__experimentalParentSelector__experimentalPersistentListViewFeatures__experimentalPreferredStyleVariations__experimentalPreviewOptions__experimentalRenderControl__experimentalRenderSuggestions__experimentalResponsiveBlockControl__experimentalReusableBlocks__experimentalRichText__experimentalRole__experimentalSearchForm__experimentalSelectBlock__experimentalSelector__experimentalSetIsInserterOpened__experimentalShouldInsertAtTheTop__experimentalShowInitialSuggestions__experimentalSkipFontSizeSerialization__experimentalSkipSerialization__experimentalSpotlightEntityBlocks__experimentalStyleProvider__experimentalTextDecoration__experimentalTextTransform__experimentalToolbar__experimentalToolbarContext__experimentalTransferDataType__experimentalTreeGrid__experimentalTreeGridCell__experimentalTreeGridItem__experimentalTreeGridRow__experimentalUndo__experimentalUnitControl__experimentalUpdateSelection__experimentalUseBorderProps__experimentalUseColorProps__experimentalUseColors__experimentalUseCustomSides__experimentalUseDropZone__experimentalUseEditorFeature__experimentalUseGradient__experimentalUseInnerBlocksProps__experimentalUseNoRecursiveRenders__experimentalUseResizeCanvas__experimentalUseSimulatedMediaQuery__experimentalUseSlot__experimentalVersionpackages/block-library__experimentalAppenderTagName__experimentalBlockAlignmentMatrixControl__experimentalBlockFullHeightAligmentControl__experimentalBlockNavigationTree__experimentalBlockVariationPicker__experimentalBorder__experimentalBoxControl__experimentalCaptureToolbars__experimentalConvert__experimentalConvertBlockToStatic__experimentalDuotone__experimentalFeatures__experimentalFontFamily__experimentalFontStyle__experimentalFontWeight__experimentalGetBorderClassesAndStyles__experimentalGetColorClassesAndStyles__experimentalGetCoreBlocks__experimentalGetDefaultTemplatePartAreas__experimentalGetGradientClass__experimentalGetSettings__experimentalImageSizeControl__experimentalImageURLInputUI__experimentalIsEditingReusableBlock__experimentalLabel__experimentalLayout__experimentalLinkControl__experimentalLive__experimentalNumberControl__experimentalOnClick__experimentalPanelColorGradientSettings__experimentalRegisterExperimentalCoreBlocks__experimentalRole__experimentalSearchForm__experimentalSelector__experimentalShowTooltip__experimentalSkipSerialization__experimentalTextDecoration__experimentalTextTransform__experimentalTooltipProps__experimentalUnitControl__experimentalUseBorderProps__experimentalUseColorProps__experimentalUseEditorFeature__experimentalUseGradient__experimentalUseInnerBlocksProps__experimentalUseNoRecursiveRenders__experimentalVersionpackages/blocks__experimentalBorder__experimentalCloneSanitizedBlock__experimentalConvert__experimentalFontFamily__experimentalFontStyle__experimentalFontWeight__experimentalGetAccessibleBlockLabel__experimentalGetBlockAttributesNamesByRole__experimentalGetBlockLabel__experimentalLabel__experimentalRole__experimentalSanitizeBlockAttributes__experimentalTextDecoration__experimentalTextTransformpackages/components__experimentalAlignmentMatrixControl__experimentalBoxControl__experimentalColorEdit__experimentalCustomGradientPicker__experimentalDimensionControl__experimentalDragComponent__experimentalExpandOnFocus__experimentalFetchLinkSuggestions__experimentalFlex__experimentalFlexBlock__experimentalFlexItem__experimentalGetSettings__experimentalGradientPicker__experimentalHeading__experimentalInputControl__experimentalInvalid__experimentalIsFocusable__experimentalNavigation__experimentalNavigationBackButton__experimentalNavigationGroup__experimentalNavigationItem__experimentalNavigationMenu__experimentalNumberControl__experimentalRadio__experimentalRadioGroup__experimentalShowHowTo__experimentalShowTooltip__experimentalStyleProvider__experimentalText__experimentalToolbarContext__experimentalTooltipProps__experimentalTransferDataType__experimentalTreeGrid__experimentalTreeGridCell__experimentalTreeGridItem__experimentalTreeGridRow__experimentalTruncate__experimentalUnitControl__experimentalUseDragging__experimentalUseDropZone__experimentalUseFocusOutside__experimentalUseSlot__experimentalValidateInputpackages/compose__experimentalUseDialog__experimentalUseDragging__experimentalUseDropZone__experimentalUseFocusOutside__experimentalWidthProviderpackages/core-data__experimentalBatch__experimentalFetchLinkSuggestions__experimentalGetDirtyEntityRecords__experimentalGetEntityRecordNoResolver__experimentalGetTemplateForLink__experimentalSaveSpecifiedEntityEditspackages/customize-widgets__experimentalBlockSettingsMenuFirstItem__experimentalGetCoreBlocks__experimentalLibrary__experimentalRegisterExperimentalCoreBlocks__experimentalSetIsInserterOpenedpackages/data__experimentalListeningStores__experimentalMarkListeningStores__experimentalSubscribeStore__experimentalUseThunkspackages/date__experimentalGetSettingspackages/e2e-tests__experimentalAddAnnotation__experimentalConvert__experimentalRemoveAnnotationsBySource__experimentalUpdateLocalAutosaveIntervalpackages/edit-navigation__experimentalFetchLinkSuggestions__experimentalIsFocusable__experimentalRegisterExperimentalCoreBlockspackages/edit-post__experimentalBlockSettingsMenuFirstItem__experimentalFullscreenModeClose__experimentalGetInsertionPoint__experimentalGetPreviewDeviceType__experimentalGetTemplateForLink__experimentalInsertionIndex__experimentalLayout__experimentalLayoutStyle__experimentalLibrary__experimentalLocalAutosaveInterval__experimentalMainDashboardButton__experimentalNavigation__experimentalNavigationItem__experimentalNavigationMenu__experimentalPreferredStyleVariations__experimentalPreviewOptions__experimentalRegisterExperimentalCoreBlocks__experimentalSetIsInserterOpened__experimentalSetPreviewDeviceType__experimentalUpdateLocalAutosaveInterval__experimentalUseDialog__experimentalUseEditorFeature__experimentalUseResizeCanvas__experimentalUseSlotpackages/edit-site__experimentalBlockNavigationTree__experimentalBlockSettingsMenuFirstItem__experimentalBorderStyleControl__experimentalBoxControl__experimentalColorEdit__experimentalColorGradientControl__experimentalFeatures__experimentalFetchLinkSuggestions__experimentalFontAppearanceControl__experimentalFontFamilyControl__experimentalGetActiveBlockIdByBlockNames__experimentalGetBlockLabel__experimentalGetDefaultTemplatePartAreas__experimentalGetDefaultTemplateTypes__experimentalGetDirtyEntityRecords__experimentalGetInsertionPoint__experimentalGetPreviewDeviceType__experimentalGetTemplateForLink__experimentalGetTemplateInfo__experimentalGlobalStylesBaseStyles__experimentalGlobalStylesUserEntityId__experimentalInsertionIndex__experimentalLayout__experimentalLibrary__experimentalLinkControl__experimentalMainDashboardButton__experimentalNavigation__experimentalNavigationBackButton__experimentalNavigationGroup__experimentalNavigationItem__experimentalNavigationMenu__experimentalNavigationToggle__experimentalNoWrapper__experimentalPanelColorGradientSettings__experimentalPersistentListViewFeatures__experimentalPreviewOptions__experimentalRadio__experimentalRadioGroup__experimentalRegisterExperimentalCoreBlocks__experimentalSelector__experimentalSetIsInserterOpened__experimentalSetPreviewDeviceType__experimentalSpotlightEntityBlocks__experimentalText__experimentalUseCustomSides__experimentalUseDialog__experimentalUseResizeCanvas__experimentalUseSlotpackages/edit-widgets__experimentalBatch__experimentalFetchLinkSuggestions__experimentalGetCoreBlocks__experimentalGetDirtyEntityRecords__experimentalInsertionIndex__experimentalLabel__experimentalLibrary__experimentalParentSelector__experimentalRegisterExperimentalCoreBlocks__experimentalReusableBlocks__experimentalSetIsInserterOpened__experimentalToolbar__experimentalUseDialogpackages/editor__experimentalBlockDirectory__experimentalBlockPatternCategories__experimentalBlockPatterns__experimentalCanUserUseUnfilteredHTML__experimentalFeatures__experimentalFetchLinkSuggestions__experimentalGetDefaultTemplatePartAreas__experimentalGetDefaultTemplateType__experimentalGetDefaultTemplateTypes__experimentalGetDirtyEntityRecords__experimentalGetSettings__experimentalGetTemplateInfo__experimentalGlobalStylesBaseStyles__experimentalGlobalStylesUserEntityId__experimentalLocalAutosaveInterval__experimentalPreferredStyleVariations__experimentalRequestPostUpdateFinish__experimentalRequestPostUpdateStart__experimentalReusableBlocks__experimentalRichText__experimentalSaveSpecifiedEntityEdits__experimentalSetIsInserterOpened__experimentalShouldInsertAtTheTop__experimentalTearDownEditor__experimentalUndo__experimentalUseDialogpackages/eslint-plugin__experimentalFoo__experimentalSafe__experimentalUnsafepackages/format-library__experimentalLinkControl__experimentalUseEditorFeaturepackages/reusable-blocks__experimentalConvertBlockToStatic__experimentalConvertBlocksToReusable__experimentalDeleteReusableBlock__experimentalIsEditingReusableBlock__experimentalSetEditingReusableBlockpackages/rich-text__experimentalCreateOnChangeEditableValue__experimentalCreatePrepareEditableTree__experimentalGetPropsForEditableTreeChangeHandler__experimentalGetPropsForEditableTreePreparation__experimentalRichTextpackages/server-side-render__experimentalSanitizeBlockAttributeslib__experimentalBlockPatternCategories__experimentalBlockPatterns__experimentalBorder__experimentalDuotone__experimentalFeatures__experimentalFontFamily__experimentalFontStyle__experimentalFontWeight__experimentalGlobalStylesBaseStyles__experimentalGlobalStylesUserEntityId__experimentalLayout__experimentalNoWrapper__experimentalSelector__experimentalSkipFontSizeSerialization__experimentalSkipSerialization__experimentalTextDecoration__experimentalTextTransformThe text was updated successfully, but these errors were encountered: