Skip to content

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

TypeScript
2.3 KB
Raw Blame
// Copyright (c) Meta Platforms, Inc. and affiliates.

/** @type {import('@astryxdesign/cli/authoring').ReferenceDoc} */

export const docs = {
  name: 'shape',
  title: 'Shape',
  category: 'foundations',
  description:
    'Border radius tokens for consistent component rounding, from sharp corners to full pills.',
  tokenCategory: 'radius',

  sections: [
    {
      title: 'Overview',
  category: 'foundations',
      content: [
        {
          type: 'prose',
          text: 'The radius scale uses a semantic naming system: inner → element → container → page. Each level fits a specific context. Themes can multiply the entire scale via a radius multiplier, with --radius-none and --radius-full as fixed anchors.',
        },
      ],
    },
    {
      title: 'Radius Scale',
  category: 'foundations',
      content: [
        {
          type: 'prose',
          text: 'Seven radius tokens, from 0px to 9999px.',
        },
        {
          type: 'token-ref',
          topic: 'tokens',
          section: 'Radius Tokens',
        },
      ],
    },
    {
      title: 'Concentric Radius',
  category: 'foundations',
      content: [
        {
          type: 'prose',
          text: 'Inside a padded, rounded container, give nested elements a radius of outer radius minus padding so the curves stay concentric. Card does not do this for your content.',
        },
        {
          type: 'code',
          lang: 'css',
          label: 'Concentric radius formula',
          code: `.inner {
  border-radius: max(0px, calc(var(--radius-container) - var(--spacing-4)));
}`,
        },
      ],
    },
    {
      title: 'Best Practices',
  category: 'foundations',
      content: [
        {
          type: 'list',
          style: 'do',
          items: [
            'Use --radius-element for interactive controls (buttons, inputs, selectors).',
            'Use --radius-container for content containers (cards, panels, dialogs).',
            'Use --radius-full for pill shapes (badges, tags, avatar status dots).',
          ],
        },
        {
          type: 'list',
          style: 'dont',
          items: [
            "Use --radius-page for small elements; it's meant for page-level containers.",
            "Hardcode radius values; they won't scale with theme radius multipliers.",
          ],
        },
      ],
    },
  ],
};