From a74a03ed6bf989ed7e979000dee5c33e5f66462c Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Tue, 22 Oct 2024 15:14:24 +0200 Subject: [PATCH] [docs] Follow types description convention --- .../InitColorSchemeScript.tsx | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/packages/mui-system/src/InitColorSchemeScript/InitColorSchemeScript.tsx b/packages/mui-system/src/InitColorSchemeScript/InitColorSchemeScript.tsx index fa0a8b987ba7c3..4ff9b8050d418e 100644 --- a/packages/mui-system/src/InitColorSchemeScript/InitColorSchemeScript.tsx +++ b/packages/mui-system/src/InitColorSchemeScript/InitColorSchemeScript.tsx @@ -9,45 +9,44 @@ export const DEFAULT_ATTRIBUTE = 'data-color-scheme'; export interface InitColorSchemeScriptProps { /** - * The default mode when the storage is empty (user's first visit) + * The default mode when the storage is empty (user's first visit). * @default 'system' */ defaultMode?: 'system' | 'light' | 'dark'; /** - * The default color scheme to be used on the light mode + * The default color scheme to be used on the light mode. * @default 'light' */ defaultLightColorScheme?: string; /** - * The default color scheme to be used on the dark mode + * The default color scheme to be used on the dark mode. * * @default 'dark' */ defaultDarkColorScheme?: string; /** - * The node (provided as string) used to attach the color-scheme attribute + * The node (provided as string) used to attach the color-scheme attribute. * @default 'document.documentElement' */ colorSchemeNode?: string; /** - * localStorage key used to store `mode` + * localStorage key used to store `mode`. * @default 'mode' */ modeStorageKey?: string; /** - * localStorage key used to store `colorScheme` + * localStorage key used to store `colorScheme`. * @default 'color-scheme' */ colorSchemeStorageKey?: string; /** - * DOM attribute for applying color scheme + * DOM attribute for applying color scheme. * @default 'data-color-scheme' - * * @example '.mode-%s' // for class based color scheme * @example '[data-mode-%s]' // for data-attribute without '=' */ attribute?: 'class' | 'data' | string; /** - * Nonce string to pass to the inline script for CSP headers + * Nonce string to pass to the inline script for CSP headers. */ nonce?: string | undefined; }