Skip to content
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

Audit experimental APIs for WP 6.4 #54220

Closed
17 of 19 tasks
SiobhyB opened this issue Sep 6, 2023 · 11 comments
Closed
17 of 19 tasks

Audit experimental APIs for WP 6.4 #54220

SiobhyB opened this issue Sep 6, 2023 · 11 comments
Labels
Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues.

Comments

@SiobhyB
Copy link
Contributor

SiobhyB commented Sep 6, 2023

New (or renamed) APIs since 6.3

Here are all the new uses of __experimental that are new or have been renamed since 6.4 (for reference, the previous API audit was in #51315).

If you're pinged here, could you take a look at these and see if they're ready for stabilisation, if they should go into 6.4 at all, if they can be marked private, or if no action is needed? Please check the box when you're done. Thank you! 🙇‍♀️

lib

packages/block-editor

packages/block-library

packages/blocks

packages/edit-site

packages/block-editor

packages/patterns

Removed since 6.3

__experimentalEnablePatternEnhancements (reverted in Gutenberg, wasn't included in 6.3)
__experimentalInteractivityAPI (reverted in Gutenberg, wasn't included in 6.3)
__experimentalLayoutStyle (made private)
__experimentaluseLayoutClasses (made private)
__experimentaluseLayoutStyles (made private)
__experimentalGetUnprocessedBlockTypes (made private, renamed to getUnprocessedBlockTypes)
__experimentalReapplyBlockTypeFilters (deprecated)
__experimentalRegisterBlockType (made private, renamed to addUnprocessedBlock)
__experimentalTheme (made private)
__experimentalInjectInteractivityRuntime (reverted in Gutenberg, wasn't included in 6.3)

All experimental APIs

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

__experimentalBlockHooks
__experimentalBorder
__experimentalCollaborativeEditingSecret
__experimentalConnections
__experimentalDefault
__experimentalDisableTinymce
__experimentalDuotone
__experimentalEnableColorRandomizer
__experimentalEnableGroupGridVariation
__experimentalEnableListBlockV2
__experimentalEnableQuoteBlockV2
__experimentalEnableSync
__experimentalEnableZoomedOutView
__experimentalFeatures
__experimentalFontFamily
__experimentalFontStyle
__experimentalFontWeight
__experimentalLayout
__experimentalLetterSpacing
__experimentalSelector
__experimentalSettings
__experimentalStyle
__experimentalStyles
__experimentalTextDecoration
__experimentalTextTransform
__experimentalWritingMode

packages/annotations

__experimentalAddAnnotation
__experimentalCreateOnChangeEditableValue
__experimentalCreatePrepareEditableTree
__experimentalGetAllAnnotationsForBlock
__experimentalGetAnnotations
__experimentalGetAnnotationsForBlock
__experimentalGetAnnotationsForRichText
__experimentalGetPropsForEditableTreeChangeHandler
__experimentalGetPropsForEditableTreePreparation
__experimentalRemoveAnnotation
__experimentalRemoveAnnotationsBySource
__experimentalUpdateAnnotationRange

packages/block-directory

__experimentalIsFocusable

packages/block-editor

__experimentalAlignmentMatrixControl
__experimentalAppenderTagName
__experimentalBehaviorsPanel
__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
__experimentalLetterSpacingControl
__experimentalLibrary
__experimentalLinkControl
__experimentalLinkControlSearchInput
__experimentalLinkControlSearchItem
__experimentalLinkControlSearchResults
__experimentalListView
__experimentalMetadata
__experimentalMinHeight
__experimentalNavigatorBackButton
__experimentalNavigatorButton
__experimentalNavigatorProvider
__experimentalNavigatorScreen
__experimentalNumberControl
__experimentalOnIndexChange
__experimentalOnMerge
__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
__experimentalUseGlobalBehaviors
__experimentalUseGradient
__experimentalUseHasBehaviorsPanel
__experimentalUseHasRecursion
__experimentalUseMultipleOriginColorsAndGradients
__experimentalUseResizeCanvas
__experimentalUseSlotFills
__experimentalVStack
__experimentalVersion
__experimentalView
__experimentalWritingModeControl
__experimentalZStack

packages/block-library

__experimentalArchiveTitleNameLabel
__experimentalArchiveTitleTypeLabel
__experimentalConvert
__experimentalDiscussionSettings
__experimentalGetCoreBlocks
__experimentalGetDefaultTemplatePartAreas
__experimentalInputControl
__experimentalIsEditingReusableBlock
__experimentalOnEnter
__experimentalRegisterExperimentalCoreBlocks
__experimentalShowHowTo
__experimentalShowTooltip
__experimentalTooltipProps

packages/blocks

__experimentalReapplyBlockFilters
__experimentalSanitizeBlockAttributes

packages/commands

__experimentalHideHeader

packages/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
__experimentalToggleGroupControlOptionBase
__experimentalUseDialog
__experimentalUseDragging
__experimentalUseFocusOutside
__experimentalUseNavigator
__experimentalUseSlot
__experimentalValidateInput

packages/compose

__experimentalWidthProvider

packages/core-data

__experimentalBatch
__experimentalFetchUrlData
__experimentalGetCurrentGlobalStylesId
__experimentalGetCurrentThemeBaseGlobalStyles
__experimentalGetCurrentThemeGlobalStylesVariations
__experimentalGetDirtyEntityRecords
__experimentalGetEntitiesBeingSaved
__experimentalGetEntityRecordNoResolver
__experimentalGetTemplateForLink
__experimentalNoFetch
__experimentalReceiveCurrentGlobalStylesId
__experimentalReceiveThemeBaseGlobalStyles
__experimentalReceiveThemeGlobalStyleVariations
__experimentalSaveSpecifiedEntityEdits
__experimentalUseEntityRecord
__experimentalUseEntityRecords
__experimentalUseResourcePermissions

packages/customize-widgets

__experimentalGetInsertionPoint

packages/date

__experimentalGetSettings

packages/e2e-test-utils

__experimentalActivatePlugin
__experimentalDeactivatePlugin
__experimentalRest

packages/edit-post

__experimentalFullscreenModeClose
__experimentalGetPreviewDeviceType
__experimentalMainDashboardButton
__experimentalSetPreviewDeviceType

packages/edit-site

__experimentalAdditionalBlockPatternCategories
__experimentalAdditionalBlockPatterns
__experimentalDashboardLink
__experimentalDeleteReusableBlock
__experimentalGetDefaultTemplateTypes
__experimentalGetTemplateInfo

packages/editor

__experimentalCreatePageEntity
__experimentalGetDefaultTemplateType
__experimentalTearDownEditor
__experimentalUserCanCreatePages

packages/patterns

__experimentalConvertSyncedPatternToStatic
__experimentalCreatePattern
__experimentalIsEditingPattern
__experimentalSetEditingPattern

packages/reusable-blocks

__experimentalConvertBlocksToReusable
__experimentalSetEditingReusableBlock

@SiobhyB SiobhyB added Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues. labels Sep 6, 2023
@SiobhyB SiobhyB moved this to In Progress in WordPress 6.4 Editor Tasks Sep 6, 2023
@youknowriad
Copy link
Contributor

  • __experimentalCollaborativeEditingSecret
  • __experimentalEnableSync

Both of these are used behind a feature flag for a feature that is not meant to land to Core yet. So there's nothing to be done here at the moment.

@ockham
Copy link
Contributor

ockham commented Sep 6, 2023

__experimentalBlockHooks: These are slated for inclusion in WP 6.4; I'm currently working on stabilizing them. Planning to remove the __experimental prefix in time for GB 16.7 RC1.

@carolinan
Copy link
Contributor

What are the criteria for each of these options?

@jsnajdr
Copy link
Member

jsnajdr commented Sep 7, 2023

__experimentalReapplyBlockFilters shouldn't be on the list. It's not new, it was in fact stabilized last week, and there is a new stable reapplyBlockFilters action. But we're keeping a deprecated alias with the __experimental prefix, for backward compatibility.

@tyxla
Copy link
Member

tyxla commented Sep 7, 2023

__experimentalDisableTinymce is used under the gutenberg-no-tinymce feature flag, and that feature is not yet ready to land in the WordPress core. Nothing is to be done at this time, so marking as checked to indicate no action is needed.

@ellatrix
Copy link
Member

ellatrix commented Sep 7, 2023

__experimentalOnMerge has just been introduced. Let's give it more time, and I'm actually working on refactoring onSplit for blocks, so we can look at naming this better afterwards.

@michalczaplinski
Copy link
Contributor

Answering for @c4rl0sbr4v0 who is on parental leave:

__experimentalBehaviorsPanel @c4rl0sbr4v0
__experimentalUseGlobalBehaviors @c4rl0sbr4v0
__experimentalUseHasBehaviorsPanel @c4rl0sbr4v0

__experimentalConnections @c4rl0sbr4v0

  • Should not be stabilized as it is still experimental and behind a feature flag.

I've checked all the related items on the list above.

@glendaviesnz
Copy link
Contributor

I have added a PR to rename __experimentalConvertSyncedPatternToStatic, __experimentalCreatePattern, __experimentalIsEditingPattern, __experimentalSetEditingPattern as the patterns package doesn't currently export these anyway.

@adamziel
Copy link
Contributor

adamziel commented Sep 28, 2023

I'm listed next to the __experimentalDeleteReusableBlock API but I don't think I've done any work on this, especially since I was away for the last 3 months. @aaronrobertshaw shows up in git history.

@aaronrobertshaw
Copy link
Contributor

Regarding __experimentalDeleteReusableBlock, the renaming of reusable blocks to patterns within code should be addressed soon. It makes more sense to hold off on stabilising this until that renaming is complete.

@SiobhyB
Copy link
Contributor Author

SiobhyB commented Oct 3, 2023

Thanks for your replies, all! I'll go ahead to close this ticket as we're on beta 2 of the release, and any new stabilisations would have been done before beta 1.

@SiobhyB SiobhyB closed this as completed Oct 3, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in WordPress 6.4 Editor Tasks Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues.
Projects
No open projects
Status: Done
Development

No branches or pull requests