blockly > Input

Input class

Class for an input with optional fields.

Signature:

export declare class Input 

Constructors

Constructor	Modifiers	Description
(constructor)(name, sourceBlock)		Constructs a new instance of the Input class

Properties

Property	Modifiers	Type	Description
align		Align	Alignment of input's fields (left, right or centre).
connection		Connection | null
fieldRow		Field[]
name		string
type	readonly	inputTypes

Methods

Method	Modifiers	Description
appendField(field, opt_name)		Add a field (or label from string), and all prefix and suffix fields, to the end of the input's field row.
dispose()		Sever all links to this input.
getAriaLabelText()		Returns the string from the custom ARIA label provider set, or null if the default label (from the field row) should be used. See setAriaLabelProvider for more context.
getShadowDom()		Returns the XML representation of the connection's shadow block.
getSourceBlock()		Get the source block for this input.
init()		Initialize the fields on this input.
insertFieldAt(index, field, opt_name)		Inserts a field (or label from string), and all prefix and suffix fields, at the location of the input's field row.
isVisible()		Gets whether this input is visible or not.
makeConnection(type)	protected	Constructs a connection based on the type of this input's source block. Properly handles constructing headless connections for headless blocks and rendered connections for rendered blocks.
removeField(name, opt_quiet)		Remove a field from this input.
setAlign(align)		Change the alignment of the connection's field(s).
setAriaLabelProvider(provider)		Sets a custom ARIA label provider for this input, or null if it should be reset to use the default method. Inputs do not compute ARIA contexts directly, so the set provider will be used in select cases when the Input needs to be represented (such as for parts of a block label or for connections). Note that overriding this provider will not recompute any already constructed ARIA labels, and it cannot be assumed that the provider will be called any particular number of times during label recomputation. As such, implementations should make sure to provide a deterministic and idempotent ARIA representation each time the provider is called for a given input. It's also fine to reuse providers across multiple Input implementations.
setCheck(check)		Change a connection's compatibility.
setShadowDom(shadow)		Changes the connection's shadow block.