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

Try: Remove segmented control vertical separators #35497

Merged
merged 4 commits into from
Oct 11, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
4 changes: 4 additions & 0 deletions packages/components/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Change
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I've seen a Change section in the changelog before. Maybe we can call it Enhancements for now? 🤷


- Removed the separator shown between items. ([#35497](https://github.com/WordPress/gutenberg/pull/35497)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably be a bit more specific

Suggested change
- Removed the separator shown between items. ([#35497](https://github.com/WordPress/gutenberg/pull/35497)).
- Removed the separator shown between `ToggleGroupControl` items ([#35497](https://github.com/WordPress/gutenberg/pull/35497)).


### Breaking Changes

- Removed the deprecated `position` and `menuLabel` from the `DropdownMenu` component ([#34537](https://github.com/WordPress/gutenberg/pull/34537)).
Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/toggle-group-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This feature is still experimental. “Experimental” means this is an early im

`ToggleGroupControl` is a form component that lets users choose options represented in horizontal segments. To render options for this control use `ToggleGroupControlOption` component.

Only use this control when you know for sure the labels of items inside won't wrap. For items with longer labels, you can consider a Dropdown component instead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Dropdown component is probably not what you meant here — did you mean SelectControl and/or CustomSelectControl?

In any case, if we mention a component's name, it's better to wrap it in backticks for better formatting.

Otherwise, the alternative here could be to be more generic and just mention "you can consider a select/dropdown component instead".

WDYT?


## Usage

```js
Expand Down Expand Up @@ -91,4 +93,4 @@ Label for the option. If needed, the `aria-label` prop can be used in addition t

- Type: `string | number`

The value of the `ToggleGroupControlOption`.
The value of the `ToggleGroupControlOption`.
11 changes: 0 additions & 11 deletions packages/components/src/toggle-group-control/styles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,17 +107,6 @@ export const ButtonContentView = styled.div`
transform: translate( -50%, -50% );
`;

export const SeparatorView = styled.div`
background: ${ CONFIG.colorDivider };
height: calc( 100% - 4px - 4px );
position: absolute;
right: 0;
top: 4px;
transition: background ${ CONFIG.transitionDuration } linear;
${ reduceMotion( 'transition' ) }
width: 1px;
`;

export const separatorActive = css`
background: transparent;
`;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,24 +152,6 @@ exports[`ToggleGroupControl should render correctly 1`] = `
visibility: hidden;
}

.emotion-15 {
background: rgba(0, 0, 0, 0.1);
height: calc( 100% - 4px - 4px );
position: absolute;
right: 0;
top: 4px;
-webkit-transition: background 200ms linear;
transition: background 200ms linear;
width: 1px;
background: transparent;
}

@media ( prefers-reduced-motion: reduce ) {
.emotion-15 {
transition-duration: 0ms;
}
}

<div
class="components-base-control emotion-0 emotion-1"
>
Expand Down Expand Up @@ -230,10 +212,6 @@ exports[`ToggleGroupControl should render correctly 1`] = `
R
</div>
</button>
<div
aria-hidden="true"
class="emotion-15 emotion-16"
/>
</div>
<div
class="emotion-8 emotion-9"
Expand Down Expand Up @@ -262,10 +240,6 @@ exports[`ToggleGroupControl should render correctly 1`] = `
J
</div>
</button>
<div
aria-hidden="true"
class="emotion-15 emotion-16"
/>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,13 @@ import * as styles from './styles';
import type { ToggleGroupControlButtonProps } from './types';
import { useCx } from '../utils/hooks';

const {
ButtonContentView,
LabelPlaceholderView,
LabelView,
SeparatorView,
} = styles;
const { ButtonContentView, LabelPlaceholderView, LabelView } = styles;

function ToggleGroupControlButton( {
className,
forwardedRef,
isBlock = false,
label,
showSeparator,
value,
...props
}: ToggleGroupControlButtonProps ) {
Expand Down Expand Up @@ -56,17 +50,8 @@ function ToggleGroupControlButton( {
{ label }
</LabelPlaceholderView>
</Radio>
<ToggleGroupControlSeparator isActive={ ! showSeparator } />
</LabelView>
);
}

const ToggleGroupControlSeparator = memo(
( { isActive }: { isActive: boolean } ) => {
const cx = useCx();
const classes = cx( isActive && styles.separatorActive );
return <SeparatorView aria-hidden className={ classes } />;
}
);

export default memo( ToggleGroupControlButton );
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,9 @@ import {
WordPressComponentProps,
} from '../ui/context';
import ToggleGroupControlButton from './toggle-group-control-button';
import type {
ToggleGroupControlOptionProps,
ToggleGroupControlContextProps,
} from './types';
import type { ToggleGroupControlOptionProps } from './types';
import { useToggleGroupControlContext } from './toggle-group-control-context';

function getShowSeparator(
toggleGroupControlContext: ToggleGroupControlContextProps,
index: number
) {
const { currentId, items, state } = toggleGroupControlContext;
if ( items.length < 3 ) {
return false;
}
const targetNodeExists =
items.find( ( { id } ) => id === currentId )?.ref?.current?.dataset
?.value === state;
const isLast = index === items.length - 1;
// If no target node exists, don't show the separator after the last item.
if ( ! targetNodeExists ) {
return ! isLast;
}
const isActive = items[ index ]?.id === currentId;
const isNextActive = items[ index + 1 ]?.id === currentId;
return ! ( isActive || isNextActive || isLast );
}

function ToggleGroupControlOption(
props: WordPressComponentProps< ToggleGroupControlOptionProps, 'input' >,
forwardedRef: import('react').Ref< any >
Expand All @@ -53,17 +29,12 @@ function ToggleGroupControlOption(
{ ...props, id },
'ToggleGroupControlOption'
);
const index = toggleGroupControlContext.items.findIndex(
( item ) => item.id === buttonProps.id
);
const showSeparator = getShowSeparator( toggleGroupControlContext, index );
return (
<ToggleGroupControlButton
ref={ forwardedRef }
{ ...{
...toggleGroupControlContext,
...buttonProps,
showSeparator,
} }
/>
);
Expand Down
1 change: 0 additions & 1 deletion packages/components/src/toggle-group-control/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ export type ToggleGroupControlButtonProps = {
isBlock?: boolean;
label: string;
'aria-label'?: string;
showSeparator?: boolean;
value?: ReactText;
state?: any;
};
Expand Down