add jsdoc for util

mui · Sep 22, 2023 · 53f626e · 53f626e
1 parent 3f8038a
commit 53f626e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/packages/mui-joy/src/CircularProgress/CircularProgressCssVars.ts b/packages/mui-joy/src/CircularProgress/CircularProgressCssVars.ts
@@ -1,4 +1,4 @@
-import { CssVarsValuesType } from '../utils/CssVarsType';
+import { CssVarsType } from '../utils/CssVarsType';
 
 const circularProgressCssVars = {
   thickness: '--CircularProgress-thickness',
@@ -13,7 +13,7 @@ const circularProgressCssVars = {
   circulation: '--CircularProgress-circulation',
 } as const;
 
-export type CircularProgressCssVarsType = CssVarsValuesType<
+export type CircularProgressCssVarsType = CssVarsType<
   keyof typeof circularProgressCssVars,
   'CircularProgress'
 >;

diff --git a/packages/mui-joy/src/utils/CssVarsType.ts b/packages/mui-joy/src/utils/CssVarsType.ts
@@ -1,3 +1,12 @@
-export type CssVarsValuesType<Keys extends string, Component extends string> = Partial<
+/**
+ * A type which generates CSS Variables.
+ * @example
+ * type ButtonCssVars = CssVarsType<'color' | 'size', 'Button'>;
+ *  ButtonCssVars = {
+ * '--Button-color'?: string | number;
+ * '--Button-size'?: string | number;
+ * }
+ */
+export type CssVarsType<Keys extends string, Component extends string> = Partial<
   Record<`--${Component}-${Keys}`, string | number>
 >;