Skip to content

Add gap prop to ActionBar for customizable spacing between items #7000

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

Merged
pksjce merged 7 commits into from
Oct 16, 2025
Merged

Add gap prop to ActionBar for customizable spacing between items #7000

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3158b20
feat: add gap prop to ActionBar for customizable spacing between items
pksjce Oct 14, 2025
1fe5bcc
Add gap prop to ActionBar
pksjce Oct 14, 2025
fcfce1e
Add some copi tests
pksjce Oct 14, 2025
cfe4386
Merge branch 'main' into pk/actionbar-gap
pksjce Oct 14, 2025
20e282c
Use condensed and none for gap values
pksjce Oct 15, 2025
e095719
Remove unnecessary copi comment
pksjce Oct 16, 2025
eb7541e
Merge branch 'main' into pk/actionbar-gap
pksjce Oct 16, 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
25 changes: 25 additions & 0 deletions packages/react/src/ActionBar/ActionBar.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,15 @@ Playground.argTypes = {
type: 'boolean',
},
},
gap: {
control: {type: 'number', min: 0, max: 8, step: 1},
description: 'Horizontal gap in pixels between items (0–8).',
},
}
Playground.args = {
size: 'medium',
flush: false,
gap: 8,
}

export const Default = () => (
Expand Down Expand Up @@ -93,3 +98,23 @@ export const DeepChildTree = () => (
<AdvancedFormattingButtons />
</ActionBar>
)

export const GapExamples = () => (
<div style={{display: 'flex', flexDirection: 'column', gap: 16}}>
<ActionBar aria-label="Toolbar gap 0" gap={0}>
<ActionBar.IconButton icon={BoldIcon} aria-label="Bold" />
<ActionBar.IconButton icon={ItalicIcon} aria-label="Italic" />
<ActionBar.IconButton icon={CodeIcon} aria-label="Code" />
</ActionBar>
<ActionBar aria-label="Toolbar gap 4" gap={4}>
<ActionBar.IconButton icon={BoldIcon} aria-label="Bold" />
<ActionBar.IconButton icon={ItalicIcon} aria-label="Italic" />
<ActionBar.IconButton icon={CodeIcon} aria-label="Code" />
</ActionBar>
<ActionBar aria-label="Toolbar gap 8" gap={8}>
<ActionBar.IconButton icon={BoldIcon} aria-label="Bold" />
<ActionBar.IconButton icon={ItalicIcon} aria-label="Italic" />
<ActionBar.IconButton icon={CodeIcon} aria-label="Code" />
</ActionBar>
</div>
)
27 changes: 21 additions & 6 deletions packages/react/src/ActionBar/ActionBar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,18 +79,29 @@ export type ActionBarProps = {

/** Custom className */
className?: string

/**
* Horizontal gap in pixels between items. Capped at 8 to align with design spacing.
* @default 8
*/
gap?: number
} & A11yProps

export type ActionBarIconButtonProps = {disabled?: boolean} & IconButtonProps

const MORE_BTN_WIDTH = 32

const calculatePossibleItems = (registryEntries: Array<[string, ChildProps]>, navWidth: number, moreMenuWidth = 0) => {
const calculatePossibleItems = (
registryEntries: Array<[string, ChildProps]>,
navWidth: number,
gap: number,
moreMenuWidth = 0,
) => {
const widthToFit = navWidth - moreMenuWidth
let breakpoint = registryEntries.length // assume all items will fit
let sumsOfChildWidth = 0
for (const [index, [, child]] of registryEntries.entries()) {
sumsOfChildWidth += index > 0 ? child.width + ACTIONBAR_ITEM_GAP : child.width
sumsOfChildWidth += index > 0 ? child.width + gap : child.width
if (sumsOfChildWidth > widthToFit) {
breakpoint = index
break
Expand All @@ -106,15 +117,17 @@ const getMenuItems = (
moreMenuWidth: number,
childRegistry: ChildRegistry,
hasActiveMenu: boolean,
gap: number,
): Set<string> | void => {
const registryEntries = Array.from(childRegistry).filter((entry): entry is [string, ChildProps] => entry[1] !== null)

if (registryEntries.length === 0) return new Set()
const numberOfItemsPossible = calculatePossibleItems(registryEntries, navWidth)
const numberOfItemsPossible = calculatePossibleItems(registryEntries, navWidth, gap)

const numberOfItemsPossibleWithMoreMenu = calculatePossibleItems(
registryEntries,
navWidth,
gap,
moreMenuWidth || MORE_BTN_WIDTH,
)
const menuItems = new Set<string>()
Expand Down Expand Up @@ -151,7 +164,9 @@ const getMenuItems = (
}

export const ActionBar: React.FC<React.PropsWithChildren<ActionBarProps>> = props => {
const {size = 'medium', children, 'aria-label': ariaLabel, flush = false, className} = props
const {size = 'medium', children, 'aria-label': ariaLabel, flush = false, className, gap} = props

const itemGap = Math.min(Math.max(gap ?? ACTIONBAR_ITEM_GAP, 0), ACTIONBAR_ITEM_GAP)

@pksjce pksjce Oct 14, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This keeps it between 0 and 8


const [childRegistry, setChildRegistry] = useState<ChildRegistry>(() => new Map())

Expand All @@ -175,7 +190,7 @@ export const ActionBar: React.FC<React.PropsWithChildren<ActionBarProps>> = prop
const hasActiveMenu = menuItemIds.size > 0

if (navWidth > 0) {
const newMenuItemIds = getMenuItems(navWidth, moreMenuWidth, childRegistry, hasActiveMenu)
const newMenuItemIds = getMenuItems(navWidth, moreMenuWidth, childRegistry, hasActiveMenu, itemGap)
if (newMenuItemIds) setMenuItemIds(newMenuItemIds)
}
}, navRef as RefObject<HTMLElement>)
Expand Down Expand Up @@ -219,7 +234,7 @@ export const ActionBar: React.FC<React.PropsWithChildren<ActionBarProps>> = prop
return (
<ActionBarContext.Provider value={{size, registerChild, unregisterChild, isVisibleChild}}>
<div ref={navRef} className={clsx(className, styles.Nav)} data-flush={flush}>
<div ref={listRef} role="toolbar" className={styles.List} style={{gap: `${ACTIONBAR_ITEM_GAP}px`}}>
<div ref={listRef} role="toolbar" className={styles.List} style={{gap: `${itemGap}px`}}>
{children}
{menuItemIds.size > 0 && (
<ActionMenu>
Expand Down
Loading