ngx-vud
Common Visma Unified Design components for Angular.
Demo & documentation
https://ngx-vud.web.app
Compatibility table
@vismaux/ngx-vud | @vismaux/vud | @angular/* |
---|
^13.0.0 | ^1.7.0 | ^16.0.0 |
^12.0.0 | ^1.6.3 | ^16.0.0 |
^11.0.0 | ^1.6.3 | ^15.0.0 |
^10.0.0 | ^1.6.3 | ^14.1.0 |
^9.0.0 | ^1.5.0 | ^14.1.0 |
^8.0.0 | ^1.5.0 | ^14.0.0 |
^7.0.0 | ^1.0.0 | ^14.0.0 |
^5.0.0 | ^1.0.0 | ^13.0.0 |
still looking for outdated nordic-cool version? switch branch
Installation
ng add @vismaux/ngx-vud
Manual installation
-
Install this package together with two peer dependencies:
npm i @vismaux/ngx-vud @vismaux/vud @angular/cdk
If you're using npm@v7 you only have to install @vismaux/ngx-vud
as it will automatically install peer dependencies for you.
-
Import required styles inside your global (e.g. style.scss
) file:
@use '@vismaux/ngx-vud';
-
Setup animations by importing BrowserAnimationsModule
in your app.module.ts
.
Use NoopAnimationsModule
in case you don't want animations.
-
This library's i18n is based on @angular/localize
, so make sure you've installed that. Otherwise, run ng add @angular/localize
. In case you're not familiar with Angular's i18n, read the localization section below.
-
Import the global VismaUnifiedDesignModule
module that contains all components,
or pick specific ones (recommended), e.g. VudDatepickerModule
.
-
(Optional) Setup the icons if you plan to use the <vud-icon />
component or vismaicon-
CSS classes directly.
Icons
The required assets for the icons are not built into the package and requires setting them up separately.
This is mandatory if you plan to use the <vud-icon />
component or vismaicon-
CSS classes directly.
There are two ways to setup this.
@import '@vismaux/vud-icons/dist/css/vud-icons.min.css';
@import 'https://vud-icons.s3.eu-north-1.amazonaws.com/latest/dist/css/vud-icons.min.css';
Browser support
Follows PDAB Compatibility Policy:
the latest major stable version of Firefox, Chrome, Safari and Edge are supported. No support for IE.
Contributing to the library
You are more than welcome to open an issue or create a pull-request.
In the latter case, please make sure the changes follows the same coding principles,
is covered with unit tests and meets the official Visma Unified Design guidelines. 🙏