IRMA css
This is a package that contains all the necessary CSS to make IRMA flows look
pretty and have a standardized look and feel. See
the style guide
for visual examples and code snippets.
This package has been designed and tested to work with the browsers Chrome,
Firefox, Safari, Opera, Edge and IE11.
Embedding in your application
This package only contains CSS. So basically you just include the CSS file(s)
and find the right HTML snippets in the styleguide.
The old fashioned way
There is a normal version and a minified version
of the styles that you can include in your project. The CSS can be linked into
your website the regular way. You have to host the CSS file yourself.
<link rel="stylesheet" href="assets/irma.css" />
The way the cool kids do it
Alternatively, you can install it as an npm package. This can be useful if you
want to use (parts of) the SCSS behind it and override some variables, if you
need to package it in some complicated way and if you want more control over
updates.
$ npm install irma-css
You can then pull from the entire thing or just bits and pieces of it in your
SCSS/SASS files:
# The entire thing:
@import "~irma-css";
# Or just bits and pieces of it:
@import "~irma-css/src/components/irma-form";
Or require the CSS in your javascript if you use a tool like Webpack:
require('@privacybydesign/irma-css/dist/irma.css');
Contributing
Compiling locally
Requires a working git
and npm
on your machine.
$ cd irma-css
$ npm install
$ npm run dev
You should now have the style guide running on
http://localhost:8080.
Any change you make to the stylesheets will trigger a rebuild of the style guide
and will be shown after a browser refresh.
Making PRs
Please only commit your changes to the SCSS files, not any of the generated
files:
$ git add irma-css/src/
$ git commit -m "Update button shadows to reflect new design"
Releasing
After merging one or more PRs, a new version can be released. First, update
package.json
to reflect the new version number. Then:
$ cd irma-css
$ git add package.json
$ npm run clean
$ git add ../docs/styleguide/
$ npm run release
$ git add dist/
$ git commit -m "Releasing version xxx"