Documentation
¶
Overview ¶
Package shape generates blockly custom blocks in its JSON format. Blockly doesnt have its own name for the format -- so Tapestry refers to them as "shape" files. see: https://developers.google.com/blockly/guides/create-custom-blocks/define-blocks
every workspace block that needs a mutation has custom javascript support:
- the "tapestry_generic_mutation" mutation,
- the "tapestry_generic_mixin" mixin, and
- the "tapestry_generic_extension" extension.
they use some "customData" tacked on to blockly's standard JSON def, and rely on a mutation user interface ( mui ) block: one mui block per workspace block.
the custom data generates all of the fields for the workspace block ( except for the block's label ) and it contains information on which fields are optional and repeating to direct the mutation.
the mui block is a relatively normal block named "_<type>_mutator". unlike blockly's mutations: there aren't smaller blocks to drag and drop. instead, the mui contains checkboxes and number fields ( sliders ) to control the mutation.
the fields of the workspace block are classified into a few different types:
optional, non-repeating;
optional, stackable repeats: the mui contains a checkbox; custom data contains whatever field it would have had it been a required field.
optional, non-stacking repeats the mui contains a number; the minimum value is 0 custom data contains whatever input needs to repeat.
required non-stacking repeats: same, except the minimum value is 1.
the mui controls ( the checkboxes and numbers ) and the are embedded in dummy inputs inside the mui. the dummy inputs have the same name as the corresponding inputs in the workspace block.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FromTypeMap ¶
Types ¶
type ShapeWriter ¶
type ShapeWriter struct {
Types TypeMap
}
func NewShapeWriter ¶
func NewShapeWriter(ts TypeMap) *ShapeWriter
func (*ShapeWriter) WriteShape ¶
return any fields which need mutation
Source Files