From 783cb4fd6eda8cd3aa58450c357c9a9a3fed2bfa Mon Sep 17 00:00:00 2001 From: Ariel Faur Date: Sat, 22 Aug 2015 17:21:33 -0300 Subject: [PATCH] fixed documentation --- README.md | 73 +------------------------------------------------------ 1 file changed, 1 insertion(+), 72 deletions(-) diff --git a/README.md b/README.md index 94e066d..5181a87 100644 --- a/README.md +++ b/README.md @@ -1,72 +1 @@ -# ionic-pullup - -A pull-up footer component for Ionic. The pull-up footer is a UI component built on top of Ionic's footer and offers an efficient way to hide/reveal information. -The footer can fully expand to cover the content area of the screen or can be configured to expand to a maximum height. The component will compute the available screen height -providing for header and tabs. - -- Easily customized -- Uses hardware accelerated CSS - great performance! -- Integrates with Ionic's themes -- Exposes interface for expand/collapse events -- Detects device orientation and adjusts height accordingly -- Works on iOS and Android (requires Chromium WebView available in Android 4.4+ or use Crosswalk) - -## Demo - -## Install module - -To get you started you can simply install via bower - -```bower install ionic-pullup``` - -Then include ```ion-pullup.js``` in your HTML - -```` - -```` - -## Add dependencies to your App -```` -angular.module('starter', ['ionic', 'starter.controllers', 'ionic-pullup']) -```` - -## Directives - -### ion-pull-up-footer -Main directive creates the configurable pull-up footer. Theming can be done using Ionic's predefined CSS classes, or custom -inline styles. The pull-up handle will inherit the background color of the main directive by default. - -Directive attributes: -- minimize: creates a footer that can be minimized rather than expanded -- default-height: footer height (defaults to Ionic's footer height) -- max-height: specifies the maximum height to expand (whole content area by default) -- on-expand: callback for expand event -- on-collapse: callback for collapse event -- on-minimize: callback for minimize event - -```` - -... - -```` - -### ion-pull-up-content -Main content area when footer is expanded. Adding a ```scroll``` attribute will add scrollbars if necessary. - -### ion-pull-up-handle -Creates the handle element that can be tapped to expand the footer, or dragged to reveal the footer content. Adding a -```toggle``` attribute will toggle CSS classes when changing states if using Ionicons. - -Directive attributes: -- height: handle height -- width: handle width -- toggle: CSS classes to toggle when switching states; requires child `````` element - -```` - - - -```` - -### ion-pull-up-trigger -This directive adds tapping or dragging gestures to a specific element. \ No newline at end of file +See project [website](http://arielfaur.github.io/ionic-pullup) for documentation and demo \ No newline at end of file