Skip to content

Components: Refactor ToggleGroupControl and Auto-generate README.md #69970

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.

Sign up for GitHub

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

Draft
im3dabasia wants to merge 2 commits into
base: trunk
Choose a base branch
from
Draft

Components: Refactor ToggleGroupControl and Auto-generate README.md #69970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f52267
feat: Reorganise exports and regenerate readme
im3dabasia Apr 23, 2025
593f785
revert: Changes in docs/manifest.json
im3dabasia Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions packages/block-editor/src/components/background-image-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import clsx from 'clsx';
import {
ToggleControl,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
__experimentalUnitControl as UnitControl,
__experimentalVStack as VStack,
DropZone,
Expand Down Expand Up @@ -580,23 +579,23 @@ function BackgroundSizeControls( {
sizeValue || defaultValues?.backgroundSize
) }
>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="cover"
value="cover"
label={ _x(
'Cover',
'Size option for background image control'
) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="contain"
value="contain"
label={ _x(
'Contain',
'Size option for background image control'
) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="tile"
value="auto"
label={ _x(
Expand Down
3 changes: 1 addition & 2 deletions packages/block-editor/src/components/block-variation-transforms/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
MenuGroup,
MenuItemsChoice,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
VisuallyHidden,
} from '@wordpress/components';
import { useSelect, useDispatch } from '@wordpress/data';
Expand Down Expand Up @@ -115,7 +114,7 @@ function VariationsToggleGroupControl( {
__nextHasNoMarginBottom
>
{ variations.map( ( variation ) => (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ variation.name }
icon={
<BlockIcon icon={ variation.icon } showColors />
Expand Down
7 changes: 3 additions & 4 deletions packages/block-editor/src/components/child-layout-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
*/
import {
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
__experimentalUnitControl as UnitControl,
__experimentalInputControl as InputControl,
__experimentalHStack as HStack,
Expand Down Expand Up @@ -152,23 +151,23 @@ function FlexControls( {
} }
isBlock
>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="fit"
value="fit"
label={ _x(
'Fit',
'Intrinsic block width in flex layout'
) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="fill"
value="fill"
label={ _x(
'Grow',
'Block with expanding width in flex layout'
) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="fixed"
value="fixed"
label={ _x(
Expand Down
3 changes: 1 addition & 2 deletions packages/block-editor/src/components/dimensions-tool/scale-tool.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
import {
__experimentalToolsPanelItem as ToolsPanelItem,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
} from '@wordpress/components';
import { useMemo } from '@wordpress/element';
import { __, _x } from '@wordpress/i18n';
Expand Down Expand Up @@ -114,7 +113,7 @@ export default function ScaleTool( {
size="__unstable-large"
>
{ options.map( ( option ) => (
<ToggleGroupControlOption
<ToggleGroupControl.Option
key={ option.value }
{ ...option }
/>
Expand Down
3 changes: 1 addition & 2 deletions packages/block-editor/src/components/image-size-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import {
__experimentalNumberControl as NumberControl,
__experimentalHStack as HStack,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
} from '@wordpress/components';
import { __, sprintf } from '@wordpress/i18n';

Expand Down Expand Up @@ -134,7 +133,7 @@ export default function ImageSizeControl( {
>
{ IMAGE_SIZE_PRESETS.map( ( scale ) => {
return (
<ToggleGroupControlOption
<ToggleGroupControl.Option
key={ scale }
value={ scale }
label={ sprintf(
Expand Down
7 changes: 2 additions & 5 deletions packages/block-editor/src/components/text-alignment-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ import {
alignJustify,
} from '@wordpress/icons';
import { useMemo } from '@wordpress/element';
import {
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
} from '@wordpress/components';
import { __experimentalToggleGroupControl as ToggleGroupControl } from '@wordpress/components';

const TEXT_ALIGNMENT_OPTIONS = [
{
Expand Down Expand Up @@ -90,7 +87,7 @@ export default function TextAlignmentControl( {
>
{ validOptions.map( ( option ) => {
return (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ option.value }
value={ option.value }
icon={ option.icon }
Expand Down
7 changes: 2 additions & 5 deletions packages/block-editor/src/components/text-decoration-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ import clsx from 'clsx';
*/
import { reset, formatStrikethrough, formatUnderline } from '@wordpress/icons';
import { __ } from '@wordpress/i18n';
import {
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
} from '@wordpress/components';
import { __experimentalToggleGroupControl as ToggleGroupControl } from '@wordpress/components';

const TEXT_DECORATIONS = [
{
Expand Down Expand Up @@ -63,7 +60,7 @@ export default function TextDecorationControl( {
>
{ TEXT_DECORATIONS.map( ( option ) => {
return (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ option.value }
value={ option.value }
icon={ option.icon }
Expand Down
7 changes: 2 additions & 5 deletions packages/block-editor/src/components/text-transform-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@ import {
formatLowercase,
formatUppercase,
} from '@wordpress/icons';
import {
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
} from '@wordpress/components';
import { __experimentalToggleGroupControl as ToggleGroupControl } from '@wordpress/components';

const TEXT_TRANSFORMS = [
{
Expand Down Expand Up @@ -69,7 +66,7 @@ export default function TextTransformControl( { className, value, onChange } ) {
>
{ TEXT_TRANSFORMS.map( ( option ) => {
return (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ option.value }
value={ option.value }
icon={ option.icon }
Expand Down
7 changes: 2 additions & 5 deletions packages/block-editor/src/components/writing-mode-control/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ import clsx from 'clsx';
*/
import { __, isRTL } from '@wordpress/i18n';
import { textHorizontal, textVertical } from '@wordpress/icons';
import {
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
} from '@wordpress/components';
import { __experimentalToggleGroupControl as ToggleGroupControl } from '@wordpress/components';

const WRITING_MODES = [
{
Expand Down Expand Up @@ -51,7 +48,7 @@ export default function WritingModeControl( { className, value, onChange } ) {
>
{ WRITING_MODES.map( ( option ) => {
return (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ option.value }
value={ option.value }
icon={ option.icon }
Expand Down
3 changes: 1 addition & 2 deletions packages/block-editor/src/hooks/layout.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { getBlockSupport, hasBlockSupport } from '@wordpress/blocks';
import { useSelect } from '@wordpress/data';
import {
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
ToggleControl,
PanelBody,
privateApis as componentsPrivateApis,
Expand Down Expand Up @@ -327,7 +326,7 @@ function LayoutTypeSwitcher( { type, onChange } ) {
>
{ getLayoutTypes().map( ( { name, label } ) => {
return (
<ToggleGroupControlOption
<ToggleGroupControl.Option
key={ name }
value={ name }
label={ label }
Expand Down
3 changes: 1 addition & 2 deletions packages/block-editor/src/layouts/constrained.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import {
__experimentalUseCustomUnits as useCustomUnits,
__experimentalUnitControl as UnitControl,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
__experimentalInputControlPrefixWrapper as InputControlPrefixWrapper,
__experimentalVStack as VStack,
} from '@wordpress/components';
Expand Down Expand Up @@ -139,7 +138,7 @@ export default {
{ justificationOptions.map(
( { value, icon, label } ) => {
return (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ value }
value={ value }
icon={ icon }
Expand Down
7 changes: 3 additions & 4 deletions packages/block-editor/src/layouts/flex.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import {
Flex,
FlexItem,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
} from '@wordpress/components';

/**
Expand Down Expand Up @@ -301,7 +300,7 @@ function FlexLayoutJustifyContentControl( {
>
{ justificationOptions.map( ( { value, icon, label } ) => {
return (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ value }
value={ value }
icon={ icon }
Expand Down Expand Up @@ -370,12 +369,12 @@ function OrientationControl( { layout, onChange } ) {
} );
} }
>
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
icon={ arrowRight }
value="horizontal"
label={ __( 'Horizontal' ) }
/>
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
icon={ arrowDown }
value="vertical"
label={ __( 'Vertical' ) }
Expand Down
5 changes: 2 additions & 3 deletions packages/block-editor/src/layouts/grid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import {
RangeControl,
__experimentalNumberControl as NumberControl,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
__experimentalUnitControl as UnitControl,
__experimentalParseQuantityAndUnitFromRawValue as parseQuantityAndUnitFromRawValue,
__experimentalVStack as VStack,
Expand Down Expand Up @@ -470,12 +469,12 @@ function GridLayoutTypeControl( { layout, onChange } ) {
: undefined
}
>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="auto"
value="auto"
label={ __( 'Auto' ) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
key="manual"
value="manual"
label={ __( 'Manual' ) }
Expand Down
3 changes: 1 addition & 2 deletions packages/block-library/src/button/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import {
__experimentalToolsPanel as ToolsPanel,
__experimentalToolsPanelItem as ToolsPanelItem,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
} from '@wordpress/components';
import {
AlignmentControl,
Expand Down Expand Up @@ -151,7 +150,7 @@ function WidthPanel( { selectedWidth, setAttributes } ) {
>
{ [ 25, 50, 75, 100 ].map( ( widthValue ) => {
return (
<ToggleGroupControlOption
<ToggleGroupControl.Option
key={ widthValue }
value={ widthValue }
label={ sprintf(
Expand Down
11 changes: 4 additions & 7 deletions packages/block-library/src/comments-pagination/comments-pagination-arrow-controls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,7 @@
* WordPress dependencies
*/
import { __, _x } from '@wordpress/i18n';
import {
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
} from '@wordpress/components';
import { __experimentalToggleGroupControl as ToggleGroupControl } from '@wordpress/components';

export function CommentsPaginationArrowControls( { value, onChange } ) {
return (
Expand All @@ -20,21 +17,21 @@ export function CommentsPaginationArrowControls( { value, onChange } ) {
) }
isBlock
>
<ToggleGroupControlOption
<ToggleGroupControl.Option
value="none"
label={ _x(
'None',
'Arrow option for Comments Pagination Next/Previous blocks'
) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
value="arrow"
label={ _x(
'Arrow',
'Arrow option for Comments Pagination Next/Previous blocks'
) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
value="chevron"
label={ _x(
'Chevron',
Expand Down
3 changes: 1 addition & 2 deletions packages/block-library/src/latest-posts/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import {
ToggleControl,
ToolbarGroup,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOptionIcon as ToggleGroupControlOptionIcon,
__experimentalToolsPanel as ToolsPanel,
__experimentalToolsPanelItem as ToolsPanelItem,
} from '@wordpress/components';
Expand Down Expand Up @@ -385,7 +384,7 @@ function Controls( { attributes, setAttributes, postCount } ) {
{ imageAlignmentOptions.map(
( { value, icon, label } ) => {
return (
<ToggleGroupControlOptionIcon
<ToggleGroupControl.OptionIcon
key={ value }
value={ value }
icon={ icon }
Expand Down
7 changes: 3 additions & 4 deletions packages/block-library/src/navigation/edit/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ import {
PanelBody,
ToggleControl,
__experimentalToggleGroupControl as ToggleGroupControl,
__experimentalToggleGroupControlOption as ToggleGroupControlOption,
Button,
Spinner,
Notice,
Expand Down Expand Up @@ -649,15 +648,15 @@ function Navigation( {
}
isBlock
>
<ToggleGroupControlOption
<ToggleGroupControl.Option
value="never"
label={ __( 'Off' ) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
value="mobile"
label={ __( 'Mobile' ) }
/>
<ToggleGroupControlOption
<ToggleGroupControl.Option
value="always"
label={ __( 'Always' ) }
/>
Expand Down
Loading
Loading