feat: replace hint settings with reset option

Author: pkulkark

branching_xblock/branching_xblock.py

@@ -65,10 +65,10 @@ class BranchingXBlock(XBlock):
         help="Enable scoring for gradebook integration"
     )
 
-    enable_hints = Boolean(
+    enable_reset_activity = Boolean(
         default=False,
-        scope=Scope.settings,
-        help="Allow learners to reveal hints for each node"
+        scope=Scope.content,
+        help="Allow learners to reset the activity"
     )
 
     max_score = Float(
@@ -215,7 +215,7 @@ def studio_view(self, context=None):
             "start_node_id": self.scenario_data.get("start_node_id"),
             "enable_undo": bool(self.enable_undo),
             "enable_scoring": bool(self.enable_scoring),
-            "enable_hints": bool(self.enable_hints),
+            "enable_reset_activity": bool(self.enable_reset_activity),
             "max_score":   self.max_score,
             "display_name": self.display_name,
             "authoring_help_html": authoring_help_html,
@@ -230,7 +230,7 @@ def _get_state(self):
             "start_node_id":   self.scenario_data.get("start_node_id"),
             "enable_undo":     bool(self.enable_undo),
             "enable_scoring":  bool(self.enable_scoring),
-            "enable_hints":    bool(self.enable_hints),
+            "enable_reset_activity": bool(self.enable_reset_activity),
             "max_score":       self.max_score,
             "display_name":    self.display_name,
             "current_node":    self.get_current_node(),
@@ -294,6 +294,26 @@ def undo_choice(self, data, suffix=''):
         self.has_completed = False
         return {"success": True, **self._get_state()}
 
+    @XBlock.json_handler
+    def reset_activity(self, data, suffix=''):
+        """
+        Reset learner state to the start node.
+        """
+        if not self.enable_reset_activity:
+            return {"success": False, "error": "Reset not allowed"}
+
+        self.current_node_id = None
+        self.history = []
+        self.has_completed = False
+
+        if self.enable_scoring:
+            self.score = 0.0
+            self.publish_grade()
+
+        self.start_node()
+        self.runtime.publish(self, "completion", {"completion": 0.0})
+        return {"success": True, **self._get_state()}
+
     @XBlock.json_handler
     def studio_submit(self, data, suffix=''):
         """
@@ -370,7 +390,7 @@ def studio_submit(self, data, suffix=''):
         }
         self.enable_undo = bool(payload.get('enable_undo', self.enable_undo))
         self.enable_scoring = bool(payload.get('enable_scoring', self.enable_scoring))
-        self.enable_hints = bool(payload.get('enable_hints', self.enable_hints))
+        self.enable_reset_activity = bool(payload.get('enable_reset_activity', self.enable_reset_activity))
         self.max_score = float(payload.get('max_score', self.max_score))
         self.display_name = payload.get('display_name', self.display_name)
 

branching_xblock/static/css/branching_xblock.css

@@ -197,6 +197,16 @@
     margin-left: 1em;
 }
 
+.reset-button {
+    border: 1px solid #4a5568;
+    border-radius: 4px;
+    padding: 0.6em 1.2em;
+    font-size: 1em;
+    cursor: pointer;
+    background: transparent;
+    color: #1f2a37;
+}
+
 .score-display {
     padding: 1em 1em;
     font-size: small;

branching_xblock/static/handlebars/settings-panel.handlebars

@@ -12,8 +12,8 @@
     Enable scoring
   </label>
   <label>
-    <input type="checkbox" name="enable_hints" {{#if enable_hints}}checked{{/if}}/>
-    Allow learners to reveal hints
+    <input type="checkbox" name="enable_reset_activity" {{#if enable_reset_activity}}checked{{/if}}/>
+    Enable reset activity
   </label>
   <label>
     Max Score:

branching_xblock/static/html/branching_xblock.html

@@ -14,7 +14,10 @@
         <div class="choices" data-role="choices"></div>
 
         <button class="undo-button action-secondary btn-secondary" data-role="undo" style="display: none;">
-            <i class="fa fa-undo" aria-hidden="true"></i>&nbsp;Undo
+            Go Back
+        </button>
+        <button type="button" class="reset-button action-secondary btn-secondary" data-role="reset-activity" style="display: none;">
+            Reset
         </button>
 
         <div class="score-display" data-role="score" style="display: none;"></div>

branching_xblock/static/js/src/branching_xblock.js

@@ -133,8 +133,9 @@ function BranchingXBlock(runtime, element) {
         const $hintContainer = $el.find('[data-role="hint-container"]');
         const $hintDetails = $hintContainer.find('[data-role="hint-collapsible"]');
         const $hint = $hintDetails.find('[data-role="hint"]');
-        if (state.enable_hints && node && node.hint) {
-            $hint.html(`<strong>Hint:</strong> ${node.hint}`);
+        const hintText = (node && node.hint ? String(node.hint) : '').trim();
+        if (node && hintText) {
+            $hint.html(`<strong>Hint:</strong> ${hintText}`);
             $hintDetails.prop('hidden', false);
             setHintVisibility(isHintVisible);
         } else {
@@ -159,6 +160,9 @@ function BranchingXBlock(runtime, element) {
         const canUndo = state.enable_undo && state.history.length > 0;
         $el.find('.undo-button').toggle(canUndo);
 
+        const showReset = Boolean(state.enable_reset_activity);
+        $el.find('[data-role="reset-activity"]').toggle(showReset);
+
         const $score = $el.find('[data-role="score"]');
         const isLeaf = choices.length === 0;
         if (isLeaf && state.enable_scoring) {
@@ -203,6 +207,16 @@ function BranchingXBlock(runtime, element) {
         }).done(refreshView);
     });
 
+    $el.on('click', '[data-role="reset-activity"]', function() {
+        $.ajax({
+          url: runtime.handlerUrl(element, 'reset_activity'),
+          type: 'POST',
+          data: JSON.stringify({}),
+          contentType: 'application/json',
+          dataType: 'json'
+        }).done(refreshView);
+    });
+
     // Initial load
     refreshView();
 

branching_xblock/static/js/src/studio_editor.js

@@ -183,7 +183,7 @@ function BranchingStudioEditor(runtime, element, data) {
           nodes: [],
           enable_undo:    $settings.find('[name="enable_undo"]').is(':checked'),
           enable_scoring: $settings.find('[name="enable_scoring"]').is(':checked'),
-          enable_hints:   $settings.find('[name="enable_hints"]').is(':checked'),
+          enable_reset_activity: $settings.find('[name="enable_reset_activity"]').is(':checked'),
           max_score:      parseFloat($settings.find('[name="max_score"]').val()) || 0,
           display_name:   $settings.find('[name="display_name"]').val()?.trim() || ''
       };