feat: Update SandpackConsole

Added showRestartButton and showResetConsoleButton props, and removed showResetButton prop in SandpackConsole component
codesandbox · Nov 27, 2023 · a9d72a2 · a9d72a2
1 parent adb90d8
commit a9d72a2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/sandpack-react/src/components/Console/SandpackConsole.tsx b/sandpack-react/src/components/Console/SandpackConsole.tsx
@@ -22,7 +22,8 @@ interface SandpackConsoleProps {
   showHeader?: boolean;
   showSyntaxError?: boolean;
   showSetupProgress?: boolean;
-  showResetButton?: boolean;
+  showRestartButton?: boolean;
+  showResetConsoleButton?: boolean;
   maxMessageCount?: number;
   onLogsChange?: (logs: SandpackConsoleData) => void;
   resetOnPreviewRestart?: boolean;
@@ -52,7 +53,8 @@ export const SandpackConsole = React.forwardRef<
       onLogsChange,
       className,
       showSetupProgress = false,
-      showResetButton = true,
+      showResetConsoleButton = true,
+      showRestartButton = true,
       resetOnPreviewRestart = false,
       actionsChildren = <></>,
       standalone = false,
@@ -168,7 +170,7 @@ export const SandpackConsole = React.forwardRef<
         >
           {actionsChildren}
 
-          {isServerTab && (
+          {showRestartButton && isServerTab && (
             <RoundedButton
               onClick={(): void => {
                 restart();
@@ -180,7 +182,7 @@ export const SandpackConsole = React.forwardRef<
             </RoundedButton>
           )}
 
-          {showResetButton && (
+          {showResetConsoleButton && (
             <RoundedButton
               onClick={(): void => {
                 if (currentTab === "client") {

diff --git a/website/docs/src/pages/advanced-usage/components.mdx b/website/docs/src/pages/advanced-usage/components.mdx
@@ -578,10 +578,11 @@ export default () => (
 
 | Prop                    | Description                                                                              | Type                                  | Default              |
 | :---------------------- | :--------------------------------------------------------------------------------------- | :------------------------------------ | :------------------- |
-| `clientId`              |                                                                                          | `string`                              | `undefined`          |
+| `clientId`              |                                                                                          | `string`                              | `undefined`           |
 | `showHeader`            |                                                                                          | `boolean`                             | `true`               |
 | `showSyntaxError`       |                                                                                          | `boolean`                             | `false`              |
-| `showResetButton`       |                                                                                          | `boolean`                             | `true`              |
+| `showResetConsoleButton` |                                                                                         | `boolean`                             | `true`               |
+| `showRestartButton`     |                                                                                          | `boolean`                             | `true`               |
 | `maxMessageCount`       |                                                                                          | `number`                              | `800`                |
 | `onLogsChange`          |                                                                                          | `(logs: SandpackConsoleData) => void` |                      |
 | `resetOnPreviewRestart` | Reset the console list on every preview restart                                          | `boolean`                             | `false`              |