-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: allow blocks lower than units to be bookmarked #35207
Open
navinkarkera
wants to merge
1
commit into
openedx:master
Choose a base branch
from
open-craft:navin/bookmark
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+40
−19
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@navinkarkera I am not able to understand this, how is the navigation happening now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now I think I understand this function is called when we click a bookmark, it's just a way to log it, but it just makes me wonder do we had to do a
window.location.href
I am just trying to figure the reasoning out of it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@farhaanbukhsh My best guess is that it was done to log the event first and then navigate but this way we loose query params. It felt weird to navigate using javascript when it is already handled by the browser link element.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand my only concern was are we missing some cases, but it doesn't seem like it.