Package Exports

@blockly/plugin-workspace-search

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@blockly/plugin-workspace-search) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@blockly/plugin-workspace-search

A Blockly plugin that adds workspace search support.

Installation

npm install @blockly/plugin-workspace-search --save

Usage

ES6 Imports

import * as Blockly from 'blockly';
import { WorkspaceSearch } from '@blockly/plugin-workspace-search';

const workspace = Blockly.inject('blocklyDiv');
const workspaceSearch = new WorkspaceSearch(workspace);

workspaceSearch.init();

Script Tag

<script src="./node_modules/@blockly/plugin-workspace-search/dist/index.js"></script>

To open workspace search use either command + f or control + f. To close the search bar hit escape or the 'x' in the top right corner.

API

init: Initializes the workspace search bar.
dispose: Disposes of workspace search.
open: Opens the search bar.
close: Closes the search bar.
previous: Selects the previous block.
next: Selects the next block.
setSearchPlaceholder: Sets the placeholder text for the search bar text input.
addActionBtn: Add a button to the action div. This must be called after the init function has been called.
clearBlocks: Clears the selection group and current block.
searchAndHighlight: Searches the workspace for the current search term and highlights matching blocks.

License

Apache 2.0