mirror of
https://github.com/discourse/discourse.git
synced 2024-12-21 17:33:52 +08:00
1d2b6dbb01
# Context
Add `disableDefaultKeyboardShortcuts` function to the plugin API to allow for disabling [default bindings](e4941278b2/app/assets/javascripts/discourse/app/lib/keyboard-shortcuts.js (L49)).
# Details
This function is used to disable a "default" keyboard shortcut. You can pass an array of shortcut bindings as strings to disable them.
**Please note that this function must be called from a pre-initializer.**
Example:
```js
api.disableDefaultKeyboardShortcuts(['command+f', 'shift+c']);
```
- Added system spec, displaying intended behavior
75 lines
2.2 KiB
Ruby
75 lines
2.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
RSpec.describe "Keyboard shortcuts", type: :system do
|
|
it "can have default keyboard shortcuts disabled by the Plugin API" do
|
|
sign_in Fabricate(:admin)
|
|
|
|
t = Fabricate(:theme, name: "Theme With Tests")
|
|
t.set_field(
|
|
target: :extra_js,
|
|
type: :js,
|
|
name: "discourse/lib/pre-initializers/testing.js",
|
|
value: <<~JS,
|
|
import { withPluginApi } from "discourse/lib/plugin-api";
|
|
export default {
|
|
name: "disable-default-keyboard-shortcuts",
|
|
initialize() {
|
|
withPluginApi("1.6.0", (api) => {
|
|
// disable open shortcut modal
|
|
api.disableDefaultKeyboardShortcuts(["?"])
|
|
})
|
|
},
|
|
};
|
|
JS
|
|
)
|
|
t.save!
|
|
SiteSetting.default_theme_id = t.id
|
|
|
|
visit "/"
|
|
page.send_keys("?")
|
|
expect(page).to have_no_css(".keyboard-shortcuts-modal")
|
|
end
|
|
|
|
describe "<a>" do
|
|
let(:current_user) { topic.user }
|
|
let(:topic_page) { PageObjects::Pages::Topic.new }
|
|
|
|
before { sign_in(current_user) }
|
|
|
|
context "when on a private message page" do
|
|
fab!(:topic) { Fabricate(:private_message_topic) }
|
|
|
|
context "when the message is not archived" do
|
|
it "archives the message" do
|
|
topic_page.visit_topic(topic)
|
|
send_keys("a")
|
|
expect(page).to have_current_path("/u/#{current_user.username}/messages")
|
|
expect(UserArchivedMessage.exists?(topic: topic)).to be true
|
|
end
|
|
end
|
|
|
|
context "when the message is already archived" do
|
|
before { UserArchivedMessage.create!(topic: topic, user: current_user) }
|
|
|
|
it "moves back the message to inbox" do
|
|
topic_page.visit_topic(topic)
|
|
send_keys("a")
|
|
expect(page).to have_current_path("/u/#{current_user.username}/messages")
|
|
expect(UserArchivedMessage.exists?(topic: topic)).to be false
|
|
end
|
|
end
|
|
end
|
|
|
|
context "when on a public topic page" do
|
|
fab!(:topic)
|
|
|
|
it "doesn't archive the topic" do
|
|
topic_page.visit_topic(topic)
|
|
send_keys("a")
|
|
expect(page).to have_current_path("/t/#{topic.slug}/#{topic.id}")
|
|
expect(UserArchivedMessage.exists?(topic: topic)).to be false
|
|
end
|
|
end
|
|
end
|
|
end
|