Skip to content

Commit

Permalink
deprecate: edit row separator readme to deprecate it (#1920)
Browse files Browse the repository at this point in the history
* chore: edit row separator readme to deprecate it.

* Mark deprecated package private to stop publishing
  • Loading branch information
johnnesky authored Sep 18, 2023
1 parent 25be4d6 commit 266bd07
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
10 changes: 10 additions & 0 deletions plugins/renderer-inline-row-separators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

A [Blockly](https://www.npmjs.com/package/blockly) plugin to create a renderer that treats dummy inputs like row separators, allowing block designers to arrange multiple inline value input connectors on separate rows by inserting dummy inputs between them. Example blocks demonstrating the feature are provided, as well as a function to add the feature to your own renderer.

## When to use

### For Blockly versions >= v10.2.0

This plugin is deprecated because its functionality will be made obsolete by a new feature being introduced in [Blockly v10.2.0](https://github.com/google/blockly/releases/tag/blockly-v10.2.0): row separators can now be easily added either by adding newline characters ("\n") in the message field of JSON block definitions, or by adding EndRowInputs to blocks via the JavaScript API. For more information, see the [Block Inputs documentation](https://developers.google.com/blockly/guides/create-custom-blocks/define-blocks#block_inputs).

### For Blockly versions < v10.2.0

It is strongly recommended that instead of using this plugin, you upgrade to a version of Blockly >= v10.2.0. However if that is not possible, you can use the current version of this plugin. Note that this plugin will be removed in the future, so by newly installing it now, you will be introducing a dependency you will be forced to remove in the future if you want to remain up-to-date with core Blockly.

## Installation

### Yarn
Expand Down
1 change: 1 addition & 0 deletions plugins/renderer-inline-row-separators/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "@blockly/renderer-inline-row-separators",
"version": "0.4.3",
"private": true,
"description": "A plugin to treat dummy inputs like line breaks.",
"scripts": {
"audit:fix": "blockly-scripts auditFix",
Expand Down
2 changes: 1 addition & 1 deletion plugins/serialize-disabled-interactions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ v2.0 of this plugin (as v3.0 does not actually serialize these attributes).

Note that this plugin is being removed in the future, so by newly installing it
now, you will be introducing a dependency you will be forced to remove in the
future if they you to remain up-to-date with core Blockly.
future if you want to remain up-to-date with core Blockly.

0 comments on commit 266bd07

Please sign in to comment.