Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(headless): add Collapsible primitive by alexcarpenter · Pull Request #8764 · clerk/javascript · GitHub
Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(headless): add Collapsible primitive by alexcarpenter · Pull Request #8764 · clerk/javascript · GitHub
Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(headless): add Collapsible primitive by alexcarpenter · Pull Request #8764 · clerk/javascript · GitHub
Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(headless): add Collapsible primitive by alexcarpenter · Pull Request #8764 · clerk/javascript · GitHub
Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(headless): add Collapsible primitive by alexcarpenter · Pull Request #8764 · clerk/javascript · GitHub
Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(headless): add Collapsible primitive by alexcarpenter · Pull Request #8764 · clerk/javascript · GitHub
Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(headless): add Collapsible primitive by alexcarpenter · Pull Request #8764 · clerk/javascript · GitHub
Skip to content
Closed
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
4 changes: 4 additions & 0 deletions packages/headless/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,10 @@
"import": "./dist/primitives/autocomplete/index.js",
"types": "./dist/primitives/autocomplete/index.d.ts"
},
"./collapsible": {
"import": "./dist/primitives/collapsible/index.js",
"types": "./dist/primitives/collapsible/index.d.ts"
},
"./dialog": {
"import": "./dist/primitives/dialog/index.js",
"types": "./dist/primitives/dialog/index.d.ts"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { createContext, useContext } from 'react';

export interface CollapsibleContextValue {
open: boolean;
setOpen: (v: boolean) => void;
disabled: boolean;
triggerId: string;
panelId: string;
}

export const CollapsibleContext = createContext<CollapsibleContextValue | null>(null);

export function useCollapsibleContext() {
const ctx = useContext(CollapsibleContext);
if (!ctx) {
throw new Error('Collapsible compound components must be used within <Collapsible.Root>');
}
return ctx;
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
'use client';

import { type RefObject, useLayoutEffect, useRef, useState } from 'react';
import { useTransition } from '../../hooks/use-transition';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsiblePanelProps extends ComponentProps<'div'> {}

export function CollapsiblePanel(props: CollapsiblePanelProps) {
const { render, ...otherProps } = props;
const { open, triggerId, panelId } = useCollapsibleContext();

const panelRef = useRef<HTMLElement | null>(null);
const [height, setHeight] = useState<number | undefined>(undefined);
const [width, setWidth] = useState<number | undefined>(undefined);

const hasBeenClosed = useRef(false);
if (!open) hasBeenClosed.current = true;

const { mounted, transitionProps } = useTransition({
open,
ref: panelRef as RefObject<HTMLElement>,
});

useLayoutEffect(() => {
if (!mounted) return;

const panel = panelRef.current;
if (!panel) return;

const measure = () => {
setHeight(panel.scrollHeight);
setWidth(panel.scrollWidth);
};

measure();

const ro = new ResizeObserver(measure);
ro.observe(panel, { box: 'border-box' });

return () => ro.disconnect();
}, [mounted]);

const state = { open };

const effectiveTransitionProps = !hasBeenClosed.current
? {
...transitionProps,
'data-cl-starting-style': undefined,
style: undefined,
}
: transitionProps;

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-panel',
id: panelId,
role: 'region' as const,
'aria-labelledby': triggerId,
ref: panelRef,
...effectiveTransitionProps,
style: {
'--collapsible-panel-height': height != null ? `${height}px` : undefined,
'--collapsible-panel-width': width != null ? `${width}px` : undefined,
...effectiveTransitionProps.style,
},
};

return renderElement({
defaultTagName: 'div',
render,
enabled: mounted,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
},
props: mergeProps<'div'>(defaultProps, otherProps),
});
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
'use client';

import { type ReactNode, useId, useMemo } from 'react';
import { useControllableState } from '../../hooks/use-controllable-state';
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { CollapsibleContext, type CollapsibleContextValue } from './collapsible-context';

export interface CollapsibleProps extends ComponentProps<'div'> {
/** Controlled open state. */
open?: boolean;
/** Initial open state (uncontrolled). */
defaultOpen?: boolean;
/** Called when open state changes. */
onOpenChange?: (open: boolean) => void;
/** Disable the collapsible. @default false */
disabled?: boolean;
children: ReactNode;
}

export function CollapsibleRoot(props: CollapsibleProps) {
const { render, open: openProp, defaultOpen, onOpenChange, disabled = false, children, ...otherProps } = props;

const [open, setOpen] = useControllableState(openProp, defaultOpen ?? false, onOpenChange);

const rootId = useId();
const triggerId = `${rootId}trigger`;
const panelId = `${rootId}panel`;

const contextValue = useMemo<CollapsibleContextValue>(
() => ({ open, setOpen, disabled, triggerId, panelId }),
[open, setOpen, disabled, triggerId, panelId],
);

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-root',
children,
};

return (
<CollapsibleContext.Provider value={contextValue}>
{renderElement({
defaultTagName: 'div',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'div'>(defaultProps, otherProps),
})}
</CollapsibleContext.Provider>
);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
'use client';

import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
import { useCollapsibleContext } from './collapsible-context';

export interface CollapsibleTriggerProps extends ComponentProps<'button'> {}

export function CollapsibleTrigger(props: CollapsibleTriggerProps) {
const { render, ...otherProps } = props;
const { open, setOpen, disabled, triggerId, panelId } = useCollapsibleContext();

const state = { open, disabled };

const defaultProps: Record<string, unknown> = {
'data-cl-slot': 'collapsible-trigger',
id: triggerId,
type: 'button' as const,
'aria-expanded': open,
'aria-controls': panelId,
'aria-disabled': disabled || undefined,
onClick: () => {
if (!disabled) setOpen(!open);
},
};

return renderElement({
defaultTagName: 'button',
render,
state,
stateAttributesMapping: {
open: (v: boolean): Record<string, string> | null => (v ? { 'data-cl-open': '' } : { 'data-cl-closed': '' }),
disabled: (v: boolean) => (v ? { 'data-cl-disabled': '' } : null),
},
props: mergeProps<'button'>(defaultProps, otherProps),
});
}
190 changes: 190 additions & 0 deletions packages/headless/src/primitives/collapsible/collapsible.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
import { cleanup, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { axe } from '../../test-utils/axe';
import { Collapsible } from './index';

afterEach(() => cleanup());

function renderCollapsible(props: Partial<React.ComponentProps<typeof Collapsible.Root>> = {}) {
return render(
<Collapsible.Root {...props}>
<Collapsible.Trigger>Toggle</Collapsible.Trigger>
<Collapsible.Panel>Content</Collapsible.Panel>
</Collapsible.Root>,
);
}

describe('Collapsible', () => {
describe('slot attributes', () => {
it('renders root with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toBeInTheDocument();
});

it('renders trigger with data-cl-slot', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toBeInTheDocument();
});

it('renders panel with data-cl-slot when open', () => {
renderCollapsible({ defaultOpen: true });
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).toBeInTheDocument();
});
});

describe('open/close', () => {
it('opens panel on trigger click', async () => {
const user = userEvent.setup();
renderCollapsible();

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.getByText('Content')).toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-open', '');
});

it('closes panel on second trigger click', async () => {
const user = userEvent.setup();
renderCollapsible({ defaultOpen: true });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('calls onOpenChange when toggled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).toHaveBeenCalledWith(true);
});

it('starts closed by default', () => {
renderCollapsible();
expect(screen.queryByText('Content')).not.toBeInTheDocument();
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-closed', '');
});

it('starts open with defaultOpen=true', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});
});

