Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(core): honor numeric MetadataList columns with stacked labels (#4727) (#4730)

Cindy Zhang276533bdd7b4
diff --git a/.changeset/metadatalist-numeric-columns-stacked.md b/.changeset/metadatalist-numeric-columns-stacked.md
new file mode 100644
index 0000000000..89811037e8
--- /dev/null
+++ b/.changeset/metadatalist-numeric-columns-stacked.md
@@ -0,0 +1,6 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] MetadataList: a numeric `columns` value is honored with stacked labels. `columns={3}` previously fell back to the responsive `repeat(auto-fill, minmax(280px, 1fr))` grid whenever labels were stacked (the default for multi-column lists), so the documented fixed column count only worked with `label={{position: 'start'}}`. The grid template now covers both label positions — `repeat(n, 1fr)` for stacked labels, `repeat(n, auto 1fr)` for side labels — and resolves through a StyleX dynamic style instead of an inline `style` object.
+@cixzhang
diff --git a/packages/core/src/MetadataList/MetadataList.test.tsx b/packages/core/src/MetadataList/MetadataList.test.tsx
index c2c23e6fc6..992afb0535 100644
--- a/packages/core/src/MetadataList/MetadataList.test.tsx
+++ b/packages/core/src/MetadataList/MetadataList.test.tsx
@@ -123,6 +123,64 @@ describe('MetadataList', () => {
expect(screen.getByText('A')).toBeInTheDocument();
expect(screen.getByText('B')).toBeInTheDocument();
});
+
+ describe('numeric columns', () => {
+ // A fixed column count is a runtime value, so it arrives as a StyleX
+ // dynamic style: the template lands in the element's inline style (as the
+ // generated custom property) rather than in a static class rule.
+ const gridTemplateOf = (container: HTMLElement) =>
+ container.querySelector('dl')?.getAttribute('style') ?? '';
+
+ it('renders the requested number of columns with stacked labels', () => {
+ const {container} = render(
+ <MetadataList columns={3}>
+ <MetadataListItem label="A">1</MetadataListItem>
+ </MetadataList>,
+ );
+
+ expect(gridTemplateOf(container)).toContain('repeat(3, 1fr)');
+ });
+
+ it('renders label and value tracks per column with side labels', () => {
+ const {container} = render(
+ <MetadataList columns={3} label={{position: 'start'}}>
+ <MetadataListItem label="A">1</MetadataListItem>
+ </MetadataList>,
+ );
+
+ expect(gridTemplateOf(container)).toContain('repeat(3, auto 1fr)');
+ });
+
+ it('leaves the grid to the static rule for columns="multi"', () => {
+ const {container} = render(
+ <MetadataList columns="multi">
+ <MetadataListItem label="A">1</MetadataListItem>
+ </MetadataList>,
+ );
+
+ expect(gridTemplateOf(container)).not.toContain('repeat(');
+ });
+
+ it('ignores numeric columns in horizontal orientation', () => {
+ const {container} = render(
+ <MetadataList columns={3} orientation="horizontal">
+ <MetadataListItem label="A">1</MetadataListItem>
+ </MetadataList>,
+ );
+
+ expect(gridTemplateOf(container)).not.toContain('repeat(');
+ });
+
+ it('still applies a custom label width with side labels', () => {
+ const {container} = render(
+ <MetadataList label={{position: 'start', width: 120}}>
+ <MetadataListItem label="A">1</MetadataListItem>
+ </MetadataList>,
+ );
+
+ expect(gridTemplateOf(container)).toContain('120px 1fr');
+ });
+ });
});
describe('MetadataListItem', () => {
diff --git a/packages/core/src/MetadataList/MetadataList.tsx b/packages/core/src/MetadataList/MetadataList.tsx
index 15b1942693..a998d2ac0a 100644
--- a/packages/core/src/MetadataList/MetadataList.tsx
+++ b/packages/core/src/MetadataList/MetadataList.tsx
@@ -157,6 +157,12 @@ const styles = stylex.create({
},
});
+// A fixed numeric column count (and a custom label width) is only known at
+// runtime, so it comes from a dynamic style rather than a static rule.
+const dynamicStyles = stylex.create({
+ gridTemplate: (gridTemplateColumns: string) => ({gridTemplateColumns}),
+});
+
// =============================================================================
// Component
// =============================================================================
@@ -241,20 +247,32 @@ export function MetadataList({
return styles.gridMulti;
};
- // For numeric columns > 1 with side labels, use inline style for dynamic grid
- const dynamicGridStyle =
- !isHorizontal &&
- labelConfig.position === 'start' &&
- typeof columns === 'number' &&
- columns > 1
- ? {gridTemplateColumns: `repeat(${columns}, auto 1fr)`}
- : !isHorizontal &&
- labelConfig.position === 'start' &&
- labelConfig.width != null
- ? {
- gridTemplateColumns: `${typeof labelConfig.width === 'number' ? `${labelConfig.width}px` : labelConfig.width} 1fr`,
- }
- : undefined;
+ // The grid template for a fixed numeric column count, or for a custom label
+ // width. Both are runtime values, so they resolve to a dynamic style below.
+ // The track shape depends on the label position: stacked labels put a whole
+ // item in one cell, while side labels split each item into a label track and
+ // a value track.
+ const getGridTemplateColumns = () => {
+ if (isHorizontal) {
+ return null;
+ }
+ const isStacked = labelConfig.position === 'top';
+ if (typeof columns === 'number' && columns > 1) {
+ return isStacked
+ ? `repeat(${columns}, 1fr)`
+ : `repeat(${columns}, auto 1fr)`;
+ }
+ // A custom label width only applies to the label track of side labels.
+ if (!isStacked && labelConfig.width != null) {
+ const width =
+ typeof labelConfig.width === 'number'
+ ? `${labelConfig.width}px`
+ : labelConfig.width;
+ return `${width} 1fr`;
+ }
+ return null;
+ };
+ const gridTemplateColumns = getGridTemplateColumns();
return (
<MetadataListContext value={contextValue}>
@@ -273,9 +291,12 @@ export function MetadataList({
{titleContent}
<dl
id={contentId}
- {...mergeProps(stylex.props(styles.dl, getGridStyle()), {
- style: dynamicGridStyle,
- })}>
+ {...stylex.props(
+ styles.dl,
+ getGridStyle(),
+ gridTemplateColumns != null &&
+ dynamicStyles.gridTemplate(gridTemplateColumns),
+ )}>
{visibleChildren}
</dl>
{isExceedMax && (