govuk frontend jinja

Gov.uk前端Jinja Macros

gov.uk前端jinja是gov.uk設計系統的社區工具。設計系統團隊對此不承擔任何責任，也不能支持您使用它。如果您需要幫助，請直接與維護人員聯繫或要請求功能。

該存儲庫提供了一套完整的Jinja宏，並保持最新狀態，並100％符合原始的gov.uk前端Nunjucks Macros。移植是故意手動的，而不是自動化的，以使更新更簡單，而不是維護自動轉換例程。全面的測試套件可確保遵守最新和隨後的gov.uk前端版本。

如果您想構建一個完整的燒瓶應用程序，該應用程序與gov.uk Frontend Jinja和gov.uk frontend wtforms集成在一起，請使用gov.uk前端燒瓶模板存儲庫來生成您的應用程序。

相容性

下表顯示了gov.uk前端jinja的版本，您應該將其用於gov.uk frontend的目標版本：

gov.uk前端jinja版本	目標gov.uk前端版本
3.4.0	5.7.1
3.3.0	5.6.0
3.2.0	5.5.0
3.1.0	5.4.0
3.0.0	5.1.0
2.8.0	4.8.0
2.7.0	4.7.0
2.6.0	4.6.0
2.5.0	4.5.0
2.4.0	4.4.1
2.3.0	4.2.0
2.2.0	4.1.0
2.1.0	4.0.1
2.0.0	4.0.0
1.6.0	3.15.0
1.5.1	3.14.0
1.4.0	3.13.0
1.3.0	3.12.0
1.2.1	3.11.0
1.1.0	3.10.2
1.0.0	3.8.1
0.2.1	3.7.0

上面未顯示的任何其他版本的gov.uk前端可能仍然兼容，但尚未得到專門測試和驗證。

如何使用

運行pip install govuk-frontend-jinja後，請確保您告訴Jinja在哪裡加載模板從使用PackageLoader中加載模板如下：

 from flask import Flask
from jinja2 import ChoiceLoader , PackageLoader , PrefixLoader

app = Flask ( __name__ )

app . jinja_loader = ChoiceLoader (
    [
        PackageLoader ( "app" ),
        PrefixLoader ({ "govuk_frontend_jinja" : PackageLoader ( "govuk_frontend_jinja" )}),
    ]
)

在模板中調用宏

要在項目模板中使用組件，您必須導入並調用組件宏並傳遞相關選項，例如：

{%- from 'govuk_frontend_jinja/components/button/macro.html' import govukButton -%}
{{ govukButton({ 'text': "Save and continue" }) }}

每個組件宏可用的選項可以在原始的gov.uk設計系統組件文檔中找到。由於該項目是一個類似的端口，因此Nunjucks示例及其Jinja等效物之間的唯一區別是必須引用關鍵名稱，例如'text'而不是text 。

運行測試

測試是在GitHub操作管道中運行的，但是如果您想在本地運行它們，則需要安裝Govuk-Frontend-Diff。

在tests/utils/app.py上有一個測試服務器，您需要使用以下命令運行：

(cd tests/utils && python -m flask run --port 3000)

然後，您可以使用govuk-frontend-diff進行測試，如下所示：

./govuk-frontend-diff http://localhost:3000 --govuk-frontend-version=v4.8.0

這些都包裹在./test.sh中以進行簡化的運行（需要Docker）。

版本控制

我們使用SEMVER進行版本控制。有關可用的版本，請參見此存儲庫上的標籤。

如何貢獻

我們歡迎社區的貢獻。如果您想為該項目做出貢獻，請查看行為準則和貢獻指南。

更新方法

在gov.uk前端的新版本之後，如何更新此軟件包：

1. 在govuk-frontend上，比較最後一個兼容標籤和最新標籤，例如https://github.com/alphagov/govuk-frontend/compare/compare/compare/v4.3.1...v4.4.0...v4.4.0
2. 如果package/govuk/components/<component>/template.njk govuk_frontend_jinja/templates/components/<component>/macro.html的模板有任何更改
3. 考慮到Nunjucks和Jinja如何解釋該模板之間的任何特質。例如， None檢查嵌套屬性，檢查數組項長度或邏輯運算符， is not和in 。
4. 如上所述運行測試
5. 通過將預期的HTML輸出與測試工具報告的實際HTML進行比較來解決任何失敗的測試
6. 在上面的兼容性表中添加新的行，以顯示該軟件包的下一個版本將定位的gov.uk Frontend。
7. 一旦所有測試通過，都遵循貢獻指南，以提出拉力請求。
8. 合併拉動請求後，在SEMVER約定後創建新版本和標籤。
9. GitHub操作將在新標籤上運行以構建軟件包並將其發佈到PYPI。通過選中項目頁面，驗證該軟件包是否已使用最新版本標籤更新

貢獻者

• 馬特·肖（Matt Shaw）（主要維護者）
• 安迪·曼特爾（原始作者）

請參閱GitHub上的貢獻者的完整列表

支持

該軟件是無保修的“原樣” 。維護者和開源社區以“最佳努力”為基礎提供支持。

如果您是公務員，則可以註冊英國政府數字休閒工作區，以聯繫上面列出的維護者以及在＃Govuk-Design-System System頻道中使用該項目的人們的社區。

否則，請參閱有關如何提出錯誤報告或功能請求的貢獻指南。