The UI can be adapted to the look and feel of the organisation style.
Loading...
Loading...
Loading...
Loading...
Loading...
All applications providing UI implement the same pattern regarding styling.
In order to make the application read the custom files instead of the default files the configuration parameter overlay_dirs
must be used.
Add parameter "overlay_dirs":
<path_to_custom_directories
>
.
Simple example from a Forms config.
In the custom directory create a folder, "assets
".
in the assets
folder of your overlay_dir
, place the favicon.ico
.
Configure the css_overrides.css
file in the assets/
folder of your overlay_dir
The file is empty by default. To override the css variables used in the applications see all the default values below. Note, if you wish to only override for example the button background color you do not need to include the rest of the variables.
Example: To update the button backgrounds define in your css_overrides.css
:
Example: To change background image
Make sure image is available in the assets
folder (using the overlay method preferably) and define in your css_overrides.css
All text that is displayed can be customized. The default locale file contains standard translations and can be changed and extended by future updates. Use the overlay method to override the default locale file with a custom file. The default file will be merged with the custom file, with the keys in the custom file taking precedence.
Default provided languages are English and Swedish. Language files must be present in <overlay_dir>
/assets/locales/
E.g. assets/locales/en.json
To add more languages add to the array in supportedLanguages
and place file (using overlay method) in locales folder. E.g. add the following to the supportedLanguages
array {code: 'de', name: 'Deutsch'}
and add a file called assets/locales/de.json
To customise translations use localesMergePath
to extend and merge with the provided default files.
Default language file contains the translations keys
The overlay_dir
contains a ui_config_overrides.json
with localesMergePath: "assets/custom_locales/" (See
Overlay)
A file is placed in <overlay_dir>/assets/custom_locales/en.json
containing the following:
The resulting merged language file used in the application will contain the following:
For each language that will be customised, add language files <overlay_dir>/assets/custom_locales/<lang>.json
Fortified ID aims to make applications that are usable for all.
Fortified ID uses the guidelines of WCAG 2.1 to make content more accessible to a wider range of people with disabilities.
WCAG defines four principles that provides the foundation of making a website/application accessible: that it is Perceivable, Operable, Understandable, Robust.
Examples of how Fortified user interfaces are designed according with accessibility/a11y in mind:
1. Perceivable – Information and user interface components must be presented in ways that users can perceive. For example, providing alternative text for images and ensuring clear color contrasts.
2. Operable – The user interface and navigation must be usable by all, regardless of physical or cognitive ability. This includes keyboard navigation support and avoiding content that may trigger seizures or other health issues.
3. Understandable – Content and interface must be understandable for users, which means clear language, predictable navigation, and explanations where necessary.
4. Robust – Content must be robust enough to work with a variety of assistive technologies and future user agents.
This is how overrides of ui_config
should be done in all frontend apps/auth.
Use overlay to provide the custom file and place the file in <overlay_dir>/assets/ui_config_overrides.json.
The data in ui_config_overrides.json will be merged with the default values.
Name | Description | Default value |
---|
All logos are configured as follows:
All logos can be made into links.
For example, BankID has the following default configuration, where it has BankID's logo at the top (with some negative margins because it has so much whitespace in it and we have our own margins otherwise):
If you want or need to have the same overrides file for several apps, you can also configure more advanced for all apps
(password_reset, forms, portal, enrollment), all access
(bidomd selector etc) and all infoendpoint
by scoping as below. You can also make configuration for a specific app/auth/infoendpoint.
If variables are defined in the variables
object, all instances of the variable will be replaced in the output to the browser. Note: since search and replace are used for variables, use caution when naming the variables. Use for example __VARIABLE_NAME__
as naming convention to avoid unexpected bugs.
| An object containing logos for |
|
| Logo objects. All logos are configured in the same way. Properties below are for all logos ( |
| The src of the bottom vendor logo. If |
| The width of the logo. Use css values like "40px" |
|
| The height of the logo. Use css values like "40px" |
|
| Link object. Can be configured as |
|
| If | "" |
| List of supported languages. If a language is specified here it is assumed to be available under the folder |
| Browser tab title |
|
| Path for merging locale files. If omitted or empty string |
|
| Default/fallback language if user has not saved a language in cookies |
|