GoogleChrome/chrome-extensions-samples 开源项目指南

GoogleChrome/chrome-extensions-samples 开源项目指南

chrome-extensions-samplesChrome Extensions Samples项目地址:https://gitcode.com/gh_mirrors/ch/chrome-extensions-samples

目录结构及介绍

在 GoogleChrome/chrome-extensions-samples 这个开源仓库中, 目录结构组织合理以支持各种样例代码与资源:

• api-samples/ : 此文件夹包含了专注于单一API包的扩展示例.
• functional-samples/ : 包含涉及多个API包功能齐全的扩展示例.
• *_archive/apps/ : 已废弃的Chrome应用程序平台存档(此部分下文不作进一步说明)
• *_archive/mv2/ : 表现版本2的资源存档.

启动文件介绍

要实验这些样本, 用户首先需要克隆该仓库. 安装与加载扩展的方法包括以下步骤:

克隆仓库

用户需通过命令行工具或者开发者习惯使用的工具将该仓库克隆到本地机器上:

git clone https://github.com/GoogleChrome/chrome-extensions-samples.git
cd chrome-extensions-samples

载入未打包扩展

随后, 使用 Chrome 浏览器提供的 "载入未打包扩展" 功能来测试这些扩展. 这通常可以通过前往 "chrome://extensions/" 页面并启用 "开发者模式", 然后再选择 "载入未打包扩展..." 来完成操作.

配置文件介绍

对于扩展的运行来说, 主配置文件是 manifest.json, 它定义了扩展的行为特性权限及各种元数据等.

例如一个简单的配置文件可能会看起来像这样:

{
    "name": "Sample Extension",
    "version": "1.0",
    "description": "A sample description",
    "manifest_version": 3,
    "background": {
        "service_worker": "background.js"
    },
    "permissions": ["storage"]
}

在这个例子中, 我们可以看到一些常见的键值对比如 name 和 version 定义了扩展的名称与版本号; description 提供了扩展的基本描述; manifest_version 表明了我们正在使用的manifest的版本. 扩展背景脚本被指定了路径 background.js, 并且申请了存储权限.

总之, 在这个仓库里的每一个示例项目都会附带自己的 manifest.json 文件来规定扩展的具体行为.

至此, 您已经了解了 GoogleChrome/chrome-extensions-samples 的基本结构以及如何使用其提供的示例程序进行学习或构建自己的扩展项目. 如果您有任何疑问或建议, 可参阅仓库内的CONTRIBUTING.md文件获取更多信息.

chrome-extensions-samplesChrome Extensions Samples项目地址:https://gitcode.com/gh_mirrors/ch/chrome-extensions-samples