gov-uk-gds-ui
Reactive icon

GOV UK GDS UI

Stable version 1.3.1 (Compatible with OutSystems 11)
Uploaded
 on 27 November 2023
 by 
Version 1
0.0
 (0 ratings)
gov-uk-gds-ui

GOV UK GDS UI

Documentation
1.3.1

This component includes 3 different modules:

  • GOVUKGDS_UI
    • Module with GOV.UK frontend theme and a local theme which includes some override classes and additional root variables. This module also includes different layouts blocks and components which integrate with the GOV.UK Design System Library
  • GOVUKGDS_Patterns
    • Module which is an integration with some of the GOV.UK Patterns, e.g., Addresses, Bank details, Email addresses, Telephone numbers, etc.
  • Template_GOVUKGDS
    • Template module to be used to accelerate the integration with the GOV.UK layouts, navigation and login screen 

Below are described some of the more useful components and how to use them.

Headers

  • Header: If your screen/screens need to have a "Header" without navigationyou just need to use this component
    • HasAppWithContainerClass:
      • Indicates if it's to add the "app-width-container" class which adds some additional right and left margins to your header 
    • HasAppHeaderClass:
      • Indicates if it's to add the "app-header" class which includes a full blue bottom border to the screen header
  • HeaderWithNavigation: If your screen/screens need to have a "Header" with navigationyou just need to use this component

 


Footers

  • Footer: GOV.UK default non-customizable footer  
    • IsToAddAppWithClassCSS:
      • Indicates if it's to add the "app-width-container" class which adds some additional right and left margins to your header
  • Footer with links: Footer which provides a placeholder to add footer links
  • Footer with secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service
  • Footer with links and secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service


