티스토리 수익 글 보기
feat: add shortcuts #17599
feat: add shortcuts #17599
Conversation
|
Please add instructions also for Linux users, they are the majority of all Django developers as per the Django Survey 2022 |
|
@pauloxnet windows and linux should be the same. Description updated. |
82b0d34 to
80a9c65
Compare
|
Hi @michaelschem 👋 I think it’d be great to have keyboard shortcuts in Django, but for a feature like this I’d personally expect some discussion in a ticket or forum post beforehand. In particular I’d like to hear people’s thoughts on:
|
|
hey, @thibaudcolas, thanks for your feedback! I also agree a discussion about the points you brought up would be great. I was under the impression this would be the correct place for that kind of a thing, but I’ll go ahead and raise the issue on the form and link it here. |
|
@thibaudcolas I added hints to the buttons on hover. I think this would be a good start for discoverability. |
|
@michaelschem no, any use of the |
|
hey, @thibaudcolas I’m happy to make the change to add the keyboard shortcut hints, but can you merge this PR first? It seems pretty low impact as far as risk and a huge time saver for my Django admin users. |
|
@michaelschem please spend some time reading Django’s process for feature requests like this as defined in our docs. I’m not too up to speed with it myself but I believe we expect all proposed features to start with a forum discussion, which hasn’t happened here yet. You’ve started the thread at Django Admin Save Shortcuts, there needs to be some validation / consensus from others now. As far as this being low impact / a time saver – I don’t think it’s acceptable we’d add shortcuts like this without any way for users to learn them. Django doesn’t have a documentation site for the admin, so we’d have to have docs within the admin in some form. And we’d definitely want some review of the actual shortcuts. For example, personally without spending too much time thinking about it I’d have expected the “Save” shortcut to be Cmd/Ctrl + S without modifiers. |
- Implements Ctrl/Cmd+S for save-and-continue editing - Implements Ctrl/Cmd+Shift+S for save-and-exit - Implements Ctrl/Cmd+Alt+S for save-and-add-another - Includes cross-platform compatibility (Mac/Windows/Linux) - Adds visual tooltip hints showing available shortcuts - Provides comprehensive test coverage - Follows progressive enhancement principles - Only loads on form pages for optimal performance Refactored from inline JavaScript in base_site.html to: - Dedicated shortcuts.js module for better maintainability - Proper separation of concerns - Improved code organization following DRY principles - Enhanced error handling and edge case coverage Includes: - Full test suite in test_shortcuts.py - User documentation in docs/ref/contrib/admin/shortcuts.txt - Accessibility considerations and screen reader compatibility - Conflict prevention with browser shortcuts and input fields Fixes keyboard shortcut implementation to follow Django development best practices.
Add Keyboard Shortcuts to Django Admin Interface
Description
This pull request introduces keyboard shortcuts to the Django admin interface, enhancing the user experience by allowing faster navigation and actions using the keyboard. Three main shortcuts have been implemented:
The following table summarizes the keyboard shortcuts for both Windows and Mac users:
Implementation Details
base_site.htmlto listen for specific key combinations and trigger the corresponding actions.inputelements of the admin forms based on theirnameattributes (_continue,_save, and_addanother).Testing
Documentation
This feature aims to streamline the workflow in the Django admin interface, making it more efficient and user-friendly, especially for power users who rely heavily on keyboard navigation.
Discussion
A discussion has been created here