Search the Community
Who should I direct my questions to regarding instUI? I am able to use the boiler plate create-react-app and post to localhost:3000. However when I try to use creating a starter app from instructure-ui : UI libraries made by Instructure Inc. (6.15.0) I am getting one error after another. I am using Visual Studio Code and I am using both Mac and Windows.
I am creating a repository on .git and I plan to upload to Heroku to see if I can add something to Canvas. I am just wondering if someone has published a better way!?
I am not finding a way to create the LTI connectors I need to add the app to Canvas as an LTI. Is there discussion available now or ???
- Tags:
- instui react
Since its inception, Canvas has always been open and transparent about our business and our features. We believe in being open. We believe in allowing you to use Canvas the way you want to use Canvas. And branding is one component that we’ve been working hard to improve, specifically relating to the use of the existing style guide and Instructure UI (InstUI), Instructure’s own component library.
Branding Evolution
Web technologies continue to evolve, and over the last three years, we’ve been able to introduce the Theme Editor at the account level, which helps admins create custom templates without the use of custom CSS and JavaScript files, although those file types are still accepted.
Previously, Canvas engineers implemented a style guide to be used for internal engineering teams and ensure consistency throughout the product, hosted as part of each Canvas account (e.g. canvas.instructure.com/styleguide). Over time, we noticed that some of our customers started to leverage that style guide. We know that you enjoy being able to design your own Canvas-theme projects within the Rich Content Editor. Now, with the evolution of additional technology advancements, we’ve discontinued the use of the old style guide in favor of InstUI.
Why InstUI?
In order to use the styleguide, a developer or course designer would copy the HTML markup for a user interface pattern, such as tabs, and paste that markup throughout Canvas. However, HTML is only part that pattern. The style of those tabs is defined with CSS, and the interaction of navigating between tabs is enabled through Javascript. This architecture quickly became difficult to maintain. If we were to make a style enhancement or fix a Javascript bug that necessitated updating that HTML, every instance of those tabs—whether in Canvas, in a custom tool, or in course content—would have to be updated manually or remain broken.
To combat these maintenance challenges, we made the decision to move Canvas front-end development to React, a library developed by Facebook for creating modular user interfaces. React components encapsulate the HTML structure, the styles, and the Javascript together into a reusable, easily maintainable component. A bug fix to a React component propagates to every instance of that component with little to no effort, only needs to be made in one place, and every user immediately benefits.
InstUI, Instructure’s own UI component library, is built using React, which allows our developers to deliver new features more efficiently and makes all of Canvas easier to maintain and innovate. InstUI ensures consistent, accessible experiences throughout Canvas and delivers custom themes made with the Theme Editor to all interactions, just like the style guide intended. With React, those experiences are better tested, better maintained, and more reliable than ever for our users.
InstUI Availability
If you’re interested in using the InstUI components, InstUI is open source and available for you to use in your LTI tools. To get started, visit instructure.design. If you’re starting from scratch, InstUI works great with React boilerplates like Create React App.
We haven’t enabled the use of InstUI in the Rich Content Editor yet; however, other tools are currently available for integrating custom changes. Some options as noted in the community include H5P and other canvas embed tools.
Future Development
In 2019, the InstUI team will begin work to improve documentation and support for third parties.
Additionally, we recognize we don’t have an ideal solution for making changes in the Rich Content Editor. For now, we’re focusing on building a better Rich Content Editor to give you a better experience and give you more controls to design pages the way you want. This project is in the planning stages, and if you want to get more involved, watch for additional details to be posted in Canvas Studio.
If you’ve been using InstUI, let us know your thoughts in our InstUI Community Discussion.
If you’re not using InstUI but have used elements from the style guide in your pages, please let us know in the comments which elements you used and why they were helpful to you. Style guide feedback may be considered for future development.
-
...he InstUI could be of use if you're writing your own LTI, but not if you're using someone else's LTI....
-
...unky. Because it is absolutely 100% NOT THAT! InstUI ensures consistent, accessible e...
-
...atch?v=iPJC-F3FLfM We are looking for a React-based LTI tool to easily add InstUI to our pages. E...
-
Could you give me an example of an LTI that you would use InstUI in? As a new Canvas user, t...
-
You can use the Instructure UI React components in LTIs. We do not have a way to use InstUI i...
-
...xplaining. Let's say I'm writing an LTI not using ReactJS or InstUI because I don't know how o...
-
...opups We will be interested to be updated on InstUI 2.0 development as any new developments on InstUI...
-
I don't know how much of it is like this discussion about InstUI 2.0 and they're actually g...
-
...he API docs and current style guide. If InstUI is Styleguide 2.0, then it would be nice if s...
Hi everybody --
I'd like to propose an InstUI style guide for instructional designers. For years, I have used the design patterns and CSS classes in the old (now deprecated) Canvas style guide to create pages that look like they belong in Canvas. I would like to do the same with InstUI. But it looks like it is only available for LTI designers using React. Instructure is not supporting the old styles, but it is also not giving us the resources to design using the new styles, which puts me -- and I'm sure a lot of other folks -- in a bad position.
At the very least, it would be helpful to have a list of classes and what they do, and a few examples of how to use InstUI to create common page components like columns, (faux-)buttons, tabs, and accordion boxes.
Any help?
Hi, Canvas developers! Our UI team is working on way to improve InstUI, Instructure's UI library, from an open source standpoint. If you are using InstUI in your projects, our UI team would like to hear from you!
Please reply and share your experience. Some things we'd like to know:
- Why you are using InstUI
- How you are using InstUI in your projects
- What you currently like about InstUI
- What changes would improve your InstUI experience
...and anything else you'd like to contribute about InstUI.
Thanks!
Erin
-
Hi Erin, First, I'm excited to start looking into what instui can do for projects, and I a...
-
...o help them plan improvements to InstUI accordingly. Thanks, Erin
-
Hi Erin - We started using InstUI earlier this year and have integrated it (v5.5.0) into 3 of our L...
-
...uch. We know some customers were previously aware of the Canvas style guide and used that until InstUI...
-
...he previous style guide was being used. I'm not sure if you've read InstUI: Instructure’s Style G...
-
...inks to InstUI. It is only accessible to programmers. The ease of use of the style sheets is now g...
-
...ant to use InstUI, but the required resource allocation (namely time) makes it impossible for me to do s...
-
...So for me, the entire shift to slowly disable simply jquery and simple css in favor of InstUI is u...
-
...eam would be interested to be updated when will InstUI 2.0 be available on Rich Content Editors so t...
This document highlights all default and optional features in the current Canvas web release if available for each user role. The date of this document indicates when the included features will be available in the production environment. Unless otherwise indicated, features are already available in the beta environment.
Default Features
Default features affect all Canvas users. If enabled in the Help Menu, the Release Notes section displays links to these features according to user role.
Optional Features
Use of optional features vary across institutions, and the Optional Features section for each user role is designed to assist you in distributing information about these features if you choose to enable them for your institution.
- Admin Roles
- Default Features
- Optional Features
- Instructor Roles
- Default Features
- Optional Features
- Observer/Student Roles
- Default Features
Admin Roles |
View additional details for Canvas Deploy Notes (2023-10-25)
Default Features
Notifications
Discussion Push Notifications
In Notifications, users can enable Push Notifications for Discussion New Topics and New Replies.
InstUI
Version Update
Canvas infrastructure is updated using the latest version of InstUI, Instructure’s internal design language.
Optional Features
LTI Tools
- Google Apps LTI: End of Life Banner [Delayed as of 2023-10-24]
Instructor Roles |
View additional details for Canvas Deploy Notes (2023-10-25)
Default Features
Interface Updates
- Notifications: Discussion Push Notifications
Other Updates
- InstUI: Version Update
Optional Features
LTI Tools
- Google Apps LTI: End of Life Banner [Delayed as of 2023-10-24]
Observer/Student Roles |
View additional details for Canvas Deploy Notes (2023-10-25)
Default Features
Interface Updates
- Notifications: Discussion Push Notifications
Other Updates
- InstUI: Version Update
- Tags:
- 2023-10-15
Canvas deploys contain code changes that are intended to fix bugs, improve performance, and prepare for new features. These deploys take place every two weeks and can be tested in the beta environment before the production deploy date indicated in the title of this document.
Deploy notes indicate notable changes in the deploy by feature. To view functionality according to user role, please see Canvas Features by User Role.
Fixed bugs are located in Known Issues. For related issues resolved in this deploy, view the 2023-10-25 Known Issues tag.
|
- Interface Updates
- Notifications
- Discussion Push Notifications
- LTI Updates
- Google Apps LTI
- End of Life Banner [Delayed as of 2023-10-24]
- Other Updates
- InstUI
- Version Update
Interface Updates |
Notifications
Discussion Push Notifications
User Role & Summary Link |
All Users | Canvas Features by User Role |
Affected Feature Areas |
Notifications |
Account Setting to Enable |
None |
Permissions |
Inherent to user |
Related Ideas |
[Discussions] Bring back push notifications for discussion boards. |
Summary
In Notifications, users can enable Push Notifications for Discussion New Topics and New Replies.
Change Benefit
This update allows users to set up notifications for new topics or new replies in a discussion.
Feature Workflow
In Notifications, users can enable push notifications for new topics and new replies related to Discussions.
LTI Updates |
Google Apps LTI
End of Life Banner [Delayed as of 2023-10-24]
Affected LTI Tools |
|
User Role & Summary Link |
Admin, Instructors | Canvas Features by User Role |
Affects User Interface |
Yes |
Affected Feature Areas |
Google Meet, Google Drive |
Related Ideas |
None |
Related Blog |
ANNOUNCING Collaborations in Canvas: A New Feature in Google Assignments LTI 1.3 and Google Meet LTI |
Summary
In Google Drive and Google Meet LTI, a banner displays that the Google Apps LTI is no longer supported as of June 30, 2024.
Change Benefit
This update provides a dismissible in-app notice announcing the end of life for these apps and improves awareness for Admins and Instructors.
Feature Workflow
When Google Drive is launched, a banner displays.
When Google Meet is launched, a banner displays.
Additional Details
This banner only displays for Admin, Instructor, TA, and Designer base-roles and is dismissible until the next time the tool is launched.
Other Updates |
InstUI
Version Update
User Role & Summary Link |
All Users | Canvas Features by User Role |
Affects User Interface |
No |
Affected Feature Areas |
InstUI |
Related Ideas |
None |
Summary
Canvas infrastructure is updated using the latest version of InstUI, Instructure’s internal design language.
Note: Institutions with Custom JS and CSS should verify any changes.
Change Benefit
This update improves user interface infrastructure, allowing Canvas development teams to leverage the latest design system.
Date | |
---|---|
2023-10-24 |
Updated Feature Google Apps LTI: End of Life Banner is delayed and will be re-released at a later deploy. |
2023-10-13 | Published Deploy Notes |
- Tags:
- 2023-10-25
This document highlights all default and optional features in the current Canvas web release if available for each user role. The date of this document indicates when the included features will be available in the production environment. Unless otherwise indicated, features are already available in the beta environment.
Default Features
Default features affect all Canvas users. If enabled in the Help Menu, the Release Notes section displays links to these features according to user role.
Optional Features
Use of optional features vary across institutions, and the Optional Features section for each user role is designed to assist you in distributing information about these features if you choose to enable them for your institution.
Admin Roles |
View additional details for Canvas Deploy Notes (2023-09-13)
Feature Options
Gradebook
Hide Totals Checkbox Text Update
In Gradebook Settings, when the Final Grade Override feature option is disabled, the View Options checkbox text only displays Hide Total Column. When the Final Grade Override feature option is enabled, the View Options checkbox text continues to display Hide Total Column and Override Columns.
Quizzes
Choose a Quiz Engine Pop-up Text Update
When New Quizzes is enabled, the Classic Quiz description text is updated in the Choose a Quiz Engine modal. Additionally, the New Quizzes option is listed first.
LTI Updates
Live Events
Update to InstUI 8
The Live Events LTI application coding is updated to InstUI TextInput which improves accessibility for Screen Reader and Keyboard-only users.
Instructor Roles |
View additional details for Canvas Deploy Notes (2023-09-13)
Default Features
Interface Updates
- Outcomes: Question Bank Alignment Calculation Update
LTI Updates
- Live Events: Update to InstUI 8
Optional Features
Feature Options
- Gradebook: Hide Totals Checkbox Text Update
- Quizzes: Choose a Quiz Engine Pop-up Text Update
- Tags:
- 2023-09-13
In this Catalog release (March 6), Catalog is updated to version INSTUI 8.
Note: Prior to this release, institutions who use custom JS/CSS should check their beta instances to verify any possible breaks.
Catalog release notes indicate features and updates that are currently available in the Catalog beta environment. These updates will be available in production environments on the date indicated by the release notes.
Canvas Catalog is an all-in-one learning solution that integrates with the Canvas LMS as a course registration system, payment gateway, and learning platform. Learn more about Canvas Catalog.
Updated Feature |
Version Update
Catalog is updated to InstUI version 8. Additionally, InstUI version 6 is deprecated and is no longer maintained. All new fixes and improvements are only available with the newest InstUI versions.
Note: Prior to this release, institutions who use custom JS/CSS should check their beta instances to verify any possible breaks.
In this Canvas release (April 20), the BigBlueButton Conferences interface has been redesigned using HTML5 for improved usability.
Feature Options
- The Content Security Policy allows institutions to enable a content security policy that restricts custom JavaScript for an institution’s Canvas account and whitelist up to 50 domains.
- For institutions using the New Gradebook, the Final Grade Override option is treated as a course setting and is persistent for all graders in the course. And in account-level Reports, the New Gradebook Final Grade Override scores are included in the Grade Export and Multiple Grading Periods Grade Export reports.
External Tools (LTI)
- For institutions using the Commons LTI, the Filter window in the Search page includes wider spacing between icons and for search filters. Additionally, status banners have been updated or removed for messaging clarification.
Release notes also include API updates and fixed bugs.
Release notes describe upcoming Canvas functionality and are subject to change.
|
Feature OptionsThe following feature options are addressed in this release:
|
- Feature Options
- New Features
- Account Settings
- Content Security Policy
- Updated Features
- Conferences
- BigBlueButtonInterface Redesign
- New Gradebook
- Final Grade Override Setting Persistence
- Reports
- Final Grade Override Column
- Other Updates
- Commons
- Filter Tray
- Status Banners
- Course Import
- Pages Terminology
- Platform/Integration
- API
- API Change Log
- Plagiarism Detection Platform
- LTI Tool Assignment Associations
- Fixed Bugs
- Accessibility
- Course Import
- Dashboard
- ePortfolio
- Grades
- Grading Schemes
- Rubrics
- Theme Editor
- API
- xAPI with LTI Tools
- Authentication
- Authentication Refresh Tokens
- Browsers
- Firefox ESRMinimum RequirementBanner
- Commons
- Copyright Resource Additional Info Tooltip
- Course Import
- Copy a Canvas Course Option and Future Restricted Courses
- Rubrics
- Edge Page Jumps
- SIS Import
- Timestamp Update
- Abort SIS Import updates the updated_at column.
New Features |
Account Settings
Content Security Policy
This feature can be enabled in Canvas through a feature option in Account Settings. Please view the content below for additional details. For more information about feature options, please see the Canvas Release Notes FAQ.
Feature State | Beta |
Location to Enable Feature | Account Settings |
Configuration Details | Contact Customer Success Manager |
Affected Canvas Areas | Account Settings - Security Tab |
Beta/Test Environment Support | Yes |
Permissions | Account-level settings - manage |
Related APIs | Content Security Policy Settings (beta) |
Affects User Interface | Yes |
Affected User Roles | Admins |
Summary
Admins can enable a content security policy that restricts custom JavaScript for an institution’s Canvas account and whitelist up to 50 domains. Subdomains can inherit the policy and whitelist from the main account or create their own policy.
Change Benefit
This change allows admins to manage their own content security policy and domain whitelist.
Affected User Roles & Behaviors
Admins
When enabled, Account Settings displays a Security tab that manages an account’s content security policy and manage the whitelist. The whitelist can be enabled and disabled by the admin at any time.
Each policy includes a Whitelist section that can support up to 50 individual domain names. Using wild cards within a domain is recommended. Canvas and Instructure domains are included automatically and do not count against the 50 domain limit.
Domains from installed LTI tools are automatically added to the whitelist and also do not count against the 50 domain limit. To remove a domain for an LTI tool, the LTI tool must be removed from the account or subaccount. Associated tools are only listed once in the list of whitelisted tool domains, even if they have been installed in multiple subaccounts.
Subdomains can inherit the policy and whitelist from the main account or create their own policy.
Any courses that reside in a domain or subdomain with an enabled content security policy display a Content Security Policy checkbox. This checkbox can only be managed by a Canvas admin and can be used to disable the policy for selected courses.
Feature Idea Contributions
Canvas features are always welcome to feedback. Product teams may make adjustments at any time via the Canvas Feature Idea process.
- View existing Account Settings feature ideas
- For new ideas, please tag the idea with account settings
Updated Features |
Conferences
BigBlueButton Interface Redesign
Location to Enable Feature | Conferences Interface |
Configuration Details | Conferences |
Affected Canvas Areas | Conferences |
Beta Environment Support | test.bigbluebutton.org |
Affects User Interface | Yes |
Affected User Roles | All Users |
Summary
The BigBlueButton Conferences interface has been redesigned using HTML5 for improved usability.
The new Conferences interface is not supported on Internet Explorer or Edge browsers. For best results, BigBlueButton recommends using Firefox or Chrome on desktop and Safari or Chrome on mobile devices.
Premium tier customers can choose to opt out of the new interface by contacting BigBlueButton support. All other Canvas users with questions about using the new interface should contact their Customer Success Manager.
Change Benefit
This change makes the Conferences interface faster and easier to use and removes the requirement for extensions or plugins.
Affected User Roles & Behaviors
All Users
The new BigBlueButton Conferences interface provides improved usability and performance for all users. Users can still participate in a conference using their computer microphone and webcam, communicate using public and private chat, share notes, and annotate presentations using the multi-user whiteboard. Users can select between viewing the presentation area or displaying webcams only.
Shared Notes includes additional functionality for formatting notes text. Users can also export their notes to an HTML, TXT, DOC, PDF, or ODC file. There is now a single Shared Notes window; opening additional notes windows is no longer supported.
The Conferences interface supports a Settings menu that includes new features for improved usability. Users can now enable icon animations that highlight conference participants who are speaking and audio and popup alerts for chat notifications. The Settings menu also includes options to disable webcams and desktop sharing to improve bandwidth. These data saving options are intended for use on mobile browsers but can be enabled on any device. Additionally the Settings menu includes previously-available options to select a default language and fault size.
The Settings menu also includes an option to enable closed captioning in a conference. Closed captioning options are not currently supported in the HTML5 client of the Conferences interface. These features will be supported in a future release.
Presenters
Presenters can upload a YouTube video to a conference. When the video is playing, all users will see the same playback time and speed that is selected by the presenter. However, users can enable their own captions. Shared YouTube videos will not appear in conference recordings.
When uploading a presentation file, presenters can upload multiple files at the same time.
Screen sharing is only supported through WebRTC. Previously, presenters could select to use WebRTC or Java for screen sharing. Screen sharing is only supported in Chrome and Firefox browsers on desktop.
Users may experience errors if the screen that is shared includes the Conferences interface. To correct these errors, simply share another window or application that does not display the Conferences interface.
Poll results are now only viewable to presenters after results have been published. Previously, poll results would display to presenters in real time.
Feature Idea Contributions
Canvas features are always welcome to feedback. Product teams may make adjustments at any time via the Canvas Feature Idea process.
- View existing Conferences feature ideas
- For new ideas, please tag the idea with conferences
New Gradebook
Final Grade Override Setting Persistence
This feature is used in conjunction with feature options in Canvas. Please view the content below for additional details. For more information about LTI tools, please see the Canvas Release Notes FAQ.
Location to Enable Feature | New Gradebook, Individual Gradebook |
Configuration Details | |
Affected Canvas Areas | New Gradebook, SpeedGrader, Student Grades |
Related APIs | Enrollments API |
Affects User Interface | Yes |
Affected User Roles | Instructors |
Summary
The Final Grade Override option in the New Gradebook is treated as a course setting and is persistent for all graders in the course. When enabled in the New Gradebook, the Override column displays for all other instructors who view the New Gradebook or the Individual View Gradebook.
Change Benefit
This change provides viewing consistency for all graders in the Gradebook.
Affected User Roles & Behaviors
Graders
When a grader such as an instructor or TA enables the Final Grade Override option in the New Gradebook Settings Menu, the setting is applied for all graders in the course. All other graders who view the New Gradebook will see the Override column if it has been enabled by another instructor. Likewise, the Override column will be hidden if disabled as an option by another instructor.
Feature Idea Contributions
Grade Override as a course feature
Canvas features are always welcome to feedback. Product teams may make adjustments at any time via the Canvas Feature Idea process.
- View existing New Gradebook feature ideas
- For new ideas, please tag the idea with gradebook_new
Reports
Final Grade Override Column
This feature is used in conjunction with feature options in Canvas. Please view the content below for additional details. For more information about LTI tools, please see the Canvas Release Notes FAQ.
Location to Enable Feature | Account Settings - Reports |
Configuration Details | Reports |
Affected Canvas Areas | Reports |
Beta/Test Environment Support | Yes |
Permissions | Courses - View Usage Reports |
Related APIs | Account Reports API |
Affects User Interface | Yes |
Affected User Roles | Admins |
Summary
New Gradebook Final Grade Override scores are included in the Grade Export and Multiple Grading Periods Grade Export reports. Grades are displayed in the override_score column.
Change Benefit
This change helps admins view final grade overrides in grading reports if the Final Grade Override feature option has been allowed or turned on in an account.
Affected User Roles & Behaviors
Admins
When the Final Grade Override feature option has been allowed or turned on in an account, the Grade Export and Multiple Grading Periods Grade Export reports include the override_score column.
Feature Idea Contributions
Canvas features are always welcome to feedback. Product teams may make adjustments at any time via the Canvas Feature Idea process.
- View existing Reports feature ideas
- For new ideas, please tag the idea with reports
Other Updates |
Commons
These features are used in conjunction with an external tool (LTI) in Canvas. Please view the content below for additional details. For more information about LTI tools, please see the Canvas Release Notes FAQ.
Location to Enable Feature | Commons LTI |
Configuration Details | |
Affected Canvas Areas | Commons LTI Any area with imported content |
Beta/Test Environment Support | Functionality affects content in the beta environment only; New/updated features not available until production release |
Permissions | Course Content - add / edit / delete Discussions - view Assignments and Quizzes - add / edit / delete |
Affects User Interface | Yes |
Affected User Roles | Instructors |
Filter Tray
Summary
The Filter window in the Commons Search page includes wider spacing between icons and for search filters.
Change Benefit
This change improves accessibility with an updated design.
Affected User Roles & Behaviors
Instructors
When searching Commons, instructors can more easily filter resources with the updated filter design.
Status Banners
Summary
Status banners have been updated or removed for messaging clarification.
Change Benefit
This update simplifies and clarifies existing banner messages and removes redundant messages in Commons.
Affected User Roles & Behaviors
Instructors
Various messages have been updated or removed from the interface.
- Messages do not display for sharing a new resource or when an instructor views a resource that is still processing, including messages for successful and failed sharing.
- Success and Failure messages still appear in the Preview area while a resource is processing.
- Import status banner message text has been updated for clarity.
Course Import
Pages Terminology
Location to Enable Feature | Course Import |
Affected Canvas Areas | Course Import |
Beta/Test Environment Support | Yes |
Permissions | Course Content - add / edit / delete |
Related APIs | Content Migrations API |
Affects User Interface | Yes |
Affected User Roles | Instructors, Admins |
Summary
In the Course Import Tool, Wiki Pages terminology has been changed to Pages.
Change Benefit
This change aligns consistency with Pages terminology throughout Canvas.
Affected User Roles & Behaviors
Instructors, Admins
When an instructor or admin uses the Course Import Tool and selects specific content to import or copy, the Wiki Pages section heading has been renamed to Pages.
Platform/Integration |
API
API Change Log
Adjustments have been made to the following APIs as noted in the API Documentation change log:
- Submissions API
- Users API
Plagiarism Detection Platform
LTI Tool Assignment Associations
Location to Enable Feature | N/A |
Configuration Details | Plagiarism Detection Platform API |
Affected Canvas Areas | Assignments |
Beta/Test Environment Support | Yes |
Affects User Interface | Yes |
Affected User Roles | Instructors, Admins |
Summary
LTI tools that use the plagiarism platform in an account retain associations with assignments if the tool is removed and re-added at a later date.
Change Benefit
This change helps instructors save time from having to individually edit existing assignments and re-associate the LTI tool.
Affected User Roles & Behaviors
Instructors, Admins
Admins or Instructors who remove and re-add an External Tool (LTI) that uses the plagiarism platform will not have to edit any assignments to re-associate the LTI tool.
Fixed Bugs |
Accessibility
Course Import
The Content Import page error text and error report link can be read by screen readers.
Dashboard
Dashboard View menu items are read to screen readers according to their menu position.
ePortfolio
Keyboard users can add submissions to ePortfolios.
Grades
The Hide/Show Details button in the student Grades page does not include a custom aria-relevant label.
Grading Schemes
Grading scheme buttons include contextual labels for screen readers.
Rubrics
The Outcomes ratings table has been refactored as a data table for screen readers.
Theme Editor
The Create Theme Based on menu button can be read by screen readers.
The Delete This Theme window retains focus until either Delete or Cancel are selected.
API
xAPI with LTI Tools
Links within the xAPI with LTI tools documentation direct to their intended location.
Explanation: When a user accessed a link within the xAPI with LTI tools documentation, the links generated an error. Canvas code has been updated to correct the links within the page.
Canvas open source contributions: Update xAPI links
Authentication
Authentication Refresh Tokens
Newly generated refresh tokens return the correct access_token value.
Explanation: When a refresh token was generated multiple times within five seconds, a null access_token value was returned on subsequent calls after the first. Canvas code has been updated to return access_token values correctly.
Browsers
Firefox ESR Minimum Requirement Banner
The browser minimum requirement banner only displays for Firefox ESR browsers older than version 60.
Explanation: When a user accessed Canvas in a browser older than version 64 in Firefox, the browser displayed a banner noting that the browser did not meet the minimum requirements for Canvas. This behavior occurred intentionally to more closely aligned browser alerts with supported versions. To avoid alerting users of Firefox ESR, which is not officially supported but is used by some customers, Canvas code has been updated to only alert versions before Firefox 60. This change does not affect the supported versions in Canvas but removes the banner to improve the user experience. The banner will continue to alert users of Chrome versions older than 66, as Chrome does not have a specific ESR version designation.
Commons
Copyright Resource Additional Info Tooltip
In the Resource Details page, the license info for a copyrighted resource displays additional info in a tooltip.
Explanation: When a user hovered over the license info in the Resource Details page for a copyrighted resource, the additional info did not display. Canvas code has been updated to display tooltips for copyrighted resources.
Course Import
Copy a Canvas Course Option and Future Restricted Courses
The Copy a Canvas Course option uses active term dates to display available courses in the drop-down list.
Explanation: When a course was copied using the Course Import Tool, future courses that instructors did not have access to displayed in the drop-down list. Attempting to import content from a future course caused the import to fail. Canvas code has been updated to use active term dates to display available courses and disregard future courses. This behavior does not affect courses whose term dates have ended or future courses where instructors have access before the start date.
Rubrics
Edge Page Jumps
In the Edge browser, scrolling down a page with a rubric open retains the location of the page scroll.
Explanation: When a user was viewing a rubric and scrolled down the page using the Edge browser, the page jumped back to the top every five seconds. This behavior affected Edge version 42. Canvas code has been updated to retain the location of a page scroll when viewing a rubric.
SIS Import
Timestamp Update
Abort SIS Import updates the updated_at column.
Explanation: When an SIS import was aborted, the timestamp was not updated and did not show the time of import. Canvas code has been updated to update the updated_at timestamp.
Date | ||
---|---|---|
2019-05-07 | Removed—Fixed Bugs
| |
2019-04-25 | Added—Fixed Bugs
| Changed—Fixed Bugs
|
2019-04-10 | Added—Fixed Bugs
| |
2019-04-08 | Release Notes Published |
Canvas deploys contain code changes that are intended to fix bugs, improve performance, and prepare for new features. These deploys take place every two weeks and can be tested in the beta environment before the production deploy date indicated in the title of this document.
Deploy notes indicate notable changes in the deploy by feature. To view functionality according to user role, please see Canvas Features by User Role.
Fixed bugs are located in Known Issues. For related issues resolved in this deploy, view the 2023-09-13 Known Issues tag.
|
- Interface Updates
- Outcomes
- Question Bank Alignment Calculation Update
- LTI Updates
- Live Events
- Update to InstUI 8
- Feature Options
- Gradebook
- Hide Totals Checkbox Text Update
- Quizzes
- Choose a Quiz Engine Pop-up Text Update
Interface Updates |
Outcomes
Question Bank Alignment Calculation Update
User Role & Summary Link |
Instructors | Canvas Features by User Role |
Affected Feature Areas |
Outcomes |
Account Setting to Enable |
None |
Permissions |
Inherent to user |
Related Ideas |
None |
Summary
The Average Alignment per Calculation is updated to count question bank alignments as a single alignment regardless of the number of questions. Also, question banks and rubrics are not calculated in the assessable artifact calculations as they must be added to artifacts in order to assess. The artifact card text is updated to display Assessable Artifacts, and the Artifact card tooltip description is updated.
Change Benefit
This update improves the clarity of alignments per outcome.
Feature Workflow
In Outcomes, Question Banks are calculated as a single alignment [1]. Additionally, the artifact card text [2] and tooltip description are updated [3].
Additional Details
Previously, the question bank alignments calculated each individual question linked to a question bank.
Note: Question banks and rubrics are not included as assessable artifacts as they must be added to artifacts and are not assessable on their own.
LTI Updates |
Live Events
Update to InstUI 8
Affected LTI Tools |
Live Events |
User Role & Summary Link |
Admins, Instructors | Canvas Features by User Role |
Affects User Interface |
No |
Affected Feature Areas |
Live Events |
Related Ideas |
None |
Summary
The Live Events LTI application coding is updated to InstUI TextInput which improves accessibility for Screen Reader and Keyboard-only users.
Change Benefit
This update utilizes InstUI, Instructure’s internal design language, to provide improved accessibility and quality experiences.
Feature Options |
Gradebook
Hide Totals Checkbox Text Update
Feature Option Name |
Final Grade Override |
Enable Feature Option Location & Default Status |
Account (Disabled/Unlocked) |
Beta Environment Availability |
2023-08-31 |
Production Environment Availability |
2023-09-13 |
Subaccount Configuration |
Yes |
Permissions |
Grades-edit |
Affects User Interface |
Yes |
Affected User Roles and Areas |
Admin, Instructors, Gradebook Settings |
Mobile App Support |
Not available |
Free-for-Teacher Availability |
Yes |
Feature Option State |
Production-ready |
Related Ideas |
None |
Summary
In Gradebook Settings, when the Final Grade Override feature option is disabled, the View Options checkbox text only displays Hide Total Column. When the Final Grade Override feature option is enabled, the View Options checkbox text continues to display Hide Total Column and Override Columns.
Change Benefit
This update streamlines and clarifies the language related to the Final Grade Override feature option.
Feature Workflow
When the Final Grade Override feature option is disabled, the text displays as Hide Total Column.
When the Final Grade Override feature option is enabled, the text displays as Hide Total Column and Override Columns.
Quizzes
Choose a Quiz Engine Pop-up Text Update
Feature Option Name |
New Quizzes |
Enable Feature Option Location & Default Status |
Account (Disabled/Unlocked), or contact Customer Success Manager( learn how to enable feature options) |
Beta Environment Availability |
2023-08-03 |
Production Environment Availability |
2023-09-13 |
Subaccount Configuration |
Yes |
Permissions |
Inherent to user role |
Affects User Interface |
Yes |
Affected User Roles and Areas |
Admin, Instructors, Quizzes |
Mobile App Support |
Not available |
Free-for-Teacher Availability |
Not available |
Feature Option State |
Production-ready |
Related Ideas |
None |
Summary
When New Quizzes is enabled, the Classic Quiz description text is updated in the Choose a Quiz Engine modal. Additionally, the New Quizzes option is listed first.
Change Benefit
This update clarifies the use for Classic Quizzes and encourages users to choose New Quizzes as their quiz engine.
Feature Workflow
When creating a quiz, the Choose a Quiz Engine modal is updated.
Date | |
---|---|
2023-09-01 | Published Deploy Notes |
- Tags:
- 2023-09-13