ima-ui-atoms
v1.3.0
Published
IMA.js UI React atoms
Downloads
83
Readme
ima-ui-atoms
The IMA UI atoms are elementary UI components based on the Pattern Lab design pattern for creating atomic design systems.
This package provides various most commonly needed atoms, but both their functionality and their number are likely to be extended in the future.
The Image, Iframe and Video atoms provide the lazy loading functionality by default. All the atoms provided by this package are AMP HTML-compatible.
Installation
npm install ima-ui-atoms --save
// /app/build.js
var vendors = {
common: [
'ima-ui-atoms',
'infinite-circle'
]
};
var less = [
'./node_modules/ima-ui-atoms/dist/*.less',
];
/*
The atom components are now available within the namespace:
ns.ima.ui.atom.headline.Headline1;
ns.ima.ui.atom.paragraph.Paragraph;
...
import { Headline1, Paragraph, Link, Image, Iframe, Video, ListItem, UnorderedList, Loader } from 'ima-ui-atoms';
*/
// /app/config/bind.js
import { UIComponentHelper } from 'ima-ui-atoms';
// add helper to utils
oc.constant('$Utils', {
.
.
.
$UIComponentHelper: oc.get(UIComponentHelper)
});
oc.bind('GoogleAnalytic', GoogleAnalytic);
Contributing
Contributing to this repository is done via Pull-Requests. Any commit that you make must follow simple rules that are automatically validated upon committing.
- type of change (
build
,ci
,chore
,docs
,feat
,fix
,perf
,refactor
,revert
,style
,test
) - scope of change in brackets
( ... )
. This should be one-word description of what part of the repository you've changed. - colon
:
- message (lower-case)
fix(iframe): message
feat(loader): message
To simplify this process you can use npm run commit
command that will interactively prompt for details and will also run linter before you commit. For more information see commitizen/cz-cli repository.
IMA.js
The IMA.js is an application development stack for developing isomorphic applications written in pure JavaScript. You can find the IMA.js skeleton application at https://github.com/seznam/IMA.js-skeleton.