govuk frontend jinja

Gov.uk Frontend Jinja Makros

Gov.uk Frontend Jinja ist ein Community -Tool des Gov.uk -Designsystems. Das Design -Systemteam ist nicht dafür verantwortlich und kann Sie nicht bei der Verwendung unterstützen. Wenden Sie sich direkt an die Betreuer, wenn Sie Hilfe benötigen oder eine Funktion anfordern möchten.

Dieses Repository bietet einen vollständigen Satz von Jinja-Makros, die auf dem neuesten Stand und zu 100% den ursprünglichen GOV.UK-Frontend Nunjucks-Makros entsprechen. Die Portierung ist absichtlich manuell und nicht automatisiert, um Aktualisierungen zu vereinfachen als die Aufrechterhaltung einer automatisierten Conversion -Routine. Eine umfassende Testsuite gewährleistet die Einhaltung der neuesten und jeder nachfolgenden Veröffentlichung von Gov.uk Frontend.

Wenn Sie eine vollständig vorgestellte Flask -App erstellen möchten, die sich in Gov.uk Frontend Jinja und Gov.uk Frontend WTForms integriert, verwenden Sie bitte das Repository Gov.uk Frontend Flask Vorlage, um Ihre App zu generieren.

Kompatibilität

Die folgende Tabelle zeigt die Version von Gov.uk Frontend Jinja, die Sie für Ihre gezielte Version von Gov.uk Frontend verwenden sollten:

Gov.uk Frontend Jinja Version	Target Gov.uk Frontend -Version
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

Alle anderen Versionen von Gov.uk Frontend, die oben nicht gezeigt werden, sind möglicherweise noch kompatibel, wurden jedoch nicht speziell getestet und verifiziert.

Wie man benutzt

Stellen Sie nach der pip install govuk-frontend-jinja sicher, dass Sie Jinja mitteilen, wo die Vorlagen wie folgt die Verwendung der PackageLoader laden sollen:

 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" )}),
    ]
)

Rufen Sie ein Makro in Ihrer Vorlage an

Um eine Komponente in Ihren Projektvorlagen zu verwenden, müssen Sie das Komponenten -Makro importieren und aufrufen und die entsprechenden Optionen übergeben, z. B.:

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

Die Optionen für jedes Komponenten -Makro finden Sie in der ursprünglichen Dokumentation von Gov.uk Design -Systemkomponenten. Da dieses Projekt ein ähnlicher Port ist, besteht der einzige Unterschied zwischen den Nunjucks-Beispielen und ihren Jinja-Äquivalenten darin, die Schlüsselnamen zu zitieren, z. B. 'text' anstelle von text .

Die Tests ausführen

Die Tests werden in einer Pipeline von Github Actions durchgeführt. Wenn Sie jedoch lokal ausführen möchten, müssen Sie Govuk-Frontend-DIFF installieren.

Es gibt einen Testserver bei tests/utils/app.py den Sie mit dem folgenden Befehl ausführen müssen:

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

Sie können die Tests dann mit govuk-frontend-diff wie folgt ausführen:

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

Dies ist alles in ./test.sh für ein vereinfachtes Laufen (erfordert Docker).

Versioning

Wir verwenden Semver für die Versionierung. Die verfügbaren Versionen finden Sie in den Tags in diesem Repository.

Wie man beiträgt

Wir begrüßen den Beitrag aus der Gemeinschaft. Wenn Sie zu diesem Projekt beitragen möchten, überprüfen Sie bitte die Richtlinien für Verhaltens- und Beitragskodex.

Aktualisieren Sie die Methodik

So aktualisieren Sie dieses Paket nach einer neuen Version von Gov.uk Frontend:

1. Vergleichen Sie auf govuk-frontend das letzte kompatible Tag und das neueste Tag, z.
2. Wenn Änderungen an Vorlagen in package/govuk/components/<component>/template.njk vorhanden sind govuk_frontend_jinja/templates/components/<component>/macro.html
3. Berücksichtigen Sie alle Eigenschaften zwischen der Interpretation von Nunjucks und Jinja, die diese Vorlage interpretieren würden. ZB None Überprüfung verschachtelter Attribute, Überprüfung von Array -Elementenlängen oder Logikoperatoren wie is , not und in .
4. Führen Sie die Tests wie oben beschrieben aus
5. Lösen Sie alle fehlgeschlagenen Tests durch Vergleich der erwarteten HTML
6. Fügen Sie der obigen Kompatibilitätstabelle eine neue Zeile hinzu, um anzuzeigen, welche Version von GOV.UK Frontend Die nächste Version dieses Pakets abzielt.
7. Sobald alle Tests bestehen, folgen Sie den Beitragsrichtlinien, um eine Pull -Anfrage zu erhöhen.
8. Nachdem die Pull -Anfrage zusammengeführt wurde, erstellen Sie nach Semver -Konventionen eine neue Version und ein Tag.
9. GitHub -Aktionen werden auf dem neuen Tag ausgeführt, um das Paket zu erstellen und an PYPI zu veröffentlichen. Stellen Sie sicher, dass das Paket mit dem neuesten Versions -Tag aktualisiert wurde, indem Sie die Projektseite überprüfen

Mitwirkende

• Matt Shaw (Primärerbauer)
• Andy Mantell (Originalautor)

Siehe die vollständige Liste der Mitwirkenden auf GitHub

Unterstützung

Diese Software wird ohne Garantie "as-is" bereitgestellt. Die Unterstützung wird von den Wartenden und der Open -Source -Community auf "Best Bemühungen" bereitgestellt.

Wenn Sie ein Beamter sind, können Sie sich bei der britischen Regierung Digital Slack Workspace anmelden, um die oben aufgeführten Wartenden und die Community von Personen zu kontaktieren, die dieses Projekt im #govuk-design-Systemkanal verwenden.

Andernfalls finden Sie in den Beitragsrichtlinien, wie Sie einen Fehlerbericht oder eine Feature -Anfrage erhöhen können.