Navigation Menu

Skip to content

fand/mouse-dictionary

 
 

Repository files navigation

Build Status Code Climate codecov

Mouse Dictionary: Super Fast Dictionary

Mouse Dictionary is a super fast dictionary for Chrome and Firefox.

Features:

  • Super fast (react in 1/60 second)
  • Awesome phrases detection
  • Capable of importing your own text data
  • Available on PDF documents!
  • Look up connected words at one
    • camelCase -> "camel", "case"
    • snake_case -> "snake", "case"
    • splitinto -> "split into"
  • Customizable view
  • Available not only on very normal document:
    • YouTube captions
    • input elements
    • textarea
    • ...

Download it.

Use it:

Screenshots

English-Japanese

ss02.gif

Japanese-English

ss03.gif

German

Want to use for the German language? Take a look these great articles!

How to develop

Preparation

Use npm 6+.

npm install

Build

Debug build

For Chrome:

npm run build-chrome

For Firefox:

npm run build-firefox

Release build

For Chrome:

npm run release-chrome

For Firefox:

npm run release-firefox

Watch

If you want to keep building every time after you edit source code, watch would be quite useful.

For Chrome:

npm run watch-chrome

For Firefox:

npm run watch-firefox

Contribution

For the moment, Mouse Dictionary project doesn't have any strict rule about contribution. Feel free to create any issues and pull requests.

Some guides:

  • Editor: the main developer uses VSCode
  • Before you commit: try running npm run test and npm run lint

Cross-extension messaging

Mouse Dictionary supports receiving cross-extension messages. One example of an extension that implements sending message to this extension is Mouse Dictionary iframe support.

Here is a code example for sending a message to Mouse Dictionary. You can make Mouse Dictionary look up words/expressions from other extensions.

const MD_EXTENSION_ID = "dnclbikcihnpjohihfcmmldgkjnebgnj";

chrome.runtime.sendMessage(MD_EXTENSION_ID, {
  type: "text",
  text: "rained cats and dogs"
});

Parameters:

name type value
type string must be "text"
text string text you want to look up

License

Mouse Dictionary is published under the MIT license.

Third-party data

This project includes some third-party data:

Dictionary data

ejdic-hand

Images

bookmark icon, gear icon

Build-in PDF viewer

A build-in PDF viewer based on PDF.js.

Great JavaScript libraries

See package.json

See also

Chrome 拡張の高速な英語辞書ツールをつくりました(a Japanese tutorial)

About

📘A super fast dictionary for Chrome/Firefox

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 55.4%
  • JavaScript 42.6%
  • HTML 1.1%
  • CSS 0.9%