govuk frontend jinja

Macros do frontend gov.uk Jinja

GOV.UK Frontend Jinja é uma ferramenta comunitária do sistema de design Gov.uk. A equipe do sistema de design não é responsável por isso e não pode apoiá -lo no uso. Entre em contato diretamente com os mantenedores se precisar de ajuda ou deseja solicitar um recurso.

Este repositório fornece um conjunto completo de macros Jinja que são mantidas atualizadas e 100% compatíveis com as macros originais do Gov.uk Frontend Nunjucks. Portamento é intencionalmente manual, em vez de automatizado, para tornar as atualizações mais simples do que manter uma rotina de conversão automatizada. Um conjunto abrangente de testes garante a conformidade contra o mais recente e subsequente liberação do front -end Gov.uk.

Se você deseja criar um aplicativo Flask totalmente em destaque que se integra ao Gov.uk Frontend Jinja e Gov.uk Frontend Wtforms, use o repositório de modelo de Frontend Gov.uk para gerar seu aplicativo.

Compatibilidade

A tabela a seguir mostra a versão do Frontend do Gov.uk Jinja que você deve usar para sua versão direcionada do front -end gov.uk:

Versão Jinja do Frontend Gov.uk	Versão do frontend alvo 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

Quaisquer outras versões do frontend gov.uk não mostradas acima ainda podem ser compatíveis, mas não foram especificamente testadas e verificadas.

Como usar

Depois de executar pip install govuk-frontend-jinja , verifique se você diz a Jinja onde carregar os modelos de usar o PackageLoader da seguinte forma:

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

Chamando uma macro em seu modelo

Para usar um componente em seus modelos de projeto, você deve importar e chamar a macro do componente e aprovar as opções relevantes, por exemplo:

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

As opções disponíveis para cada macro do componente podem ser encontradas na documentação do sistema de design do Gov.uk original. Como este projeto é uma porta de tipo, a única diferença entre os exemplos de Nunjucks e seus equivalentes de Jinja é ter que citar nomes-chave, por exemplo, 'text' em vez de text .

Executando os testes

Os testes são executados em um pipeline de ações do GitHub, mas se você quiser executá-los localmente, precisará instalar o GoVuk-Frontend-Diff.

Existe um servidor de teste em tests/utils/app.py que você precisará executar usando o seguinte comando:

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

Você pode executar os testes usando govuk-frontend-diff como segue:

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

Tudo isso está envolvido em ./test.sh para execução simplificada (requer o docker).

Versão

Usamos o Semver para versões. Para as versões disponíveis, consulte as tags neste repositório.

Como contribuir

Congratulamo -nos com a contribuição da comunidade. Se você deseja contribuir com este projeto, revise as diretrizes Código de Conduta e Contribuição.

Atualizar metodologia

Como atualizar este pacote após um novo lançamento do Frontend Gov.uk:

1. Na govuk-frontend , compare a última tag compatível e a última tag, por exemplo, https://github.com/alphagov/govuk-frontend/compare/v4.3.1...v4.4.0
2. Se houver alguma alteração nos modelos no package/govuk/components/<component>/template.njk leia o diff e aplique as mesmas alterações nos modelos equivalentes a Jinja em govuk_frontend_jinja/templates/components/<component>/macro.html
3. Leve em consideração quaisquer idiossincrasias entre como Nunjucks e Jinja interpretariam esse modelo. Por exemplo, None verificando atributos aninhados, verificando os comprimentos dos itens da matriz ou operadores lógicos como is , not e in .
4. Execute os testes como descrito acima
5. Resolva quaisquer testes de falha comparando a saída HTML esperada com o HTML real relatado pela ferramenta de teste
6. Adicione uma nova linha à tabela de compatibilidade acima para mostrar qual versão do Gov.uk Frontend a próxima versão deste pacote estará segmentando.
7. Depois que todos os testes estão passando, siga as diretrizes de contribuição para aumentar uma solicitação de tração.
8. Depois que a solicitação de tração foi mesclada, crie uma nova versão e tag após as convenções de Semver.
9. As ações do GitHub serão executadas na nova tag para construir o pacote e publicá -lo no Pypi. Verifique se o pacote foi atualizado com a última tag de lançamento verificando a página do projeto

Colaboradores

• Matt Shaw (mantenedor primário)
• Andy Mantell (autor original)

Veja a lista completa de colaboradores no GitHub

Apoiar

Este software é fornecido "como está" sem garantia. O suporte é fornecido com base em "melhores empreendimentos" pelos mantenedores e pela comunidade de código aberto.

Se você é um funcionário público, pode se inscrever no espaço de trabalho do Governo do Governo do Reino Unido para entrar em contato com os mantenedores listados acima e a comunidade de pessoas que usam esse projeto no canal #govuk-design-system.

Caso contrário, consulte as diretrizes de contribuição sobre como aumentar um relatório de bug ou solicitação de recurso.