Skip to content

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

TypeScript

docs(slop): normalize escape-sequence em-dashes and curly quotes in prose (#3557)

Joeyc11faf5af1b1
diff --git a/packages/core/src/Chat/ChatDictationButton.doc.mjs b/packages/core/src/Chat/ChatDictationButton.doc.mjs
index 455d7e5722..159ccc8569 100644
--- a/packages/core/src/Chat/ChatDictationButton.doc.mjs
+++ b/packages/core/src/Chat/ChatDictationButton.doc.mjs
@@ -34,7 +34,7 @@ export const docs = {
name: 'dictation',
type: 'UseSpeechRecognitionReturn',
description:
- 'The return value from useChatDictation or useSpeechRecognition. Controls all button state \u2014 listening, volume, bands, and toggle.',
+ 'The return value from useChatDictation or useSpeechRecognition. Controls all button state: listening, volume, bands, and toggle.',
required: true,
},
{
diff --git a/packages/core/src/Icon/Icon.doc.mjs b/packages/core/src/Icon/Icon.doc.mjs
index 3fef54c24f..1aac1c6cb4 100644
--- a/packages/core/src/Icon/Icon.doc.mjs
+++ b/packages/core/src/Icon/Icon.doc.mjs
@@ -51,7 +51,7 @@ export const docs = {
{ guidance: false, description: 'Resize icons with arbitrary pixel values; use the provided size props.' },
{ guidance: false, description: 'Mix icon styles (e.g. outline and filled) within the same context.' },
{ guidance: false, description: 'Render raw SVG elements; always wrap in Icon for consistent sizing and color.' },
- { guidance: false, description: 'Pass a `name` prop \u2014 Icon uses `icon` (not `name`) to specify which icon to render.' },
+ { guidance: false, description: 'Pass a `name` prop; Icon uses `icon` (not `name`) to specify which icon to render.' },
],
},
};
@@ -96,7 +96,7 @@ export const docsZh = {
{ guidance: false, description: 'Resize icons with arbitrary pixel values; use the provided size props.' },
{ guidance: false, description: 'Mix icon styles (e.g. outline and filled) within the same context.' },
{ guidance: false, description: 'Render raw SVG elements; always wrap in Icon for consistent sizing and color.' },
- { guidance: false, description: 'Pass a `name` prop \u2014 Icon uses `icon` (not `name`) to specify which icon to render.' },
+ { guidance: false, description: 'Pass a `name` prop; Icon uses `icon` (not `name`) to specify which icon to render.' },
],
},
};
@@ -116,7 +116,7 @@ export const docsDense = {
{ guidance: false, description: 'Resize icons with arbitrary pixel values; use the provided size props.' },
{ guidance: false, description: 'Mix icon styles (e.g. outline and filled) within the same context.' },
{ guidance: false, description: 'Render raw SVG elements; always wrap in Icon for consistent sizing and color.' },
- { guidance: false, description: '`name` prop \u2014 does not exist. Use `icon` to specify which icon to render.' },
+ { guidance: false, description: '`name` prop, which does not exist. Use `icon` to specify which icon to render.' },
],
},
propDescriptions: {
diff --git a/packages/core/src/Text/Text.doc.mjs b/packages/core/src/Text/Text.doc.mjs
index 09d2c238ae..3b60fb372b 100644
--- a/packages/core/src/Text/Text.doc.mjs
+++ b/packages/core/src/Text/Text.doc.mjs
@@ -124,15 +124,15 @@ export const docs = {
description:
'Text renders styled body text and headings from the theme. Use Text with a semantic type for body copy, labels, and captions, and Heading for section titles that output the correct h1\u2013h6 element.',
bestPractices: [
- { guidance: true, description: 'Pick a semantic type (body, label, supporting, large, code) instead of manually setting size and weight \u2014 the theme handles the details.' },
+ { guidance: true, description: 'Pick a semantic type (body, label, supporting, large, code) instead of manually setting size and weight; the theme handles the details.' },
{ guidance: true, description: 'Set accessibilityLevel on Heading when the visual level differs from the document outline so screen readers announce the correct hierarchy.' },
- { guidance: true, description: 'Use maxLines with a number to truncate long content \u2014 a tooltip appears automatically on hover so no text is lost.' },
+ { guidance: true, description: 'Use maxLines with a number to truncate long content; a tooltip appears automatically on hover so no text is lost.' },
{ guidance: true, description: 'Enable hasTabularNumbers for columns of numeric data so digits align vertically across rows.' },
- { guidance: false, description: 'Override size and weight when a semantic type already matches \u2014 extra overrides fight the theme and break when themes change.' },
- { guidance: false, description: 'Skip heading levels in the document outline \u2014 go h1 then h2 then h3, never h1 then h3.' },
- { guidance: false, description: 'Use raw HTML tags like <p>, <h1>\u2013<h6>, or <span> for text \u2014 Text and Heading apply the correct theme tokens automatically.' },
- { guidance: false, description: 'Pass a `variant` prop \u2014 Text does not have a `variant` prop. Use `type` for semantic styling (body, label, large, supporting, code) or use Heading for headings.' },
- { guidance: false, description: 'Use Text for headings \u2014 use Heading with a `level` prop (1\u20136) for section titles and headings.' },
+ { guidance: false, description: 'Override size and weight when a semantic type already matches; extra overrides fight the theme and break when themes change.' },
+ { guidance: false, description: 'Skip heading levels in the document outline; go h1 then h2 then h3, never h1 then h3.' },
+ { guidance: false, description: 'Use raw HTML tags like <p>, <h1>\u2013<h6>, or <span> for text; Text and Heading apply the correct theme tokens automatically.' },
+ { guidance: false, description: 'Pass a `variant` prop; Text does not have a `variant` prop. Use `type` for semantic styling (body, label, large, supporting, code) or use Heading for headings.' },
+ { guidance: false, description: 'Use Text for headings; use Heading with a `level` prop (1\u20136) for section titles and headings.' },
],
},
};
@@ -143,15 +143,15 @@ export const docsZh = {
description:
'Text renders styled body text and headings from the theme. Use Text with a semantic type for body copy, labels, and captions, and Heading for section titles that output the correct h1\u2013h6 element.',
bestPractices: [
- { guidance: true, description: 'Pick a semantic type (body, label, supporting, large, code) instead of manually setting size and weight \u2014 the theme handles the details.' },
+ { guidance: true, description: 'Pick a semantic type (body, label, supporting, large, code) instead of manually setting size and weight; the theme handles the details.' },
{ guidance: true, description: 'Set accessibilityLevel on Heading when the visual level differs from the document outline so screen readers announce the correct hierarchy.' },
- { guidance: true, description: 'Use maxLines with a number to truncate long content \u2014 a tooltip appears automatically on hover so no text is lost.' },
+ { guidance: true, description: 'Use maxLines with a number to truncate long content; a tooltip appears automatically on hover so no text is lost.' },
{ guidance: true, description: 'Enable hasTabularNumbers for columns of numeric data so digits align vertically across rows.' },
- { guidance: false, description: 'Override size and weight when a semantic type already matches \u2014 extra overrides fight the theme and break when themes change.' },
- { guidance: false, description: 'Skip heading levels in the document outline \u2014 go h1 then h2 then h3, never h1 then h3.' },
- { guidance: false, description: 'Use raw HTML tags like <p>, <h1>\u2013<h6>, or <span> for text \u2014 Text and Heading apply the correct theme tokens automatically.' },
- { guidance: false, description: 'Pass a `variant` prop \u2014 Text does not have a `variant` prop. Use `type` for semantic styling (body, label, large, supporting, code) or use Heading for headings.' },
- { guidance: false, description: 'Use Text for headings \u2014 use Heading with a `level` prop (1\u20136) for section titles and headings.' },
+ { guidance: false, description: 'Override size and weight when a semantic type already matches; extra overrides fight the theme and break when themes change.' },
+ { guidance: false, description: 'Skip heading levels in the document outline; go h1 then h2 then h3, never h1 then h3.' },
+ { guidance: false, description: 'Use raw HTML tags like <p>, <h1>\u2013<h6>, or <span> for text; Text and Heading apply the correct theme tokens automatically.' },
+ { guidance: false, description: 'Pass a `variant` prop; Text does not have a `variant` prop. Use `type` for semantic styling (body, label, large, supporting, code) or use Heading for headings.' },
+ { guidance: false, description: 'Use Text for headings; use Heading with a `level` prop (1\u20136) for section titles and headings.' },
],
},
};
@@ -165,12 +165,12 @@ export const docsDense = {
bestPractices: [
{ guidance: true, description: 'Semantic type (body, label, supporting, large, code) instead of manual size/weight.' },
{ guidance: true, description: 'accessibilityLevel on Heading when visual level differs from document outline.' },
- { guidance: true, description: 'maxLines for truncation \u2014 tooltip shows full text on hover.' },
+ { guidance: true, description: 'maxLines for truncation; tooltip shows full text on hover.' },
{ guidance: true, description: 'hasTabularNumbers for aligned numeric columns.' },
{ guidance: false, description: 'Override size/weight when a semantic type already matches.' },
- { guidance: false, description: 'Skip heading levels \u2014 sequential h1 \u2192 h2 \u2192 h3.' },
- { guidance: false, description: 'Raw <p>/<h1>/<span> \u2014 use Text/Heading for theme tokens.' },
- { guidance: false, description: '`variant` prop \u2014 does not exist. Use `type` for text styling or Heading for headings.' },
+ { guidance: false, description: 'Skip heading levels; sequential h1 \u2192 h2 \u2192 h3.' },
+ { guidance: false, description: 'Raw <p>/<h1>/<span>; use Text/Heading for theme tokens.' },
+ { guidance: false, description: '`variant` prop, which does not exist. Use `type` for text styling or Heading for headings.' },
{ guidance: false, description: 'Text for headings: use Heading with level (1\u20136).' },
],
},
diff --git a/packages/core/src/Thumbnail/Thumbnail.doc.mjs b/packages/core/src/Thumbnail/Thumbnail.doc.mjs
index 1fe47103e4..83166ff19d 100644
--- a/packages/core/src/Thumbnail/Thumbnail.doc.mjs
+++ b/packages/core/src/Thumbnail/Thumbnail.doc.mjs
@@ -126,11 +126,11 @@ export const docsDense = {
description:
'Compact square image preview. Shimmer while uploading, image on success, placeholder when empty. Use in chat composers, file lists, or small media previews.',
bestPractices: [
- {guidance: true, description: 'Always set label (file name) for a11y \u2014 powers screen reader announce + hover tooltip.'},
+ {guidance: true, description: 'Always set label (file name) for a11y; powers screen reader announce + hover tooltip.'},
{guidance: true, description: 'isLoading w/o src \u2192 skeleton; isLoading w/ src \u2192 spinner overlay. Two distinct loading states.'},
- {guidance: true, description: 'onClick adds button semantics + hover shadow \u2014 pair with lightbox for full preview.'},
- {guidance: false, description: "Don't use for non-image files (PDF, xlsx) \u2014 use file attachment component with icon instead."},
- {guidance: false, description: "Don't omit alt when src present \u2014 screen readers need image content description, not just label."},
+ {guidance: true, description: 'onClick adds button semantics + hover shadow; pair with lightbox for full preview.'},
+ {guidance: false, description: "Don't use for non-image files (PDF, xlsx); use file attachment component with icon instead."},
+ {guidance: false, description: "Don't omit alt when src present; screen readers need image content description, not just label."},
],
},
propDescriptions: {
diff --git a/packages/core/src/TimeInput/TimeInput.doc.mjs b/packages/core/src/TimeInput/TimeInput.doc.mjs
index b5532de5a0..481860b5ac 100644
--- a/packages/core/src/TimeInput/TimeInput.doc.mjs
+++ b/packages/core/src/TimeInput/TimeInput.doc.mjs
@@ -26,7 +26,7 @@ export const docs = {
{
guidance: true,
description:
- 'Choose the hour format (12h or 24h) that matches your audience\u2019s locale \u2014 12-hour with AM/PM for US-centric UIs, 24-hour for international or technical contexts.',
+ 'Choose the hour format (12h or 24h) that matches your audience\'s locale; 12-hour with AM/PM for US-centric UIs, 24-hour for international or technical contexts.',
},
{
guidance: true,
@@ -36,12 +36,12 @@ export const docs = {
{
guidance: true,
description:
- 'Provide a description or placeholder that hints at the expected format or purpose, like \u201cBusiness hours: 9 AM \u2013 5 PM\u201d.',
+ 'Provide a description or placeholder that hints at the expected format or purpose, like "Business hours: 9 AM \u2013 5 PM".',
},
{
guidance: true,
description:
- 'Use the status prop to surface validation errors inline \u2014 show a message like \u201cTime must be during business hours\u201d so users know exactly what to fix.',
+ 'Use the status prop to surface validation errors inline; show a message like "Time must be during business hours" so users know exactly what to fix.',
},
{
guidance: true,
@@ -56,12 +56,12 @@ export const docs = {
{
guidance: false,
description:
- 'Don\u2019t use TimeInput for combined date-and-time selection \u2014 pair it with a separate DateInput instead.',
+ 'Don\'t use TimeInput for combined date-and-time selection; pair it with a separate DateInput instead.',
},
{
guidance: false,
description:
- 'Don\u2019t hide the label \u2014 even when space is tight, keep the label visible or provide a description so the purpose is clear.',
+ 'Don\'t hide the label; even when space is tight, keep the label visible or provide a description so the purpose is clear.',
},
{
guidance: false,
@@ -396,7 +396,7 @@ export const docsZh = {
{
guidance: true,
description:
- 'Choose the hour format (12h or 24h) that matches your audience\u2019s locale \u2014 12-hour with AM/PM for US-centric UIs, 24-hour for international or technical contexts.',
+ 'Choose the hour format (12h or 24h) that matches your audience\'s locale; 12-hour with AM/PM for US-centric UIs, 24-hour for international or technical contexts.',
},
{
guidance: true,
@@ -406,12 +406,12 @@ export const docsZh = {
{
guidance: true,
description:
- 'Provide a description or placeholder that hints at the expected format or purpose, like \u201cBusiness hours: 9 AM \u2013 5 PM\u201d.',
+ 'Provide a description or placeholder that hints at the expected format or purpose, like "Business hours: 9 AM \u2013 5 PM".',
},
{
guidance: true,
description:
- 'Use the status prop to surface validation errors inline \u2014 show a message like \u201cTime must be during business hours\u201d so users know exactly what to fix.',
+ 'Use the status prop to surface validation errors inline; show a message like "Time must be during business hours" so users know exactly what to fix.',
},
{
guidance: true,
@@ -421,12 +421,12 @@ export const docsZh = {
{
guidance: false,
description:
- 'Don\u2019t use TimeInput for combined date-and-time selection \u2014 pair it with a separate DateInput instead.',
+ 'Don\'t use TimeInput for combined date-and-time selection; pair it with a separate DateInput instead.',
},
{
guidance: false,
description:
- 'Don\u2019t hide the label \u2014 even when space is tight, keep the label visible or provide a description so the purpose is clear.',
+ 'Don\'t hide the label; even when space is tight, keep the label visible or provide a description so the purpose is clear.',
},
{
guidance: false,
@@ -480,7 +480,7 @@ export const docsDense = {
{
guidance: true,
description:
- 'Choose hour format (12h/24h) to match locale \u2014 12h for US, 24h for international.',
+ 'Choose hour format (12h/24h) to match locale; 12h for US, 24h for international.',
},
{
guidance: true,
@@ -500,17 +500,17 @@ export const docsDense = {
{
guidance: false,
description:
- 'Don\u2019t use for date-and-time \u2014 pair with DateInput instead.',
+ 'Don\'t use for date-and-time; pair with DateInput instead.',
},
{
guidance: false,
description:
- 'Don\u2019t hide the label \u2014 keep it visible for clarity.',
+ 'Don\'t hide the label; keep it visible for clarity.',
},
{
guidance: false,
description:
- 'Don\u2019t wrap a disabled TimeInput in Tooltip; use the disabledMessage prop instead.',
+ 'Don\'t wrap a disabled TimeInput in Tooltip; use the disabledMessage prop instead.',
},
],
},
diff --git a/packages/core/src/Timestamp/Timestamp.doc.mjs b/packages/core/src/Timestamp/Timestamp.doc.mjs
index 0b02fab0b8..455a6818b9 100644
--- a/packages/core/src/Timestamp/Timestamp.doc.mjs
+++ b/packages/core/src/Timestamp/Timestamp.doc.mjs
@@ -89,18 +89,18 @@ export const docs = {
},
usage: {
description:
- 'Timestamp formats a date or time value into human-readable text. Use it to show when something was created, updated, or is scheduled \u2014 picking relative for recency, absolute for precision, or auto to let the component decide.',
+ 'Timestamp formats a date or time value into human-readable text. Use it to show when something was created, updated, or is scheduled; picking relative for recency, absolute for precision, or auto to let the component decide.',
bestPractices: [
- {guidance: true, description: 'Use the auto format in feeds and lists so recent items show \u201c2 hours ago\u201d and older items show the full date automatically.'},
- {guidance: true, description: 'Keep formatting consistent within the same list or table \u2014 mixing relative and absolute timestamps in the same column confuses scanning.'},
+ {guidance: true, description: 'Use the auto format in feeds and lists so recent items show "2 hours ago" and older items show the full date automatically.'},
+ {guidance: true, description: 'Keep formatting consistent within the same list or table; mixing relative and absolute timestamps in the same column confuses scanning.'},
{guidance: true, description: 'Enable isTimezoneShown when the audience spans multiple time zones, like a global team calendar or audit log.'},
{guidance: true, description: 'Use isLive for active dashboards or real-time feeds so the relative time stays accurate without a page refresh.'},
- {guidance: false, description: 'Don\u2019t display raw Unix timestamps or ISO strings to users \u2014 always pass them through Timestamp to get a human-readable format.'},
- {guidance: false, description: 'Avoid system_date or system_time formats in user-facing UI \u2014 they are meant for developer tools, logs, and machine-readable contexts.'},
- {guidance: false, description: 'Don\u2019t disable the tooltip on relative timestamps \u2014 users expect to hover for the full date when they see \u201c3 hours ago\u201d.'},
+ {guidance: false, description: 'Don\'t display raw Unix timestamps or ISO strings to users; always pass them through Timestamp to get a human-readable format.'},
+ {guidance: false, description: 'Avoid system_date or system_time formats in user-facing UI; they are meant for developer tools, logs, and machine-readable contexts.'},
+ {guidance: false, description: 'Don\'t disable the tooltip on relative timestamps; users expect to hover for the full date when they see "3 hours ago".'},
],
anatomy: [
- {name: 'Formatted text', required: true, description: 'The rendered date, time, or relative label like \u201c2 hours ago\u201d or \u201cMar 21, 2025\u201d.'},
+ {name: 'Formatted text', required: true, description: 'The rendered date, time, or relative label like "2 hours ago" or "Mar 21, 2025".'},
{name: 'Tooltip', required: false, description: 'A hover card showing the full absolute date and time when the display is relative.'},
],
},
@@ -122,18 +122,18 @@ export const docsZh = {
},
usage: {
description:
- 'Timestamp formats a date or time value into human-readable text. Use it to show when something was created, updated, or is scheduled \u2014 picking relative for recency, absolute for precision, or auto to let the component decide.',
+ 'Timestamp formats a date or time value into human-readable text. Use it to show when something was created, updated, or is scheduled; picking relative for recency, absolute for precision, or auto to let the component decide.',
bestPractices: [
- {guidance: true, description: 'Use the auto format in feeds and lists so recent items show \u201c2 hours ago\u201d and older items show the full date automatically.'},
- {guidance: true, description: 'Keep formatting consistent within the same list or table \u2014 mixing relative and absolute timestamps in the same column confuses scanning.'},
+ {guidance: true, description: 'Use the auto format in feeds and lists so recent items show "2 hours ago" and older items show the full date automatically.'},
+ {guidance: true, description: 'Keep formatting consistent within the same list or table; mixing relative and absolute timestamps in the same column confuses scanning.'},
{guidance: true, description: 'Enable isTimezoneShown when the audience spans multiple time zones, like a global team calendar or audit log.'},
{guidance: true, description: 'Use isLive for active dashboards or real-time feeds so the relative time stays accurate without a page refresh.'},
- {guidance: false, description: 'Don\u2019t display raw Unix timestamps or ISO strings to users \u2014 always pass them through Timestamp to get a human-readable format.'},
- {guidance: false, description: 'Avoid system_date or system_time formats in user-facing UI \u2014 they are meant for developer tools, logs, and machine-readable contexts.'},
- {guidance: false, description: 'Don\u2019t disable the tooltip on relative timestamps \u2014 users expect to hover for the full date when they see \u201c3 hours ago\u201d.'},
+ {guidance: false, description: 'Don\'t display raw Unix timestamps or ISO strings to users; always pass them through Timestamp to get a human-readable format.'},
+ {guidance: false, description: 'Avoid system_date or system_time formats in user-facing UI; they are meant for developer tools, logs, and machine-readable contexts.'},
+ {guidance: false, description: 'Don\'t disable the tooltip on relative timestamps; users expect to hover for the full date when they see "3 hours ago".'},
],
anatomy: [
- {name: 'Formatted text', required: true, description: 'The rendered date, time, or relative label like \u201c2 hours ago\u201d or \u201cMar 21, 2025\u201d.'},
+ {name: 'Formatted text', required: true, description: 'The rendered date, time, or relative label like "2 hours ago" or "Mar 21, 2025".'},
{name: 'Tooltip', required: false, description: 'A hover card showing the full absolute date and time when the display is relative.'},
],
},
@@ -144,15 +144,15 @@ export const docsDense = {
description: 'formatted timestamp with relative/absolute/auto modes, live updates, timezone display',
usage: {
description:
- 'Timestamp formats a date or time into readable text. Use for creation dates, update times, or schedules \u2014 relative for recency, absolute for precision, auto to switch automatically.',
+ 'Timestamp formats a date or time into readable text. Use for creation dates, update times, or schedules; relative for recency, absolute for precision, auto to switch automatically.',
bestPractices: [
- {guidance: true, description: 'Auto format in feeds and lists \u2014 recent shows relative, older shows date_time.'},
+ {guidance: true, description: 'Auto format in feeds and lists; recent shows relative, older shows date_time.'},
{guidance: true, description: 'Consistent formatting within the same list or table column.'},
{guidance: true, description: 'isTimezoneShown for multi-timezone audiences.'},
{guidance: true, description: 'isLive for dashboards so relative time stays current.'},
- {guidance: false, description: 'Don\u2019t show raw Unix timestamps or ISO strings \u2014 always use Timestamp.'},
- {guidance: false, description: 'Avoid system_* formats in user-facing UI \u2014 those are for dev tools and logs.'},
- {guidance: false, description: 'Don\u2019t disable tooltip on relative timestamps \u2014 users expect the full date on hover.'},
+ {guidance: false, description: 'Don\'t show raw Unix timestamps or ISO strings; always use Timestamp.'},
+ {guidance: false, description: 'Avoid system_* formats in user-facing UI; those are for dev tools and logs.'},
+ {guidance: false, description: 'Don\'t disable tooltip on relative timestamps; users expect the full date on hover.'},
],
},
propDescriptions: {
diff --git a/packages/core/src/Tokenizer/Tokenizer.doc.mjs b/packages/core/src/Tokenizer/Tokenizer.doc.mjs
index 8be1211885..a8d64befde 100644
--- a/packages/core/src/Tokenizer/Tokenizer.doc.mjs
+++ b/packages/core/src/Tokenizer/Tokenizer.doc.mjs
@@ -178,7 +178,7 @@ export const docs = {
name: 'xstyle',
type: 'StyleXStyles',
description:
- 'StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value \u2014 not an inline style object like style={{}}.',
+ 'StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value; not an inline style object like style={{}}.',
},
],
theming: {
@@ -190,13 +190,13 @@ export const docs = {
description:
'Tokenizer is a multi-select input that lets users search, select, and manage multiple items displayed as removable chips. Use it when users need to build a set of selections from a searchable data source, like adding team members, applying tags, or choosing filters.',
bestPractices: [
- {guidance: true, description: 'Write a placeholder that tells users what they can search for \u2014 "Search people\u2026" or "Add tags\u2026" \u2014 so the input is not a blank mystery.'},
+ {guidance: true, description: 'Write a placeholder that tells users what they can search for, such as "Search people..." or "Add tags...", so the input is not a blank mystery.'},
{guidance: true, description: 'Set maxEntries when the number of selections should be bounded, like limiting a review to 5 approvers.'},
{guidance: true, description: 'Use hasCreate for free-form tagging where users need to enter values that do not exist in the search source.'},
{guidance: true, description: 'Show validation status with the status prop so users know immediately when a selection is missing or invalid.'},
- {guidance: false, description: 'Don\u2019t use Tokenizer for single-item selection \u2014 use Typeahead instead. Tokenizer is for building sets of two or more items.'},
- {guidance: false, description: 'Avoid applying custom colors to individual tokens inside a Tokenizer \u2014 use the default token style for visual consistency across the set.'},
- {guidance: false, description: 'Don\u2019t hide the label \u2014 every Tokenizer needs a visible label so users understand what they are selecting. Use isLabelHidden only when surrounding context makes the purpose obvious.'},
+ {guidance: false, description: 'Don\'t use Tokenizer for single-item selection; use Typeahead instead. Tokenizer is for building sets of two or more items.'},
+ {guidance: false, description: 'Avoid applying custom colors to individual tokens inside a Tokenizer; use the default token style for visual consistency across the set.'},
+ {guidance: false, description: 'Don\'t hide the label; every Tokenizer needs a visible label so users understand what they are selecting. Use isLabelHidden only when surrounding context makes the purpose obvious.'},
{guidance: false, description: 'Wrap a disabled Tokenizer in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.'},
],
anatomy: [
@@ -374,7 +374,7 @@ export const docsZh = {
name: 'xstyle',
type: 'StyleXStyles',
description:
- '\u7528\u4e8e\u5e03\u5c40\u81ea\u5b9a\u4e49\u7684 StyleX \u6837\u5f0f\uff08\u5916\u8fb9\u8ddd\u3001\u5b9a\u4f4d\u3001\u5c3a\u5bf8\uff09\u3002\u5fc5\u987b\u662f stylex.create() \u7684\u503c \u2014 \u4e0d\u80fd\u662f\u5185\u8054\u6837\u5f0f\u5bf9\u8c61\u5982 style={{}}\u3002',
+ '\u7528\u4e8e\u5e03\u5c40\u81ea\u5b9a\u4e49\u7684 StyleX \u6837\u5f0f\uff08\u5916\u8fb9\u8ddd\u3001\u5b9a\u4f4d\u3001\u5c3a\u5bf8\uff09\u3002\u5fc5\u987b\u662f stylex.create() \u7684\u503c; \u4e0d\u80fd\u662f\u5185\u8054\u6837\u5f0f\u5bf9\u8c61\u5982 style={{}}\u3002',
},
],
theming: {
@@ -386,13 +386,13 @@ export const docsZh = {
description:
'Tokenizer is a multi-select input that lets users search, select, and manage multiple items displayed as removable chips. Use it when users need to build a set of selections from a searchable data source, like adding team members, applying tags, or choosing filters.',
bestPractices: [
- {guidance: true, description: 'Write a placeholder that tells users what they can search for \u2014 "Search people\u2026" or "Add tags\u2026" \u2014 so the input is not a blank mystery.'},
+ {guidance: true, description: 'Write a placeholder that tells users what they can search for, such as "Search people..." or "Add tags...", so the input is not a blank mystery.'},
{guidance: true, description: 'Set maxEntries when the number of selections should be bounded, like limiting a review to 5 approvers.'},
{guidance: true, description: 'Use hasCreate for free-form tagging where users need to enter values that do not exist in the search source.'},
{guidance: true, description: 'Show validation status with the status prop so users know immediately when a selection is missing or invalid.'},
- {guidance: false, description: 'Don\u2019t use Tokenizer for single-item selection \u2014 use Typeahead instead. Tokenizer is for building sets of two or more items.'},
- {guidance: false, description: 'Avoid applying custom colors to individual tokens inside a Tokenizer \u2014 use the default token style for visual consistency across the set.'},
- {guidance: false, description: 'Don\u2019t hide the label \u2014 every Tokenizer needs a visible label so users understand what they are selecting. Use isLabelHidden only when surrounding context makes the purpose obvious.'},
+ {guidance: false, description: 'Don\'t use Tokenizer for single-item selection; use Typeahead instead. Tokenizer is for building sets of two or more items.'},
+ {guidance: false, description: 'Avoid applying custom colors to individual tokens inside a Tokenizer; use the default token style for visual consistency across the set.'},
+ {guidance: false, description: 'Don\'t hide the label; every Tokenizer needs a visible label so users understand what they are selecting. Use isLabelHidden only when surrounding context makes the purpose obvious.'},
{guidance: false, description: 'Wrap a disabled Tokenizer in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.'},
],
anatomy: [
@@ -413,13 +413,13 @@ export const docsDense = {
description:
'Multi-select input for searching and selecting multiple items as removable chips. Use for team members, tags, filters, or any set built from a searchable source.',
bestPractices: [
- {guidance: true, description: 'Placeholder that communicates what to search \u2014 "Search people\u2026" not blank.'},
+ {guidance: true, description: 'Placeholder that communicates what to search, such as "Search people..." rather than blank.'},
{guidance: true, description: 'maxEntries when selections are bounded (e.g. 5 approvers max).'},
{guidance: true, description: 'hasCreate for free-form tagging with values not in the source.'},
{guidance: true, description: 'status prop for immediate validation feedback.'},
- {guidance: false, description: 'Don\u2019t use for single-item selection \u2014 use Typeahead instead.'},
- {guidance: false, description: 'Avoid custom token colors \u2014 default style for consistency.'},
- {guidance: false, description: 'Don\u2019t hide the label unless context makes purpose obvious.'},
+ {guidance: false, description: 'Don\'t use for single-item selection; use Typeahead instead.'},
+ {guidance: false, description: 'Avoid custom token colors; default style for consistency.'},
+ {guidance: false, description: 'Don\'t hide the label unless context makes purpose obvious.'},
{guidance: false, description: 'Wrap a disabled Tokenizer in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.'},
],
},