Skip to content

Commit

Permalink
feat: Initialized minimap plugin using the blockly-plugin template (#…
Browse files Browse the repository at this point in the history
…1741)

* feat: Initialized the plugin using the blockly-plugin template

* updated dependecies

* typo

* updated package lock

* more dependency updates
  • Loading branch information
cesarades authored Jun 30, 2023
1 parent 3914045 commit 56fc4b4
Show file tree
Hide file tree
Showing 8 changed files with 13,412 additions and 0 deletions.
2 changes: 2 additions & 0 deletions plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ that allows a user to copy and paste blocks between tabs.
that automatically converts shadow blocks to real blocks when the user edits them.
- [``@blockly/workspace-backpack``](workspace-backpack/): A Blockly plugin that
adds Backpack support.
- [``@blockly/workspace-minimap``](workspace-minimap/): A Blockly plugin that
adds a minimap of the workspace to the workspace. (private; in development)

### Serializers

Expand Down
38 changes: 38 additions & 0 deletions plugins/workspace-minimap/README.md
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
Loading

0 comments on commit 56fc4b4

Please sign in to comment.