@blockly/field-multilineinput/README.md

A Blockly multilineinput field.

# @blockly/field-multilineinput [![Built on Blockly](https://tinyurl.com/built-on-blockly)](https://github.com/google/blockly)

A [Blockly](https://www.npmjs.com/package/blockly) multiline input field and
associated block.

#### Multiline input field

![A block with the label "multiline text input:" and a multiline input field
with the text "default text \n with newline character.](readme-media/on_block.png)

#### Multiline input field with editor open

![The same block with editor open.](readme-media/with_editor.png)

#### Multiline input on collapsed block

![The same block after being collapsed. It has the label "multiline text input:
defau..." and a jagged right edge to show it is collapsed.](readme-media/collapsed.png)

## Installation

### Yarn

```
yarn add @blockly/field-multilineinput
```

### npm

```
npm install @blockly/field-multilineinput --save
```

## Usage

This plugin adds a field of type `FieldMultilineInput` that is registered with
the name `'field_multilinetext'`. It is a subclass of `Blockly.FieldInput`.

This field stores a string as its value and a string as its text. Its value is
always a valid string, while its text could be any string entered into its
editor. Unlike a text input field, this field also supports newline characters
entered in the editor.

The constructor for this field accepts three optional parameters:

- `value`: The default text. Defaults to `""`.
- `validator`: A function that is called to validate what the user entered.
- `config`: An object with three optional properties:
  - `maxLines`: The maximum number of lines displayed before scrolling
    functionality is enabled. Defaults to `Infinity`.
  - `spellcheck`: Whether spell checking is enabled. Defaults to `true`.
  - `tooltip`: A tooltip.

If you want to use only the field, you must register it with Blockly. You can
do this by calling `registerFieldMultilineInput` before instantiating your
blocks. If another field is registered under the same name, this field will
overwrite it.

### JavaScript

```js
import * as Blockly from 'blockly';
import {registerFieldMultilineInput} from '@blockly/field-multilineinput';

registerFieldMultilineInput();
Blockly.Blocks['test_field_multilineinput'] = {
  init: function () {
    this.appendDummyInput()
      .appendField('multilineinput: ')
      .appendField(
        new FieldMultilineInput('some text \n with newlines'),
        'FIELDNAME',
      );
  },
};
```

### JSON

```js
import * as Blockly from 'blockly';
import {registerFieldMultilineInput} from '@blockly/field-multilineinput';

registerFieldMultilineInput();
Blockly.defineBlocksWithJsonArray([
    {
        "type": "test_field_multilinetext",
        "message0": "multilineinput: %1",
        "args0": [
            {
                "type": "field_multilinetext",
                "name": "FIELDNAME",
                "text": "some text \n with newlines"
            }
    }]);
```

### Customization

#### Spellcheck

The `setSpellcheck` function can be used to set whether the field spellchecks
its input text or not. Spellchecking is on by default.

![An animation showing multiline text input fields with and without
spellcheck.](readme-media/spellcheck.gif)

This applies to individual fields. If you want to modify all fields change the
`Blockly.FieldMultilineInput.prototype.spellcheck_` property.

#### Validation

A multiline text input field's value is a string, so any validators must accept
a string and return a string, `null`, or `undefined`.

Here is an example of a validator that removes all 'a' characters from the
string:

```
function(newValue) {
  return newValue.replace(/a/gm, '');
}
```

![An animation showing validation.](readme-media/validator.gif)

### Serialization

#### JSON

The JSON for a multiline text input field looks like so:

```json
{
  "fields": {
    "FIELDNAME": "line1\nline2"
  }
}
```

where `FIELDNAME` is a string referencing a multiline text input field, and the
value is the value to apply to the field. The value follows the same rules as
the constructor value.

#### XML

The XML for a multiline text input field looks like so:

```xml
<field name="FIELDNAME">line1&amp;#10;line2</field>
```

where the field's `name` attribute contains a string referencing a multiline
text input field, and the inner text is the value to apply to the field. The
inner text value follows the same rules as the constructor value.

### Blocks

This package also provides a simple block containing a multiline input
field. It has generators in JavaScript, Python, PHP, Lua, and Dart.

You can install the block by calling `textMultiline.installBlock()`.
This will install the block and all of its dependencies, including the
multiline input field. When calling `installBlock` you can supply one or
more `CodeGenerator` instances (e.g. `javascriptGenerator`), and the install
function will also install the correct generator function for the
corresponding language(s).

```js
import {javascriptGenerator} from 'blockly/javascript';
import {dartGenerator} from 'blockly/dart';
import {phpGenerator} from 'blockly/php';
import {pythonGenerator} from 'blockly/python';
import {luaGenerator} from 'blockly/lua';
import {textMultiline} from '@blockly/field-multilineinput';

// Installs the block, the field, and all of the language generators.
textMultiline.installBlock({
  javascript: javascriptGenerator,
  dart: dartGenerator,
  lua: luaGenerator,
  python: pythonGenerator,
  php: phpGenerator,
});
```

### API reference

- `setMaxLines`: Sets the maximum number of displayed lines before
  scrolling functionality is enabled.
- `getMaxLines`: Returns the maximum number of displayed lines before
  scrolling functionality is enabled.
- `setSpellcheck`: Sets whether spell checking is enabled.
- `getSpellcheck`: Returns whether spell checking is enabled.

## License

Apache 2.0