describe('controlled value', () => {
it('respects controlled open prop', () => {
renderCollapsible({ open: true });
expect(screen.getByText('Content')).toBeInTheDocument();
});

it('does not change when controlled', async () => {
const user = userEvent.setup();
renderCollapsible({ open: false });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(screen.queryByText('Content')).not.toBeInTheDocument();
});
});

describe('ARIA attributes', () => {
it('trigger has aria-expanded=false when closed', () => {
renderCollapsible();
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'false');
});

it('trigger has aria-expanded=true when open', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-expanded', 'true');
});

it('trigger has aria-controls linked to panel id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(trigger).toHaveAttribute('aria-controls', panel?.getAttribute('id'));
});

it('panel has aria-labelledby linked to trigger id', () => {
renderCollapsible({ defaultOpen: true });
const trigger = screen.getByRole('button', { name: 'Toggle' });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('aria-labelledby', trigger.getAttribute('id'));
});

it('panel has role=region', () => {
renderCollapsible({ defaultOpen: true });
expect(screen.getByRole('region')).toBeInTheDocument();
});
});

describe('animation lifecycle', () => {
it('panel is not in DOM when closed', () => {
renderCollapsible();
expect(document.querySelector('[data-cl-slot="collapsible-panel"]')).not.toBeInTheDocument();
});

it('applies data-cl-open on panel when open', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).toHaveAttribute('data-cl-open', '');
});

it('does not apply starting-style on initially open panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]');
expect(panel).not.toHaveAttribute('data-cl-starting-style');
});

it('sets --collapsible-panel-height CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-height');
});

it('sets --collapsible-panel-width CSS variable on panel', () => {
renderCollapsible({ defaultOpen: true });
const panel = document.querySelector('[data-cl-slot="collapsible-panel"]') as HTMLElement;
expect(panel.getAttribute('style')).toContain('--collapsible-panel-width');
});
});

describe('disabled', () => {
it('prevents toggle when disabled', async () => {
const onOpenChange = vi.fn();
const user = userEvent.setup();
renderCollapsible({ disabled: true, onOpenChange });

await user.click(screen.getByRole('button', { name: 'Toggle' }));

expect(onOpenChange).not.toHaveBeenCalled();
});

it('applies aria-disabled on trigger', () => {
renderCollapsible({ disabled: true });
expect(screen.getByRole('button', { name: 'Toggle' })).toHaveAttribute('aria-disabled', 'true');
});

it('applies data-cl-disabled on root and trigger', () => {
renderCollapsible({ disabled: true });
expect(document.querySelector('[data-cl-slot="collapsible-root"]')).toHaveAttribute('data-cl-disabled', '');
expect(document.querySelector('[data-cl-slot="collapsible-trigger"]')).toHaveAttribute('data-cl-disabled', '');
});
});

describe('accessibility (axe)', () => {
it('has no violations when closed', async () => {
const { container } = renderCollapsible();
expect(await axe(container)).toHaveNoViolations();
});

it('has no violations when open', async () => {
const { container } = renderCollapsible({ defaultOpen: true });
expect(await axe(container)).toHaveNoViolations();
});
});
});
3 changes: 3 additions & 0 deletions packages/headless/src/primitives/collapsible/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * as Collapsible from './parts';

export type { CollapsibleProps, CollapsibleTriggerProps, CollapsiblePanelProps } from './parts';
Loading
Loading