Skip to content

Commit

Permalink
chore: fixup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BeksOmega committed Apr 10, 2024
1 parent 9dd7da4 commit beea47f
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions plugins/scroll-options/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ parameters for edge scrolling.
import * as Blockly from 'blockly';
import {
ScrollOptions,
ScrollDragger,
ScrollBlockDragger,
ScrollMetricsManager,
} from '@blockly/plugin-scroll-options';

Expand All @@ -49,7 +49,9 @@ const workspace = Blockly.inject('blocklyDiv', {
toolbox: toolboxCategories,
plugins: {
// These are both required.
dragger: ScrollDragger,
// Note that the ScrollBlockDragger drags things besides blocks.
// Block is included in the name for backwards compatibility.
blockDragger: ScrollBlockDragger,
metricsManager: ScrollMetricsManager,
},
move: {
Expand Down Expand Up @@ -125,7 +127,7 @@ The edge scroll options are provided in an object with the following properties
than `slowMouseStartDistance`.

Each of these options is configured with the default value shown, which is
specified in `ScrollDragger.js`. When you call `updateEdgeScrollOptions`,
specified in `ScrollBlockDragger.js`. When you call `updateEdgeScrollOptions`,
only the properties actually included in the `options` parameter will be set.
Any unspecified options will use the previously set value (where the initial
value is from the default options). Therefore, do not pass in any options with
Expand All @@ -143,7 +145,7 @@ updateEdgeScrollOptions({slowMouseSpeed: 2});
Then the final options used will include both `fastMouseSpeed: 5` and
`slowMouseSpeed: 2` with all other options being the default values.

You can call `ScrollDragger.resetOptions()` to restore all default options.
You can call `ScrollBlockDragger.resetOptions()` to restore all default options.

## License

Expand Down

0 comments on commit beea47f

Please sign in to comment.