govuk frontend jinja

Gov.uk Frontend Jinja Macros

Gov.uk Frontend Jinja es una herramienta comunitaria del sistema de diseño Gov.uk. El equipo del sistema de diseño no es responsable de ello y no puede admitirlo con el uso. Póngase en contacto con los mantenedores directamente si necesita ayuda o desea solicitar una función.

Este repositorio proporciona un conjunto completo de macros Jinja que se mantienen actualizadas y 100% compatibles con las macros originales de Nunjucks Gov.uk Frontend. La portada es intencionalmente manual en lugar de automatizar para simplificar las actualizaciones que mantener una rutina de conversión automatizada. Un conjunto de pruebas integral garantiza el cumplimiento de la última versión frontend de Gov.uk posterior.

Si está buscando construir una aplicación Flask completamente destacada que se integre con Gov.uk Frontend Jinja y Gov.uk Frontend WTForms, utilice el repositorio de plantillas Flask de Gov.uk Frontend para generar su aplicación.

Compatibilidad

La siguiente tabla muestra la versión de Gov.uk Frontend Jinja que debe usar para su versión específica de Gov.uk Frontend:

Gov.uk frontend jinja versión	Versión de frontend de Target 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

Cualquier otra versión de Gov.uk Frontend no se muestra arriba aún puede ser compatible, pero no se ha probado y verificado específicamente.

Cómo usar

Después de ejecutar pip install govuk-frontend-jinja , asegúrese de decirle a Jinja dónde cargar las plantillas para usar el PackageLoader de la siguiente manera:

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

Llamar a una macro en tu plantilla

Para usar un componente en las plantillas de su proyecto, debe importar y llamar a la macro de componentes y pasar las opciones relevantes, por ejemplo:

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

Las opciones disponibles para cada macro componente se pueden encontrar en la documentación original de componentes del sistema de diseño Gov.uk. Dado que este proyecto es un puerto similar, la única diferencia entre los ejemplos de Nunjucks y sus equivalentes Jinja es tener que citar los nombres clave, por ejemplo, 'text' en lugar de text .

Ejecutando las pruebas

Las pruebas se ejecutan en una tubería de acciones GitHub, pero si desea ejecutarlas localmente, deberá instalar Govuk-Frontend-Diff.

Hay un servidor de prueba en tests/utils/app.py que deberá ejecutar utilizando el siguiente comando:

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

Luego puede ejecutar las pruebas usando govuk-frontend-diff de la siguiente manera:

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

Todo esto está envuelto en ./test.sh para la ejecución simplificada (requiere Docker).

Versiones

Usamos Semver para versiones. Para las versiones disponibles, consulte las etiquetas en este repositorio.

Cómo contribuir

Agradecemos la contribución de la comunidad. Si desea contribuir a este proyecto, revise el código de conducta y las pautas de contribución.

Metodología de actualización

Cómo actualizar este paquete después de una nueva versión de Gov.uk Frontend:

1. En govuk-frontend , compare la última etiqueta compatible y la última etiqueta, por ejemplo, https://github.com/alphagov/govuk-frontend/compare/v4.3.1...v4.4.0
2. Si hay algún cambio en las plantillas en package/govuk/components/<component>/template.njk lea la diferencia y aplique los mismos cambios a las plantillas equivalentes de Jinja en govuk_frontend_jinja/templates/components/<component>/macro.html
3. Tenga en cuenta cualquier idiosincrasia entre cómo Nunjucks y Jinja interpretarían esa plantilla. Por ejemplo, None verificando los atributos anidados, verificando a los artículos de la matriz longitudes o operadores lógicos como is , not e in .
4. Ejecute las pruebas como se describe anteriormente
5. Resuelva las pruebas de falla comparando la salida HTML esperada con el HTML real informado por la herramienta de prueba
6. Agregue una nueva fila a la tabla de compatibilidad anterior para mostrar qué versión de Gov.uk Frontend se dirigirá la próxima versión de este paquete.
7. Una vez que todas las pruebas pasan, siga las pautas de contribución para plantear una solicitud de extracción.
8. Después de que se haya fusionado la solicitud de extracción, cree una nueva versión y etiqueta después de las convenciones de Semver.
9. Las acciones de GitHub se ejecutarán en la nueva etiqueta para construir el paquete y publicarlo en PYPI. Verifique que el paquete se haya actualizado con la última etiqueta de lanzamiento verificando la página del proyecto

Colaboradores

• Matt Shaw (mantenedor primario)
• Andy Mantell (autor original)

Vea la lista completa de contribuyentes en Github

Apoyo

Este software se proporciona "as-es" sin garantía. Los mantenedores y la comunidad de código abierto brindan el soporte en función de los "mejores esfuerzos" .

Si usted es un funcionario, puede inscribirse en el espacio de trabajo digital del gobierno del Reino Unido para contactar a los mantenedores enumerados anteriormente y la comunidad de personas que usan este proyecto en el canal #Govuk-Design-System.

De lo contrario, consulte las pautas de contribución sobre cómo plantear un informe de error o una solicitud de función.