From 34dfe96732097fb12d56b299d1a406688769e9db Mon Sep 17 00:00:00 2001 From: John Nesky Date: Mon, 18 Sep 2023 05:54:17 -0700 Subject: [PATCH] deprecate: edit row separator readme to deprecate it (#1920) * chore: edit row separator readme to deprecate it. * Mark deprecated package private to stop publishing --- plugins/renderer-inline-row-separators/README.md | 10 ++++++++++ plugins/renderer-inline-row-separators/package.json | 1 + plugins/serialize-disabled-interactions/README.md | 2 +- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/plugins/renderer-inline-row-separators/README.md b/plugins/renderer-inline-row-separators/README.md index c03a3403b7..1c90b1f2e3 100644 --- a/plugins/renderer-inline-row-separators/README.md +++ b/plugins/renderer-inline-row-separators/README.md @@ -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 diff --git a/plugins/renderer-inline-row-separators/package.json b/plugins/renderer-inline-row-separators/package.json index c5139af0e2..c0dd91bdeb 100644 --- a/plugins/renderer-inline-row-separators/package.json +++ b/plugins/renderer-inline-row-separators/package.json @@ -1,6 +1,7 @@ { "name": "@blockly/renderer-inline-row-separators", "version": "0.4.4", + "private": true, "description": "A plugin to treat dummy inputs like line breaks.", "scripts": { "audit:fix": "blockly-scripts auditFix", diff --git a/plugins/serialize-disabled-interactions/README.md b/plugins/serialize-disabled-interactions/README.md index 495c943c33..0dc4966bf1 100644 --- a/plugins/serialize-disabled-interactions/README.md +++ b/plugins/serialize-disabled-interactions/README.md @@ -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.