Project: play-ui (GitHub Link)

play-ui-master
- src
  - main
    - play-26
      - uk
        gov
        hmrc
        play
        config.scala
        views
        html
        helpers
        helpers.scala
        layouts
        layouts.scala
        config
        AssetsConfig.scala
        OptimizelyConfig.scala
        GTMConfig.scala
    - resources
      - messages
      - messages.cy
    - twirl
      - uk
        gov
        hmrc
        play
        views
        helpers
        Dropdown.scala.html
        DateFieldsInline.scala.html
        DateFieldsFreeYear.scala.html
        model.scala
        Address.scala.html
        AttorneyRegime.scala
        ReportAProblemLink.scala.html
        FormWithCSRF.scala.html
        ErrorInline.scala.html
        RenderableMessage.scala
        InputRadioGroup.scala.html
        SingleCheckbox.scala.html
        DateFields.scala.html
        FieldGroup.scala.html
        DateFieldsFreeInlineLegend.scala.html
        ErrorNotifications.scala.html
        TextArea.scala.html
        DateFieldsFreeYearInline.scala.html
        ErrorSummary.scala.html
        DateFieldsFreeInline.scala.html
        Input.scala.html
        formatting
        Strings.scala
        Dates.scala
        Money.scala
        layouts
        OptimizelySnippet.scala.html
        HeaderNav.scala.html
        Article.scala.html
        BetaBanner.scala.html
        LoginStatus.scala.html
        MainContent.scala.html
        ServiceInfo.scala.html
        EuExitLinks.scala.html
        Sidebar.scala.html
        GTMSnippet.scala.html
        MainContentHeader.scala.html
        Head.scala.html
        FooterLinks.scala.html
        AttorneyBanner.scala.html
        Footer.scala.html
    - play-25
      - uk
        gov
        hmrc
        play
        config.scala
        views
        html
        helpers
        helpers.scala
        layouts
        layouts.scala
        config
        AssetsConfig.scala
        OptimizelyConfig.scala
        GTMConfig.scala
    - scala
      - uk
        gov
        hmrc
        play
        validators
        Validators.scala
        mappers
        DateTuple.scala
        StopOnFirstFail.scala
        binders
        NonBlankString.scala
        ContinueUrl.scala
        Origin.scala
        PositiveInteger.scala
        SimpleObjectBinder.scala
        QueryBinders.scala
  - test
    - play-26
      - uk
        gov
        hmrc
        play
        views
        helpers
        CSRFSpec.scala
        MessagesSupport.scala
    - play-25
      - uk
        gov
        hmrc
        play
        views
        helpers
        CSRFSpec.scala
        MessagesSupport.scala
    - scala
      - uk
        gov
        hmrc
        play
        language
        WelshMessagesSpec.scala
        views
        package.scala
        helpers
        MoneyPoundsSpec.scala
        FormWithCSRFSpec.scala
        DateFieldsSpec.scala
        BackwardsCompatibilitySpec.scala
        DropDownSpec.scala
        InputRadioGroupSpec.scala
        RenderableMoneyMessageSpec.scala
        InputSpec.scala
        SingleCheckboxSpec.scala
        formatting
        StringsSpec.scala
        DatesSpec.scala
        layouts
        BetaBannerSpec.scala
        EuExitLinksSpec.scala
        FooterLinksSpec.scala
        BackwardsCompatibilitySpec.scala
        LoginStatusSpec.scala
        test
        TestConfigs.scala
        FooterSpec.scala
        OptimizelySnippetSpecs.scala
        HeadSpec.scala
        ServiceInfoSpec.scala
        GTMSnippetSpec.scala
        validators
        ValidatorsSpec.scala
        test
        NoStartedPlayApp.scala
        mappers
        DateTupleSpec.scala
        binders
        ContinueUrlSpec.scala
        SimpleObjectBinderSpec.scala
        OriginSpec.scala
        NonBlankStringSpec.scala
        PositiveIntegerSpec.scala
- LICENSE
- repository.yaml
- project
  - build.properties
  - PlayCrossCompilation.scala
  - LibDependencies.scala
  - plugins.sbt
- .travis.yml
- README.md
- .scalafmt.conf
- build.sbt
- .gitignore

play-ui

Micro-library containing core for HMRC's Play UI:

Formatters

Dates provides various human-readable date formats
Money formats pounds and pence
Strings changes the case of phrases and hyphenates

Form Mappers & Validators

DateTuple maps year, month, day fields to a LocalDate
StopOnFirstFail applies constraints in order and fails fast
Validators contains multiple small validation functions such as addressTuple, positiveInteger & nonEmptySmallText

Helper Templates

Has many standard snippets for form fields, such as: address, dateFields, dropdown, fieldGroup. Each helper correctly adds labels, error messages and CSS classes.

Layout Templates

Contains templates for components used across frontend applications such as: header, footer, sidebar, betaBanner.

Google Tag Manager

To add support for tracking and analytics for your frontend, please provide the following in your environment-specific configuration (ex: app-config-development):

// <CONTAINER> can be one of: { main, transitional }
// main: This is the main container that contains all the environments in GA
// transitional: This is the transitional container which will eventually be dumped 
gtm.container: <CONTAINER>

Adding to your service

Include the following dependency in your SBT build

resolvers += Resolver.bintrayRepo("hmrc", "releases")

libraryDependencies += "uk.gov.hmrc" %% "play-ui" % "x.x.x"

If you require either head or footer you'll also need to add some config to your application.conf file in order to build the complete urls for assets:

assets {
  version = "x.x.x"
  url = ""
}

How to test changes locally

Publish the library locally with

sbt clean compile publishLocal

This will build and install the library into your local Ivy cache. The final lines of the output will contain the version number.

Then update the configuration of your frontend application to use this version number. This is in different files depending on the application. In business-tax-account, it is in FrontendBuild.scala. In one-time-password-frontend, it is in MicroServiceBuild.scala. The line will look like "uk.gov.hmrc" %% "play-ui" % "4.10"

now restart your frontend application, and you will see your local changes.

n.b. you will need to run the sbt command to publish locally each time you make a change.

License

This code is open source software licensed under the Apache 2.0 License.