Merge pull request #22857 from awanlin/topic/unified-theme-docs

Unified Theme Doc Updates & Exported `defaultTypography`

packages/theme/api-report.md

@@ -205,6 +205,9 @@ export const darkTheme: Theme_3;
 // @public
 export const defaultComponentThemes: ThemeOptions['components'];
 
+// @public
+export const defaultTypography: BackstageTypography;
+
 // @public
 export function genPageTheme(props: {
   colors: string[];

packages/theme/src/base/createBaseThemeOptions.ts

@@ -22,6 +22,46 @@ const DEFAULT_FONT_FAMILY =
   '"Helvetica Neue", Helvetica, Roboto, Arial, sans-serif';
 const DEFAULT_PAGE_THEME = 'home';
 
+/**
+ * Default Typography settings.
+ *
+ * @public
+ */
+export const defaultTypography: BackstageTypography = {
+  htmlFontSize: DEFAULT_HTML_FONT_SIZE,
+  fontFamily: DEFAULT_FONT_FAMILY,
+  h1: {
+    fontSize: 54,
+    fontWeight: 700,
+    marginBottom: 10,
+  },
+  h2: {
+    fontSize: 40,
+    fontWeight: 700,
+    marginBottom: 8,
+  },
+  h3: {
+    fontSize: 32,
+    fontWeight: 700,
+    marginBottom: 6,
+  },
+  h4: {
+    fontWeight: 700,
+    fontSize: 28,
+    marginBottom: 6,
+  },
+  h5: {
+    fontWeight: 700,
+    fontSize: 24,
+    marginBottom: 4,
+  },
+  h6: {
+    fontWeight: 700,
+    fontSize: 20,
+    marginBottom: 2,
+  },
+};
+
 /**
  * Options for {@link createBaseThemeOptions}.
  *
@@ -57,40 +97,8 @@ export function createBaseThemeOptions<PaletteOptions>(
     throw new Error(`${defaultPageTheme} is not defined in pageTheme.`);
   }
 
-  const defaultTypography: BackstageTypography = {
-    htmlFontSize,
-    fontFamily,
-    h1: {
-      fontSize: 54,
-      fontWeight: 700,
-      marginBottom: 10,
-    },
-    h2: {
-      fontSize: 40,
-      fontWeight: 700,
-      marginBottom: 8,
-    },
-    h3: {
-      fontSize: 32,
-      fontWeight: 700,
-      marginBottom: 6,
-    },
-    h4: {
-      fontWeight: 700,
-      fontSize: 28,
-      marginBottom: 6,
-    },
-    h5: {
-      fontWeight: 700,
-      fontSize: 24,
-      marginBottom: 4,
-    },
-    h6: {
-      fontWeight: 700,
-      fontSize: 20,
-      marginBottom: 2,
-    },
-  };
+  defaultTypography.htmlFontSize = htmlFontSize;
+  defaultTypography.fontFamily = fontFamily;
 
   return {
     palette,

packages/theme/src/base/index.ts

@@ -14,7 +14,10 @@
  * limitations under the License.
  */
 
-export { createBaseThemeOptions } from './createBaseThemeOptions';
+export {
+  createBaseThemeOptions,
+  defaultTypography,
+} from './createBaseThemeOptions';
 export type { BaseThemeOptionsInput } from './createBaseThemeOptions';
 export { colorVariants, genPageTheme, pageTheme, shapes } from './pageTheme';
 export { palettes } from './palettes';