feat: Add global option to toggle connection

Implements: #32

example/src/App.jsx

@@ -17,14 +17,18 @@ import {
   Button,
   Card,
   CardContent,
+  Checkbox,
   Container,
+  FormControlLabel,
   Grid,
   TextField,
   Typography,
 } from "@mui/material";
 import ExpandMoreIcon from "@mui/icons-material/ExpandMore";
 
 export function App() {
+  const [enabled, setEnabled] = useState(true);
+
   return (
     //Initialize Stomp connection, will use sockjs, as the protocol specified is https
     //The Connection can be used by all child components via the hooks or hocs.
@@ -34,8 +38,20 @@ export function App() {
       debug={(str) => {
         console.log(str);
       }}
+      //The enabled prop can be used to enable/disable the connection. Defaults to true
+      enabled={enabled}
     >
       <CssBaseline />
+      <FormControlLabel
+        className="enable-checkbox"
+        control={
+          <Checkbox
+            checked={enabled}
+            onChange={(event) => setEnabled(event.target.checked)}
+          />
+        }
+        label="Enabled"
+      />
       <Container>
         <Card style={{ margin: "3em" }}>
           <CardContent>

example/src/index.css

@@ -12,3 +12,9 @@ code {
   font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New",
     monospace;
 }
+
+.enable-checkbox {
+  position: absolute;
+  bottom: 0;
+  right: 0;
+}

src/components/StompSessionProvider.tsx

@@ -20,7 +20,7 @@ import { StompSessionSubscription } from "../interfaces/StompSessionSubscription
  * Please consult the @stomp/stompjs documentation for more information.
  */
 function StompSessionProvider(props: StompSessionProviderProps) {
-  const { url, children, ...stompOptions } = props;
+  const { url, children, enabled, ...stompOptions } = props;
 
   const [client, setClient] = useState<Client | undefined>(undefined);
   const subscriptionRequests = useRef(new Map());
@@ -68,12 +68,14 @@ function StompSessionProvider(props: StompSessionProviderProps) {
       };
     }
 
-    _client.activate();
+    if (enabled !== false) {
+      _client.activate();
+    }
 
     return () => {
       _client.deactivate();
     };
-  }, [url, ...Object.values(stompOptions)]);
+  }, [url, enabled, ...Object.values(stompOptions)]);
 
   const subscribe = (
     destination: string,

src/interfaces/StompSessionProviderProps.ts

@@ -4,4 +4,5 @@ import { ReactNode } from "react";
 export interface StompSessionProviderProps extends StompConfig {
   url: string;
   children: ReactNode;
+  enabled?: boolean;
 }