Skip to content
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

Make 'new_window' a valid display type #2459

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

julianvu
Copy link

@julianvu julianvu commented Feb 20, 2025

LTI tools registered using Dynamic Registration have no way of configuring navigation placements to open in a new tab instead of in frame. Adding 'new_window' to enum of VALID_DISPLAY_TYPES in InternalLtiConfiguration schema allows for this.

Test Plan:

  • Configure an LTI 1.3 tool with the Course Navigation placement using Dynamic Registration, ensuring that the message object has the following:
"https://canvas.instructure.com/lti/display_type" : "new_window"
  • Enable the tool in a course
  • Select the course navigation link added by the tool. The tool should open in a new tab instead of in frame.

LTI tools registered using Dynamic Registration have no way of configuring navigation placements to open in a new tab instead of in frame. Adding 'new_window' to enum of VALID_DISPLAY_TYPES in InternalLtiConfiguration schema allows for this.

Test Plan:
- Configure an LTI 1.3 tool with the Course Navigation placement using Dynamic Registration
- Enable the tool in a course
- Select the course navigation link added by the tool. The tool should open in a new tab instead of in frame.
@julianvu
Copy link
Author

The new_window display type is already supported internally to open LTI 1.3 tools in a new tab. The issue is new_window triggers a validation error if it's included in the tool registration request. Adding it to the enum will allow this parameter through, which will then allow a tool registered using Dynamic Registration to launch in a new tab.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants