Skip to content
Merged
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
37 changes: 37 additions & 0 deletions packages/dev/s2-docs/pages/react-aria/Separator.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import {Layout} from '../../src/Layout';
export default Layout;

import docs from 'docs:react-aria-components';
import {Separator as VanillaSeparator} from 'vanilla-starter/Separator';
import {Separator as TailwindSeparator} from 'tailwind-starter/Separator';
import tailwindDocs from 'docs:tailwind-starter/Separator';
import vanillaDocs from 'docs:vanilla-starter/Separator';
import '../../tailwind/tailwind.css';

export const relatedPages = [{'title': 'useSeparator', 'url': 'https://react-spectrum.adobe.com/react-aria/useSeparator.html'}];
export const description = 'A separator is a visual divider between two groups of content.';

# Separator

<PageDescription>{docs.exports.Separator.description}</PageDescription>

<ExampleSwitcher examples={['Vanilla', 'Tailwind']}>
<VisualExample
component={VanillaSeparator}
docs={vanillaDocs.exports.Separator}
links={vanillaDocs.links}
props={['orientation']}
type="vanilla"
files={["starters/docs/src/Separator.tsx", "starters/docs/src/Separator.css"]} />
<VisualExample
component={TailwindSeparator}
docs={tailwindDocs.exports.Separator}
links={tailwindDocs.links}
props={['orientation']}
type="tailwind"
files={["starters/tailwind/src/Separator.tsx"]} />
</ExampleSwitcher>

## API

<PropTable component={docs.exports.Separator} links={docs.links}/>
3 changes: 3 additions & 0 deletions packages/react-aria-components/src/Separator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ export class SeparatorNode extends CollectionNode<any> {
}
}

/**
* A separator is a visual divider between two groups of content, e.g. groups of menu items or sections of a page.
*/
export const Separator = /*#__PURE__*/ createLeafComponent(SeparatorNode, function Separator(props: SeparatorProps, ref: ForwardedRef<HTMLElement>) {
[props, ref] = useContextProps(props, ref, SeparatorContext);

Expand Down
4 changes: 3 additions & 1 deletion starters/docs/src/Menu.css
Original file line number Diff line number Diff line change
Expand Up @@ -170,12 +170,14 @@
}
}

.react-aria-Separator {
.react-aria-Menu .react-aria-Separator {
grid-column-start: 1;
grid-column-end: -1;
margin: 0 var(--spacing-2);
border: 0;
border-top: 0.5px solid var(--border-color);
height: auto;
width: auto;

.react-aria-MenuItem + & {
margin-block-start: var(--spacing-1);
Expand Down
15 changes: 15 additions & 0 deletions starters/docs/src/Separator.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@import "./theme.css";

.react-aria-Separator {
background-color: var(--gray-800);
border-style: none;
border-radius: 1px;
height: 2px;
width: 100%;

&[aria-orientation="vertical"] {
width: 2px;
min-height: 32px;
height: 100%;
}
}
8 changes: 8 additions & 0 deletions starters/docs/src/Separator.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
'use client';
import {Separator as RACSeparator, SeparatorProps} from 'react-aria-components';
import React from 'react';
import './Separator.css';

export function Separator(props: SeparatorProps) {
return <RACSeparator {...props} />
}
4 changes: 2 additions & 2 deletions starters/tailwind/src/Separator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import { Separator as RACSeparator, SeparatorProps } from 'react-aria-components
import { tv } from 'tailwind-variants';

const styles = tv({
base: 'bg-neutral-300 dark:bg-neutral-600 forced-colors:bg-[ButtonBorder]',
base: 'bg-neutral-300 dark:bg-neutral-600 forced-colors:bg-[ButtonBorder] border-none',
variants: {
orientation: {
horizontal: 'h-px w-full',
vertical: 'w-px'
vertical: 'w-px min-h-8 h-full'
}
},
defaultVariants: {
Expand Down