An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
/** @type {import('@astryxdesign/cli/authoring').ComponentAnatomyElement[]} */
const anatomy = [
{
name: 'Divider group',
required: true,
description:
'Separator group that arranges one or two rules around an optional label.',
},
{
name: 'Rule',
required: true,
description:
'Painted line segment; a second segment renders when a label is present.',
},
{
name: 'Label',
required: false,
description: 'Optional content displayed between two rule segments.',
},
];
/** @type {import('@astryxdesign/cli/authoring').ComponentDoc} */
export const docs = {
name: 'Divider',
displayName: 'Divider',
category: 'Layout',
keywords: ["divider","separator","hr","rule","line","border","spacer","horizontal rule"],
props: [
{
name: 'orientation',
type: "'horizontal' | 'vertical'",
description: 'Orientation of the divider.',
default: "'horizontal'",
},
{
name: 'label',
type: 'ReactNode',
description:
'Optional label centered on the divider. Numeric zero is preserved; null, booleans, and empty strings render no label.',
},
{
name: 'variant',
type: "'subtle' | 'strong'",
description: 'Visual weight of the divider line.',
default: "'subtle'",
},
{
name: 'isFullBleed',
type: 'boolean',
description:
'Extend the divider to container edges with negative margins.',
default: 'false',
},
{
name: 'xstyle',
type: 'StyleXStyles',
description:
'StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value, not an inline style object like style={{}}.',
},
],
theming: {
targets: [
{className: 'astryx-divider', visualProps: ['orientation', 'variant']},
],
},
usage: {
anatomy,
description: 'A visual separator that divides content into distinct sections. Use to create clear boundaries between groups of related content, or to demarcate interactive regions within a layout.',
bestPractices: [
{ guidance: true, description: 'Use subtle dividers between related content sections and strong dividers for high-contrast boundaries.' },
{ guidance: true, description: 'Add a label to the divider when sections need a visible category heading.' },
{ guidance: false, description: 'Overuse dividers; rely on spacing and layout to separate content when possible.' },
],
},
};
/** @type {import('@astryxdesign/cli/authoring').ComponentDoc} */
export const docsZh = {
name: 'Divider',
displayName: 'Divider',
props: [
{
name: 'orientation',
type: "'horizontal' | 'vertical'",
description: '分隔线的方向。',
default: "'horizontal'",
},
{
name: 'label',
type: 'ReactNode',
description:
'居中显示在分隔线上的可选标签。数字 0 会保留;null、布尔值和空字符串不渲染标签。',
},
{
name: 'variant',
type: "'subtle' | 'strong'",
description: '分隔线的视觉粗细。',
default: "'subtle'",
},
{
name: 'isFullBleed',
type: 'boolean',
description: '通过负边距将分隔线延伸至容器边缘。',
default: 'false',
},
{
name: 'xstyle',
type: 'StyleXStyles',
description:
'用于布局自定义的 StyleX 样式(边距、定位、尺寸)。必须是 stylex.create() 的值,不能是 style={{}} 这样的内联样式对象。',
},
],
theming: {
targets: [
{className: 'astryx-divider', visualProps: ['orientation', 'variant']},
],
},
usage: {
anatomy,
description: 'A visual separator that divides content into distinct sections. Use to create clear boundaries between groups of related content, or to demarcate interactive regions within a layout.',
bestPractices: [
{ guidance: true, description: 'Use subtle dividers between related content sections and strong dividers for high-contrast boundaries.' },
{ guidance: true, description: 'Add a label to the divider when sections need a visible category heading.' },
{ guidance: false, description: 'Overuse dividers; rely on spacing and layout to separate content when possible.' },
],
},
};
/** @type {import('@astryxdesign/cli/authoring').ComponentTranslationDoc} */
export const docsDense = {
description: 'visual separator w/ optional label, using Astryx design tokens',
usage: {
anatomy,
description: 'A visual separator that divides content into distinct sections. Use to create clear boundaries between groups of related content, or to demarcate interactive regions within a layout.',
bestPractices: [
{ guidance: true, description: 'Use subtle dividers between related content sections and strong dividers for high-contrast boundaries.' },
{ guidance: true, description: 'Add a label to the divider when sections need a visible category heading.' },
{ guidance: false, description: 'Overuse dividers; rely on spacing and layout to separate content when possible.' },
],
},
propDescriptions: {
orientation: 'divider orientation',
label: 'optional centered label; preserves 0; null/boolean/"" omit it',
variant: 'visual weight of divider line',
isFullBleed: 'extend to container edges w/ negative margins',
xstyle: 'StyleX styles for layout; must be stylex.create() value',
},
};