Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
7 changes: 7 additions & 0 deletions .changeset/feat-buttongroup-forward-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@clickhouse/click-ui': patch
---

Add forwardRef support to ButtonGroup component

Exposes the wrapper div ref via React.forwardRef, following component library conventions.
12 changes: 12 additions & 0 deletions src/components/ButtonGroup/ButtonGroup.test.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { createRef } from 'react';
import { fireEvent } from '@testing-library/react';
import { ButtonGroup } from '@/components/ButtonGroup';
import type { ButtonGroupProps, SelectionValue } from '@/components/ButtonGroup';
Expand All @@ -20,6 +21,17 @@ describe('ButtonGroup', () => {
});
});

it('forwards ref to the wrapper div', () => {
const ref = createRef<HTMLDivElement>();
renderCUI(
<ButtonGroup
options={options}
ref={ref}
/>
);
expect(ref.current).toBeInstanceOf(HTMLDivElement);
});

it('calls onClick handler when a button is clicked', () => {
let counter = 0;
const handleClick = () => (counter = 1);
Expand Down
146 changes: 76 additions & 70 deletions src/components/ButtonGroup/ButtonGroup.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useCallback, useState } from 'react';
import { useCallback, useState, forwardRef } from 'react';
import { styled } from 'styled-components';
import { ButtonGroupProps, SelectionValue } from './ButtonGroup.types';
import { ButtonGroupProps, ButtonGroupType, SelectionValue } from './ButtonGroup.types';

const normalizeToSet = (value: SelectionValue | undefined): Set<string> => {
if (value === undefined) {
Expand All @@ -16,86 +16,92 @@ const isValueSelected = (value: string, selection: Set<string>): boolean => {
return selection.has(value);
};

export const ButtonGroup = ({
options,
selected,
defaultSelected,
fillWidth = false,
onClick,
type = 'default',
multiple = false,
...props
}: ButtonGroupProps) => {
const [internalSelection, setInternalSelection] = useState<Set<string>>(() =>
normalizeToSet(defaultSelected)
);

// Use `selected` if the parent needs to own
// or sync the selection state management (controlled
// by consumer app)
// Use `defaultSelected` if the component can manage
// its own state independently (uncontrolled)
const isControlled = selected !== undefined;
const currentSelection = isControlled ? normalizeToSet(selected) : internalSelection;

const onButtonGroupClickCommonHandler = useCallback(
(value: string) => {
let newSelection: Set<string>;

if (multiple) {
newSelection = new Set(currentSelection);
if (newSelection.has(value)) {
newSelection.delete(value);
export const ButtonGroup = forwardRef<HTMLDivElement, ButtonGroupProps>(
(
{
options,
selected,
defaultSelected,
fillWidth = false,
onClick,
type = 'default',
multiple = false,
...props
},
ref
) => {
const [internalSelection, setInternalSelection] = useState<Set<string>>(() =>
normalizeToSet(defaultSelected)
);

// Use `selected` if the parent needs to own
// or sync the selection state management (controlled
// by consumer app)
// Use `defaultSelected` if the component can manage
// its own state independently (uncontrolled)
const isControlled = selected !== undefined;
const currentSelection = isControlled ? normalizeToSet(selected) : internalSelection;

const onButtonGroupClickCommonHandler = useCallback(
(value: string) => {
let newSelection: Set<string>;

if (multiple) {
newSelection = new Set(currentSelection);
if (newSelection.has(value)) {
newSelection.delete(value);
} else {
newSelection.add(value);
}
} else {
newSelection.add(value);
newSelection = new Set([value]);
}
} else {
newSelection = new Set([value]);
}

if (!isControlled) {
setInternalSelection(newSelection);
}
if (!isControlled) {
setInternalSelection(newSelection);
}

// WARN: Single mode returns string
// while multiple mode returns Set (DS)
onClick?.(value, multiple ? newSelection : value);
},
[currentSelection, multiple, isControlled, onClick]
);
// WARN: Single mode returns string
// while multiple mode returns Set (DS)
onClick?.(value, multiple ? newSelection : value);
},
[currentSelection, multiple, isControlled, onClick]
);

const buttons = options.map(({ value, label, ...buttonProps }) => {
const isActive = isValueSelected(value, currentSelection);
const buttons = options.map(({ value, label, ...buttonProps }) => {
const isActive = isValueSelected(value, currentSelection);

return (
<Button
key={value}
$active={isActive}
aria-pressed={isActive}
$fillWidth={fillWidth}
$type={type}
onClick={() => onButtonGroupClickCommonHandler(value)}
role="button"
{...buttonProps}
>
{label}
</Button>
);
});

return (
<Button
key={value}
$active={isActive}
aria-pressed={isActive}
<ButtonGroupWrapper
ref={ref}
{...props}
$fillWidth={fillWidth}
$type={type}
onClick={() => onButtonGroupClickCommonHandler(value)}
role="button"
{...buttonProps}
role="group"
>
{label}
</Button>
{buttons}
</ButtonGroupWrapper>
);
});

return (
<ButtonGroupWrapper
{...props}
$fillWidth={fillWidth}
$type={type}
role="group"
>
{buttons}
</ButtonGroupWrapper>
);
};
}
);

import { ButtonGroupType } from './ButtonGroup.types';
ButtonGroup.displayName = 'ButtonGroup';

const ButtonGroupWrapper = styled.div<{ $fillWidth: boolean; $type: ButtonGroupType }>`
display: inline-flex;
Expand Down
Loading