Menus

  • Navigation menu: Main content navigation that is placed after the header (the sub menu items only will appear in the mobile devices). On the desktop, please use the left-side navigation approach (see bullets below.
  • Left side navigation menu (without nested): Component to be used when your screen includes a "LayoutSideMenu" which none of the menus has nested "links"
  • Left side navigation menu (with nested): Component to be used when your screen includes a "LayoutSideMenu" in which at least one of the menus has nested "links"


Inputs:

  • Text input: Use the text input component when you need to let users enter text that's no longer than a single line, such as their name or phone number.
    • InputAttributes: Parameter that holds DOM attributes to set in the input widget
    • OutSystemsAttributes: Parameter that holds OutSystems attributes to set in the input widget
    • IsHeading: Parameter if set as true, the question will be also the heading for the page
    • ValidationMessages: Validation error messages, based on standard constraint validation 
    • Examples:
      • Default: 
      • With hint:
      • With prefix and/or suffix:


To help you on this journey, we provide a Demo application GOV UK GDS with examples for each component and pattern. This demo application is divided by:

  • GOVUK_GDS_Th: Module to represent the theme of your application based on GOV.UK theme
  • GOVUK_GDS: Module with the demo screens providing a similar approach as the GOV.UK Design System site
  • GOVUK_GDS_Examples: Module with examples of each component and pattern that are presented to you within iframes. You can use this module to verify how to use each component.

1.3.0

This component includes 3 different modules:

  • GOVUKGDS_UI
    • Module with GOV.UK frontend theme and a local theme which includes some override classes and additional root variables. This module also includes different layouts blocks and components which integrate with the GOV.UK Design System Library
  • GOVUKGDS_Patterns
    • Module which is an integration with some of the GOV.UK Patterns, e.g., Addresses, Bank details, Email addresses, Telephone numbers, etc.
  • Template_GOVUKGDS
    • Template module to be used to accelerate the integration with the GOV.UK layouts, navigation and login screen

Below are described some of the more useful components and how to use them.

Headers

  • Header: If your screen/screens need to have a "Header" without navigationyou just need to use this component
    • HasAppWithContainerClass:
      • Indicates if it's to add the "app-width-container" class which adds some additional right and left margins to your header
    • HasAppHeaderClass:
      • Indicates if it's to add the "app-header" class which includes a full blue bottom border to the screen header
  • HeaderWithNavigation: If your screen/screens need to have a "Header" with navigationyou just need to use this component

 


Footers

  • Footer: GOV.UK default non-customizable footer  
  • Footer with links: Footer which provides a placeholder to add footer links
  • Footer with secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service
  • Footer with links and secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service


Menus

  • Navigation menu: Main content navigation that is placed after the header (the sub menu items only will appear in the mobile devices). On the desktop, please use the left-side navigation approach (see bullets below.
  • Left side navigation menu (without nested): Component to be used when your screen includes a "LayoutSideMenu" which none of the menus has nested "links"
  • Left side navigation menu (with nested): Component to be used when your screen includes a "LayoutSideMenu" in which at least one of the menus has nested "links"


Inputs:

  • Text input: Use the text input component when you need to let users enter text that's no longer than a single line, such as their name or phone number.
    • InputAttributes: Parameter that holds DOM attributes to set in the input widget
    • OutSystemsAttributes: Parameter that holds OutSystems attributes to set in the input widget
    • IsHeading: Parameter if set as true, the question will be also the heading for the page
    • ValidationMessages: Validation error messages, based on standard constraint validation
    • Examples:
      • Default:
      • With hint:
      • With prefix and/or suffix:


To help you on this journey, we provide a Demo application GOV UK GDS with examples for each component and pattern. This demo application is divided by:

  • GOVUK_GDS_Th: Module to represent the theme of your application based on GOV.UK theme
  • GOVUK_GDS: Module with the demo screens providing a similar approach as the GOV.UK Design System site
  • GOVUK_GDS_Examples: Module with examples of each component and pattern that are presented to you within iframes. You can use this module to verify how to use each component.

1.2.0

This component includes 3 different modules:

  • GOVUKGDS_UI
    • Module with GOV.UK frontend theme and a local theme which includes some override classes and additional root variables. This module also includes different layouts blocks and components which integrate with the GOV.UK Design System Library
  • GOVUKGDS_Patterns
    • Module which is an integration with some of the GOV.UK Patterns, e.g., Addresses, Bank details, Email addresses, Telephone numbers, etc.
  • Template_GOVUKGDS
    • Template module to be used to accelerate the integration with the GOV.UK layouts, navigation and login screen 

Below are described some of the more useful components and how to use them.

Headers

  • Header: If your screen/screens need to have a "Header" without navigationyou just need to use this component
    • HasAppWithContainerClass:
      • Indicates if it's to add the "app-width-container" class which adds some additional right and left margins to your header 
    • HasAppHeaderClass:
      • Indicates if it's to add the "app-header" class which includes a full blue bottom border to the screen header
  • HeaderWithNavigation: If your screen/screens need to have a "Header" with navigationyou just need to use this component

 


Footers

  • Footer: GOV.UK default non-customizable footer  
  • Footer with links: Footer which provides a placeholder to add footer links
  • Footer with secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service
  • Footer with links and secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service


Menus

  • Navigation menu: Main content navigation that is placed after the header (the sub menu items only will appear in the mobile devices). On the desktop, please use the left-side navigation approach (see bullets below.
  • Left side navigation menu (without nested): Component to be used when your screen includes a "LayoutSideMenu" which none of the menus has nested "links"
  • Left side navigation menu (with nested): Component to be used when your screen includes a "LayoutSideMenu" in which at least one of the menus has nested "links"


Inputs:

  • Text input: Use the text input component when you need to let users enter text that's no longer than a single line, such as their name or phone number.
    • InputAttributes: Parameter that holds DOM attributes to set in the input widget
    • OutSystemsAttributes: Parameter that holds OutSystems attributes to set in the input widget
    • IsHeading: Parameter if set as true, the question will be also the heading for the page
    • ValidationMessages: Validation error messages, based on standard constraint validation 
    • Examples:
      • Default: 
      • With hint:
      • With prefix and/or suffix:


To help you on this journey, we provide a Demo application GOV UK GDS with examples for each component and pattern. This demo application is divided by:

  • GOVUK_GDS_Th: Module to represent the theme of your application based on GOV.UK theme
  • GOVUK_GDS: Module with the demo screens providing a similar approach as the GOV.UK Design System site
  • GOVUK_GDS_Examples: Module with examples of each component and pattern that are presented to you within iframes. You can use this module to verify how to use each component.

1.1.1

This component includes 3 different modules:

  • GOVUKGDS_UI
    • Module with GOV.UK frontend theme and a local theme which includes some override classes and additional root variables. This module also includes different layouts blocks and components which integrate with the GOV.UK Design System Library
  • GOVUKGDS_Patterns
    • Module which is an integration with some of the GOV.UK Patterns, e.g., Addresses, Bank details, Email addresses, Telephone numbers, etc.
  • Template_GOVUKGDS
    • Template module to be used to accelerate the integration with the GOV.UK layouts, navigation and login screen

Below are described some of the more useful components and how to use them.

Headers

  • Header: If your screen/screens need to have a "Header" without navigationyou just need to use this component
    • HasAppWithContainerClass:
      • Indicates if it's to add the "app-width-container" class which adds some additional right and left margins to your header
    • HasAppHeaderClass:
      • Indicates if it's to add the "app-header" class which includes a full blue bottom border to the screen header
  • HeaderWithNavigation: If your screen/screens need to have a "Header" with navigationyou just need to use this component

 


Footers

  • Footer: GOV.UK default non-customizable footer  
  • Footer with links: Footer which provides a placeholder to add footer links
  • Footer with secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service
  • Footer with links and secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service


Menus

  • Navigation menu: Main content navigation that is placed after the header
  • Left side navigation menu (without nested): Component to be used when your screen includes a "LayoutSideMenu" which none of the menus has nested "links"
  • Left side navigation menu (with nested): Component to be used when your screen includes a "LayoutSideMenu" in which at least one of the menus has nested "links"


Inputs:

  • Text input: Use the text input component when you need to let users enter text that's no longer than a single line, such as their name or phone number.
    • InputAttributes: Parameter that holds DOM attributes to set in the input widget
    • OutSystemsAttributes: Parameter that holds OutSystems attributes to set in the input widget
    • IsHeading: Parameter if set as true, the question will be also the heading for the page
    • ValidationMessages: Validation error messages, based on standard constraint validation
    • Examples:
      • Default:
      • With hint:
      • With prefix and/or suffix:


To help you on this journey, we provide a Demo application GOV UK GDS with examples for each component and pattern. This demo application is divided by:

  • GOVUKGDS_Theme: Module to represent the theme of your application based on GOV.UK theme
  • GOVUKGDS_Resources: Module with additional resources such as the favicon and the theme fonts
  • GOVUKGDS: Module with the demo screens providing a similar approach as the GOV.UK Design System site
  • GOVUKGDS_Examples: Module with examples of each component and pattern that are presented to you within iframes. You can use this module to verify how to use each component.

1.1.0

This component includes 3 different modules:

  • GOVUKGDS_UI
    • Module with GOV.UK frontend theme and a local theme which includes some override classes and additional root variables. This module also includes different layouts blocks and components which integrate with the GOV.UK Design System Library
  • GOVUKGDS_Patterns
    • Module which is an integration with some of the GOV.UK Patterns, e.g., Addresses, Bank details, Email addresses, Telephone numbers, etc.
  • Template_GOVUKGDS
    • Template module to be used to accelerate the integration with the GOV.UK layouts, navigation and login screen

Below are described some of the more useful components and how to use them.

Headers

  • Header: If your screen/screens need to have a "Header" without navigationyou just need to use this component
    • HasAppWithContainerClass:
      • Indicates if it's to add the "app-width-container" class which adds some additional right and left margins to your header 
    • HasAppHeaderClass:
      • Indicates if it's to add the "app-header" class which includes a full blue bottom border to the screen header
  • HeaderWithNavigation: If your screen/screens need to have a "Header" with navigationyou just need to use this component

 


Footers

  • Footer: GOV.UK default non-customizable footer  
  • Footer with links: Footer which provides a placeholder to add footer links
  • Footer with secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service
  • Footer with links and secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service


Menus

  • Navigation menu: Main content navigation that is placed after the header
  • Left side navigation menu (without nested): Component to be used when your screen includes a "LayoutSideMenu" which none of the menus has nested "links"
  • Left side navigation menu (with nested): Component to be used when your screen includes a "LayoutSideMenu" in which at least one of the menus has nested "links"


Inputs:

  • Text input: Use the text input component when you need to let users enter text that's no longer than a single line, such as their name or phone number.
    • InputAttributes: Parameter that holds DOM attributes to set in the input widget
    • OutSystemsAttributes: Parameter that holds OutSystems attributes to set in the input widget
    • IsHeading: Parameter if set as true, the question will be also the heading for the page
    • ValidationMessages: Validation error messages, based on standard constraint validation 
    • Examples:
      • Default: 
      • With hint:
      • With prefix and/or suffix:


To help you on this journey, we provide a Demo application GOV UK GDS with examples for each component and pattern. This demo application is divided by:

  • GOVUKGDS_Theme: Module to represent the theme of your application based on GOV.UK theme
  • GOVUKGDS_Resources: Module with additional resources such as the favicon and the theme fonts
  • GOVUKGDS: Module with the demo screens providing a similar approach as the GOV.UK Design System site
  • GOVUKGDS_Examples: Module with examples of each component and pattern that are presented to you within iframes. You can use this module to verify how to use each component.

1.0.0

This component includes 3 different modules:

  • GOVUKGDS_UI
    • Module with GOV.UK frontend theme and a local theme which includes some override classes and additional root variables. This module also includes different layouts blocks and components which integrate with the GOV.UK Design System Library
  • GOVUKGDS_Patterns
    • Module which is an integration with some of the GOV.UK Patterns, e.g., Addresses, Bank details, Email addresses, Telephone numbers, etc.
  • Template_GOVUKGDS
    • Template module to be used to accelerate the integration with the GOV.UK layouts, navigation and login screen 

Below are described some of the more useful components and how to use them.

Headers

  • Header: If your screen/screens need to have a "Header" without navigationyou just need to use this component
    • HasAppWithContainerClass:
      • Indicates if it's to add the "app-width-container" class which adds some additional right and left margins to your header 
    • HasAppHeaderClass:
    • Indicates if it's to add the "app-header" class which includes a full blue bottom border to the screen header
  • HeaderWithNavigation: If your screen/screens need to have a "Header" with navigationyou just need to use this component 


Footers

  • Footer: GOV.UK default non-customizable footer  
  • Footer with links: Footer which provides a placeholder to add footer links
  • Footer with secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service
  • Footer with links and secondary navigation: A footer which only should be used if you’re creating a GOV.UK service, and you want users to be able to navigate away from the service


Menus

  • Navigation menu: Main content navigation that is placed after the header
  • Left side navigation menu (without nested): Component to be used when your screen includes a "LayoutSideMenu" which none of the menus has nested "links"
  • Left side navigation menu (with nested): Component to be used when your screen includes a "LayoutSideMenu" in which at least one of the menus has nested "links"


Inputs:

  • Text input: Use the text input component when you need to let users enter text that's no longer than a single line, such as their name or phone number.
    • InputAttributes: Parameter that holds DOM attributes to set in the input widget
    • OutSystemsAttributes: Parameter that holds OutSystems attributes to set in the input widget
    • IsHeading: Parameter if set as true, the question will be also the heading for the page
    • ValidationMessages: Validation error messages parameter, based on standard constraint validation  
    • Examples:
      • Default: 
      • With hint:
      • With prefix and/or suffix:


To help you on this journey, we provide a Demo application GOV UK GDS with examples for each component and pattern. This demo application is divided by:

  • GOVUKGDS_Theme: Module to represent the theme of your application based on GOV.UK theme
  • GOVUKGDS_Resources: Module with additional resources such as the favicon and the theme fonts
  • GOVUKGDS: Module with the demo screens providing a similar approach as the GOV.UK Design System site
  • GOVUKGDS_Examples: Module with examples of each component and pattern that are presented to you within iframes. You can use this module to verify how to use each component.