Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 1.91 KB

README.md

File metadata and controls

53 lines (44 loc) · 1.91 KB
Raw

core-layout-probe

A responsive AngularJS layout component for a simple, yet not completely trivial, Web-app layout that works well on both small (mobile) and larger screens. An important feature is its use of iScroll 5.x, through angular-iscroll-probe, to support fixed-position headers and footers without using the CSS position: fixed formatting instruction which is not well supported on older Android (<= 4.1.2 ?) and iOS (<= 8.x) versions.

Install

Install the core-layout-probe NPM package

# With NPM:
npm install --save core-layout-probe
# With Yarn, which I prefer:
yarn add core-layout-probe

Or, to check out a development version, start by cloning the repository, by

git clone git@github.com:OnLiveResearch/core-layout-probe.git

Then, install the necessary dependencies:

cd core-layout-probe/
yarn install    # Or: npm install

After that, you should have a dist directory with a subdirectory named lib:

dist/
├── lib
│   └── core-layout.js
└── scss
    ├── _core-drawers.scss
    ├── _core-modal.scss
    ├── _core-responsive.scss
    ├── _core.scss
    └── _core-variables.scss

Build

To rebuild the library, run

yarn build         # Or `yarn watch` (to rebuild on every file change).

To build the examples, run

yarn build-examples  # Or, `npm run-script build-examples`.

Demo

You may have a look at an Angular demo app that shows how you can use this core-layout-probe module.

Building the Demo (examples/)

Please note that if you don't plan on changing the demo and testing new stuff, there's no need to compile it yourself; you can just visit the demo app.