Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deprecate: edit row separator readme to deprecate it #1920

Merged
merged 2 commits into from
Sep 18, 2023
Merged

deprecate: edit row separator readme to deprecate it #1920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98caaff
chore: edit row separator readme to deprecate it.
johnnesky Sep 9, 2023
78b95b3
Mark deprecated package private to stop publishing
johnnesky Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions plugins/renderer-inline-row-separators/README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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.