-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: allow blocks lower than units to be bookmarked
Adds support to jump/scroll to blocks lower than units if bookmarked. It also fixes an issue with bookmark visit url function where it was not passing query params.
- Loading branch information
1 parent
1573c7b
commit aeddb8a
Showing
4 changed files
with
40 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 32 additions & 15 deletions
47
openedx/features/course_bookmarks/static/course_bookmarks/js/models/bookmark.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,37 @@ | ||
(function(define) { | ||
'use strict'; | ||
'use strict'; | ||
|
||
define(['backbone'], function(Backbone) { | ||
return Backbone.Model.extend({ | ||
idAttribute: 'id', | ||
defaults: { | ||
course_id: '', | ||
usage_id: '', | ||
display_name: '', | ||
path: [], | ||
created: '' | ||
}, | ||
define(['backbone'], function(Backbone) { | ||
return Backbone.Model.extend({ | ||
idAttribute: 'id', | ||
defaults: { | ||
course_id: '', | ||
usage_id: '', | ||
display_name: '', | ||
path: [], | ||
created: '' | ||
}, | ||
|
||
blockUrl: function() { | ||
return '/courses/' + this.get('course_id') + '/jump_to/' + this.get('usage_id'); | ||
} | ||
}); | ||
blockUrl: function() { | ||
var path = this.get('path'); | ||
var url = '/courses/' + this.get('course_id') + '/jump_to/' + this.get('usage_id'); | ||
var params = new URLSearchParams(); | ||
var usage_id = this.get('usage_id'); | ||
// Confirm that current usage_id does not correspond to current unit | ||
// path contains an array of parent blocks to the bookmarked block. | ||
// Units only have two parents i.e. section and subsections. | ||
// Below condition is only satisfied if a block lower than unit is bookmarked. | ||
if (path.length > 2 && usage_id !== path[path.length - 1]) { | ||
params.append('jumpToId', usage_id); | ||
} | ||
if (params.size > 0) { | ||
// Pass nested block details via query parameters for it to be passed to learning mfe | ||
// The learning mfe should pass it back to unit xblock via iframe url params. | ||
// This would allow us to scroll to the child xblock. | ||
url = url + '?' + params.toString(); | ||
} | ||
return url; | ||
} | ||
}); | ||
}); | ||
}(define || RequireJS.define)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters