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: 'Trigger button',
required: true,
description:
'Small round native button, named by `label`, that previews and pins the help.',
},
{
name: 'Info icon',
required: true,
description:
"The icon registry's `info` artwork at `size`; a theme may replace it.",
},
{
name: 'Help surface',
required: true,
description:
'Tooltip surface that shows `content` while the help is shown.',
},
];
/** @type {import('@astryxdesign/cli/authoring').ComponentDoc} */
export const docs = {
name: 'InfoTip',
displayName: 'Info Tip',
// Keeps the registry route InfoTip had as a canary-only Lab component.
registry: {aliases: ['lab/info-tip']},
category: 'Feedback & Status',
keywords: [
'info',
'tooltip',
'help',
'hint',
'affordance',
'icon',
'label',
'field',
'metric',
'definition',
],
props: [
{
name: 'content',
type: 'ReactNode',
description:
"Content to display in the tooltip. Typically short, non-interactive text. Mirrors Tooltip's content prop.",
required: true,
},
{
name: 'label',
type: 'string',
description:
'Accessible name for the trigger button. Defaults to the translated "More information".',
default: "'More information'",
},
{
name: 'size',
type: "'xsm' | 'sm' | 'md' | 'lg'",
description:
'Size of the info icon (12px, 16px, 20px, 24px). Maps 1:1 to Icon sizes.',
default: "'sm'",
},
{
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={{}}.',
},
],
usage: {
anatomy,
description:
'An info icon that reveals help: a small "i" button. Hover and keyboard focus preview the help, and a click, tap, Enter, or Space pins it open until Escape, a second press, a press outside, or focus leaving. Use it next to labels, values, and metrics for permission notes, metric definitions, and field help. Its value over hand-composing Icon inside Tooltip is the pre-wired accessible trigger: a real button with an aria-label, Tab-reachable, tooltip on hover AND focus AND tap, and Escape dismissal. It follows the toggletip pattern: the button reports `aria-expanded="true"` while the help is pinned, and a screen reader hears the help once when it pins.',
bestPractices: [
{
guidance: true,
description:
'Keep tooltip content concise, plain, and non-interactive; use Popover or HoverCard for links and buttons.',
},
{
guidance: true,
description:
'Override label when "More information" is too generic, e.g. "About this metric".',
},
{
guidance: true,
description:
'Rely on InfoTip rather than a hand-rolled info button on touch: it pins its help on a press, so a tap, a click, Enter, or Space pins the tooltip even though the trigger is a button, and a tap outside dismisses it.',
},
{
guidance: false,
description:
'Hand-compose Icon inside Tooltip for info affordances; the bare Icon is aria-hidden and unfocusable, so keyboard and screen-reader users never see it.',
},
{
guidance: false,
description:
'Use InfoTip for essential information users must see to complete a task; put that text inline instead.',
},
],
},
};
/** @type {import('@astryxdesign/cli/authoring').ComponentDoc} */
export const docsZh = {
name: 'InfoTip',
displayName: 'Info Tip',
props: [
{
name: 'content',
type: 'ReactNode',
description:
'工具提示中显示的内容。通常为简短的非交互文本。与 Tooltip 的 content 属性一致。',
required: true,
},
{
name: 'label',
type: 'string',
description: '触发按钮的无障碍名称。默认为翻译后的“More information”。',
default: "'More information'",
},
{
name: 'size',
type: "'xsm' | 'sm' | 'md' | 'lg'",
description:
'信息图标的尺寸(12px、16px、20px、24px)。与 Icon 尺寸一一对应。',
default: "'sm'",
},
{
name: 'xstyle',
type: 'StyleXStyles',
description:
'用于布局自定义的 StyleX 样式(边距、定位、尺寸)。必须是 stylex.create() 的值,不能是内联样式对象如 style={{}}。',
},
],
usage: {
anatomy,
description:
'An info icon that reveals help: a small "i" button. Hover and keyboard focus preview the help, and a click, tap, Enter, or Space pins it open until Escape, a second press, a press outside, or focus leaving. Use it next to labels, values, and metrics for permission notes, metric definitions, and field help.',
bestPractices: [
{
guidance: true,
description:
'Keep tooltip content concise, plain, and non-interactive; use Popover or HoverCard for links and buttons.',
},
{
guidance: true,
description:
'Override label when "More information" is too generic, e.g. "About this metric".',
},
{
guidance: true,
description:
'Rely on InfoTip rather than a hand-rolled info button on touch: it pins its help on a press, so a tap, a click, Enter, or Space pins the tooltip even though the trigger is a button, and a tap outside dismisses it.',
},
{
guidance: false,
description:
'Hand-compose Icon inside Tooltip for info affordances; the bare Icon is aria-hidden and unfocusable, so keyboard and screen-reader users never see it.',
},
{
guidance: false,
description:
'Use InfoTip for essential information users must see to complete a task; put that text inline instead.',
},
],
},
};
/** @type {import('@astryxdesign/cli/authoring').ComponentTranslationDoc} */
export const docsDense = {
description:
'Inline info-icon help affordance: accessible "i" button trigger pre-wired into a Tooltip.',
usage: {
description:
'A small "i" button: hover and keyboard focus preview the help; a click, tap, Enter, or Space pins it open. Use next to labels, values, and metrics for permission notes, metric definitions, and field help. Pre-wired accessible trigger: real button, aria-label, Tab-reachable, tooltip on hover AND focus AND tap, Escape dismissal. Toggletip pattern: aria-expanded="true" while pinned; the help is announced once when it pins.',
bestPractices: [
{
guidance: true,
description:
'Keep tooltip content concise, plain, and non-interactive; use Popover or HoverCard for links and buttons.',
},
{
guidance: true,
description:
'Override label when "More information" is too generic, e.g. "About this metric".',
},
{
guidance: true,
description:
'Rely on InfoTip rather than a hand-rolled info button on touch: it pins its help on a press, so a tap, a click, Enter, or Space pins the tooltip even though the trigger is a button, and a tap outside dismisses it.',
},
{
guidance: false,
description:
'Hand-compose Icon inside Tooltip for info affordances; the bare Icon is aria-hidden and unfocusable.',
},
{
guidance: false,
description:
'Use InfoTip for essential information users must see to complete a task; put that text inline instead.',
},
],
},
propDescriptions: {
content:
'Tooltip content. Short, non-interactive text. Mirrors Tooltip content prop.',
label:
"Accessible name for the trigger button. Default: the translated 'More information'.",
size: 'Info icon size (12/16/20/24px). Maps 1:1 to Icon sizes.',
},
};