fix(Settings): extend description SettingsItem prop

gravity-ui · Oct 13, 2023 · dae240e · dae240e
1 parent f8f8491
commit dae240e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/components/Settings/README.md b/src/components/Settings/README.md
@@ -55,7 +55,7 @@ The components provides layouting functionality of settings panel with the follo
 | renderTitleComponent | Function        |          |          | Cusomt header of                                           |
 | align                | 'top', 'center' |          | 'center' | Item alignment                                             |
 | mode                 | 'row'           |          |          | Layout for mobile. Title and control will be placed in row |
-| description          | string          |          |          | Description of item                                        |
+| description          | ReactNode       |          |          | Description of item                                        |
 
 ### Usage
 

diff --git a/src/components/Settings/Settings.tsx b/src/components/Settings/Settings.tsx
@@ -63,7 +63,7 @@ export interface SettingsItemProps {
     children: React.ReactNode;
     withBadge?: boolean;
     mode?: 'row';
-    description?: string;
+    description?: React.ReactNode;
 }
 
 export interface SettingsContextType