-
Notifications
You must be signed in to change notification settings - Fork 617
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Initialized minimap plugin using the blockly-plugin template (#…
…1741) * feat: Initialized the plugin using the blockly-plugin template * updated dependecies * typo * updated package lock * more dependency updates
- Loading branch information
Showing
8 changed files
with
13,412 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# @blockly/workspace-minimap [![Built on Blockly](https://tinyurl.com/built-on-blockly)](https://github.com/google/blockly) | ||
|
||
A [Blockly](https://www.npmjs.com/package/blockly) plugin that adds a minimap to the workspace. A minimap is a miniature version of your blocks that appears on top of your main workspace. This gives you an overview of what your code looks like, and how it is organized. | ||
|
||
## Installation | ||
|
||
### Yarn | ||
``` | ||
yarn add @blockly/workspace-minimap | ||
``` | ||
|
||
### npm | ||
``` | ||
npm install @blockly/workspace-minimap --save | ||
``` | ||
|
||
## Usage | ||
|
||
```js | ||
import * as Blockly from 'blockly'; | ||
import {Minimap} from '@blockly/workspace-minimap'; | ||
|
||
// Inject Blockly. | ||
const workspace = Blockly.inject('blocklyDiv', { | ||
toolbox: toolboxCategories, | ||
}); | ||
|
||
// Initialize plugin. | ||
const minimap = new Minimap(workspace); | ||
minimap.init(); | ||
``` | ||
|
||
## API | ||
|
||
API description coming soon... | ||
|
||
## License | ||
Apache 2.0 |
Oops, something went wrong.