https://github.com/mdn/webextensions-examples
由Mozilla的附件團隊維護。
Webextensions是編寫瀏覽器擴展程序的一種方法:也就是說,安裝在Web瀏覽器中的程序,以修改瀏覽器加載的瀏覽器或網頁的行為。 Webextensions建立在一組跨瀏覽器API上,因此在大多數情況下,為Google Chrome,Opera或Edge編寫的Webexensions也將在Firefox中運行。
“ Webextensions-examples”存儲庫是簡單,完整和可安裝的Webextensions的集合。示例顯示瞭如何使用Webextensions API,您可以將它們用作Webextensions的起點。
有關所有示例的索引,請參見MDN上的“示例擴展”頁面。
這些示例可根據Mozilla公共許可證2.0提供。
要使用存儲庫,請首先克隆它。
每個示例都在一個頂級文件夾中,並包含一個簡短的讀數,以解釋它的作用。要查看示例的工作原理,請按照安裝說明將其安裝在Firefox中。
要在Webextension的內部結構中找到自己的方式,請查看MDN上的Webextension頁面的解剖結構。
要在Firefox中使用這些示例,請使用Firefox的最新版本。但是,大多數示例都可以使用較早的版本。
一些示例依賴於僅在釋放版本的Firefox中可用的API。在這種情況下,該示例會在browser_specific_settings key
的strict_min_version
屬性中聲明所需的最小版本。
一些示例僅在特定域或頁面上起作用。每個示例的讀數文件中提供了任何限制的詳細信息。默認情況下,這些示例均未在私人瀏覽窗口中使用,請參閱私人瀏覽中的擴展程序以獲取詳細信息。
運行一個示例擴展:
about:debugging
頁面。單擊加載臨時附加組件,然後在示例擴展程序的文件夾中選擇manifest.json
文件。這是一個展示如何執行此操作的視頻。web-ext run
。這將啟動Firefox並自動安裝擴展名。該工具提供了一些其他開發功能,例如自動重新加載。 這些示例在Firefox中進行了測試。如果瀏覽器支持所使用的API,它們可能會在其他瀏覽器中工作。請注意,這些示例都使用browser
名稱空間,並承諾可以使用異步功能。這意味著除非您使用Mozilla提供的多填充,否則這些示例在Chrome中無法使用。有關更多信息,請參見Webextension API的概述。
要了解有關開發Webextensions的更多信息,請參閱MDN上的Webextensions文檔,以獲取入門指南,教程和完整的API參考文檔。
如果您遇到問題:
如果您無法解決問題,請提交錯誤。
我們歡迎貢獻,無論是新示例,新功能,錯誤修復還是可本地化字符串的翻譯。有關更多詳細信息,請參閱contruting.md文件。