convert component class enums to const objects and add supported types

microsoft · May 3, 2022 · d6998db · d6998db
1 parent 283a065
commit d6998db
Show file tree

Hide file tree

Showing 39 changed files with 638 additions and 305 deletions.
diff --git a/packages/web-components/fast-components/docs/api-report.md b/packages/web-components/fast-components/docs/api-report.md
@@ -1756,12 +1756,13 @@ export const sliderLabelStyles: FoundationElementTemplate<ElementStyles>;
 export const sliderStyles: FoundationElementTemplate<ElementStyles, SliderOptions>;
 
 // @public
-export enum StandardLuminance {
-    // (undocumented)
-    DarkMode = 0.23,
-    // (undocumented)
-    LightMode = 1
-}
+export const StandardLuminance: {
+    readonly LightMode: 1;
+    readonly DarkMode: 0.23;
+};
+
+// @public
+export type StandardLuminance = typeof StandardLuminance[keyof typeof StandardLuminance];
 
 // @public (undocumented)
 export const strokeWidth: CSSDesignToken<number>;

diff --git a/packages/web-components/fast-components/src/color/utilities/base-layer-luminance.ts b/packages/web-components/fast-components/src/color/utilities/base-layer-luminance.ts
@@ -13,3 +13,10 @@ export const StandardLuminance = {
     LightMode: 1,
     DarkMode: 0.23,
 } as const;
+
+/**
+ * Types of recommended values for light and dark mode for {@link @microsoft/fast-components#baseLayerLuminance}.
+ *
+ * @public
+ */
+export type StandardLuminance = typeof StandardLuminance[keyof typeof StandardLuminance];