blockly二次开发中文文档——2.入门

入门

本文档面向希望创建将Blockly作为代码编辑器的应用程序的开发人员。这里假设用户已经熟悉Blockly的用法,并且人们对HTML和JavaScript有基本的了解。

总览

Blockly旨在轻松安装程序到您的Web应用程序中。首先由用户拖动块,然后由Blockly生成代码,最后在您的应用程序使用该代码执行某些操作。从您的应用程序的角度来看,Blockly只是一个文本区域,用户可以在其中键入语法上完美的JavaScript,Python,PHP,Lua,Dart或其他语言。

获取源代码

首先,从GitHub下载源代码。如果您知道如何使用Git或Subversion,我们强烈建议您从我们的存储库进行同步,以便您的代码保持最新。

获得代码后,使用浏览器访问 demos/fixed/index.html并验证是否可以拖动块。

在页面中注入Blockly

验证Blockly安装无误后,使用固定大小的div将Blockly注入网页中。详见下一章《固定工作区域》

更高级的网页可能希望允许Blockly调整大小以填充页面。详见下一章《调整工作区域》

组件

前述示例中使用的Blockly.inject行包含“名称-值”对作为第二个参数,这些参数可用于配置。支持一下选项:

名称 类型 描述
collapse 布尔型 允许折叠或展开块。如果工具箱具有类别,则默认为true,否则为false。
comments 布尔型 允许块有注释。如果工具箱具有类别,则默认为true,否则为false。
css 布尔型 如果为false,请不要注入CSS(提供CSS成为文档的责任)。默认为true。
disable 布尔型 允许禁用块。如果工具箱具有类别,则默认为true,否则为false。
grid 对象 配置可以捕捉到块的网格。详见《网格》......
horizontalLayout 布尔型 如果true工具箱是水平的,如果false则工具箱是垂直的。默认为false。
maxBlocks 数值型 可以创建的最大块数。对学生练习很有用。默认为无限。
maxInstances 对象 从块类型映射到可以创建的该类型的最大块数。未声明的类型默认为Infinity。
media 字符串 从页面(或框架)到Blockly媒体目录的路径,默认是“https://blockly-demo.appspot.com/static/media/
move 对象 配置用户如何在工作区中移动的行为。详见《移动》
oneBasedIndex 布尔型 如果true则列表和字符串操作应该从1开始索引,如果false索引从0开始。默认为true。
readOnly 布尔型 如果为true,则阻止用户编辑。隐藏工具箱和垃圾桶。默认为false。
rtl 布尔型 如果为true,则镜像编辑器(对于阿拉伯语或希伯来语语言环境)。请参阅RTL演示。默认为false。
scrollbars 布尔型 设置工作空间是否可滚动。如果工具箱具有类别,则默认为true,否则为false。
sounds 布尔型 如果为false,则不播放声音(例如,单击和删除)。默认为true。
theme Blockly.Theme 如果未提供主题,则默认为经典主题。 详见《主题》
toolbox XML nodes 或 字符串 用户可用的类别和块的树结构。请参阅下面的详细信息。
toolboxPosition 字符串 如果“start”工具箱位于顶部(如果是水平)或左侧(如果是垂直和LTR)或右侧(如果是垂直和RTL)。如果“end”工具箱位于对面。默认为“start”。
trashcan 布尔型 显示或隐藏垃圾桶。如果工具箱具有类别,则默认为true,否则为false。
maxTrashcanContents 数值型 将显示在垃圾箱弹出窗口中的最大已删除项目数。 '0'禁用该功能。默认为'32'。
zoom 对象 配置缩放行为。详见《缩放》...

最重要的选项是工具箱。这是一个XML树,它指定工具箱中可用的块(侧边菜单)、它们的分组方式以及是否有类别。详见《定义toolbox》。

除了Blockly附带的默认块之外,还需要构建自定义块来调用Web应用程序的API。一个例子是迷宫游戏,它有自定义的移动块。详见《创建自定义块》。

代码生成器

Blockly不是一种编程语言,不能“运行”一个Blockly程序。相反,Blockly可以将用户的程序转换为JavaScript,Python,PHP,Dart或其他语言。详见《代码生成器》。

导入和导出块

如果您的应用程序需要保存并存储用户的块并在以后访问时恢复它们,请使用此调用导出到XML:

var xml = Blockly.Xml.workspaceToDom(workspace);
var xml_text = Blockly.Xml.domToText(xml);

这将生成一个包含用户块的XML的最小(但很难看)的字符串。如果希望获得更可读(但更大)的字符串,请改用Blockly.Xml.domToPrettyText。

从XML字符串恢复到块也很简单:

var xml = Blockly.Xml.textToDom(xml_text);
Blockly.Xml.domToWorkspace(xml, workspace);

云存储

Blockly附带可选的云存储功能。它使用户能够保存,加载,共享和发布他们的程序。如果您的项目托管在App Engine上,则可以利用此服务。详见《云存储》。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,064评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,606评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,011评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,550评论 1 269
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,465评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,919评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,428评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,075评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,208评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,185评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,191评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,914评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,482评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,585评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,825评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,194评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,703评论 2 339

推荐阅读更多精彩内容