From 0e041492199ae11f02a775f2ba2c4c0f9219de1b Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 3 May 2025 11:21:42 -0700 Subject: [PATCH] docs: stylize "Default" subheadings --- docs/src/pages/components/AspectRatio.svx | 4 +++- docs/src/pages/components/CodeSnippet.svx | 4 ++-- docs/src/pages/components/InlineNotification.svx | 4 ++-- docs/src/pages/components/Loading.svx | 2 +- docs/src/pages/components/Modal.svx | 4 +++- docs/src/pages/components/ProgressIndicator.svx | 2 +- docs/src/pages/components/StructuredList.svx | 4 ++-- docs/src/pages/components/ToastNotification.svx | 4 ++-- docs/src/pages/components/Toggle.svx | 4 ++-- 9 files changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/src/pages/components/AspectRatio.svx b/docs/src/pages/components/AspectRatio.svx index cc5976e0..0793fca9 100644 --- a/docs/src/pages/components/AspectRatio.svx +++ b/docs/src/pages/components/AspectRatio.svx @@ -7,7 +7,9 @@ The `AspectRatio` component maintains consistent proportions for content across Supported aspect ratios include `"2x1"`, `"2x3"`, `"16x9"`, `"4x3"`, `"1x1"`, `"3x4"`, `"3x2"`, `"9x16"` and `"1x2"`. -## Default (2x1) +## Default + +Display a 2:1 aspect ratio container by default. 2x1 diff --git a/docs/src/pages/components/CodeSnippet.svx b/docs/src/pages/components/CodeSnippet.svx index 61b2a646..d1e1dc42 100644 --- a/docs/src/pages/components/CodeSnippet.svx +++ b/docs/src/pages/components/CodeSnippet.svx @@ -33,9 +33,9 @@ This component uses the native, asynchronous [Clipboard API](https://developer.m You can override the default copy functionality with your own implementation. See [Overriding copy functionality](#overriding-copy-functionality). -## Default (single-line) +## Default -Display a single line of code with a copy button. +Display a single-line code snippet by default. diff --git a/docs/src/pages/components/InlineNotification.svx b/docs/src/pages/components/InlineNotification.svx index f17548de..73cc37f7 100644 --- a/docs/src/pages/components/InlineNotification.svx +++ b/docs/src/pages/components/InlineNotification.svx @@ -12,9 +12,9 @@ The `InlineNotification` component displays contextual messages inline with cont See [detailed usage](https://carbondesignsystem.com/components/notification/usage). See also: [ToastNotification](ToastNotification) -## Default (error) +## Default -Display a basic error notification with title and subtitle. +Display a basic error notification with title and subtitle by default. diff --git a/docs/src/pages/components/Loading.svx b/docs/src/pages/components/Loading.svx index abb3ea92..c064043f 100644 --- a/docs/src/pages/components/Loading.svx +++ b/docs/src/pages/components/Loading.svx @@ -9,7 +9,7 @@ components: ["Loading"] The `Loading` component provides a full-screen or inline loading indicator. It's ideal for showing progress during page loads or data fetching operations. -## Default (with overlay) +## Default Display a loading indicator with a semi-transparent overlay that covers the entire viewport. diff --git a/docs/src/pages/components/Modal.svx b/docs/src/pages/components/Modal.svx index 4e42ff88..e11c82ad 100644 --- a/docs/src/pages/components/Modal.svx +++ b/docs/src/pages/components/Modal.svx @@ -4,7 +4,9 @@ The `Modal` component provides a focused dialog for user interactions, confirmations, or data entry. It supports various sizes, states, and customization options to create accessible and user-friendly modal experiences. -## Default (transactional) +## Default + +Display a modal dialog with a header, content area, and footer by default. Create a basic modal dialog with primary and secondary actions. This variant is ideal for confirming user actions or gathering input. diff --git a/docs/src/pages/components/ProgressIndicator.svx b/docs/src/pages/components/ProgressIndicator.svx index ca7bd004..bb6f309d 100644 --- a/docs/src/pages/components/ProgressIndicator.svx +++ b/docs/src/pages/components/ProgressIndicator.svx @@ -9,7 +9,7 @@ components: ["ProgressIndicator", "ProgressStep", "ProgressIndicatorSkeleton"] `ProgressIndicator` provides a visual representation of progress through a sequence of steps. It supports horizontal and vertical layouts, step completion states, and interactive navigation. -## Default (horizontal) +## Default Create a horizontal progress indicator with four steps. diff --git a/docs/src/pages/components/StructuredList.svx b/docs/src/pages/components/StructuredList.svx index e0824c7a..6b3bf328 100644 --- a/docs/src/pages/components/StructuredList.svx +++ b/docs/src/pages/components/StructuredList.svx @@ -10,9 +10,9 @@ components: ["StructuredList", "StructuredListSkeleton", "StructuredListBody", " `StructuredList` provides a semantic way to display tabular data with support for selection, keyboard navigation, and various layout options. -## Default (read-only) +## Default -Create a basic structured list with headers and rows. +Display a basic structured list with headers and rows by default. diff --git a/docs/src/pages/components/ToastNotification.svx b/docs/src/pages/components/ToastNotification.svx index 4dc44e8e..be2e34b8 100644 --- a/docs/src/pages/components/ToastNotification.svx +++ b/docs/src/pages/components/ToastNotification.svx @@ -12,9 +12,9 @@ components: ["ToastNotification"] See [detailed usage](https://carbondesignsystem.com/components/notification/usage). See also: [InlineNotification](InlineNotification) -## Default (error) +## Default -Display a basic error notification with title, subtitle, and timestamp. +Display a basic error notification with title, subtitle, and timestamp by default. diff --git a/docs/src/pages/components/Toggle.svx b/docs/src/pages/components/Toggle.svx index a2ff3a1e..81c6d313 100644 --- a/docs/src/pages/components/Toggle.svx +++ b/docs/src/pages/components/Toggle.svx @@ -9,9 +9,9 @@ components: ["Toggle", "ToggleSkeleton"] `Toggle` provides a switch-like control that allows users to turn options on or off. It supports custom labels, different sizes, and various states to match your application's needs. -## Default (untoggled) +## Default -Display a basic toggle with a label. +Display a basic toggle in its untoggled state by default.