From 6192d08d45ea411fcf66d15586a024c037d4fad0 Mon Sep 17 00:00:00 2001 From: Stephen von Takach Date: Tue, 22 Apr 2014 23:02:54 +1000 Subject: [PATCH] add information on sizing --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab5c2d3..2d8c742 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,11 @@ NOTE:: The [SCSS](http://sass-lang.com/) stylesheet uses [Compass](http://compas * `` 5. Copy / include the SCSS files into your project * Customise the styles using `_orbicular_config.scss` -6. The circle size is based on the parent elements width. ## Usage -Create your progress element: +### Create your progress element ```html Text / HTML in the circle @@ -35,6 +34,20 @@ Create your progress element: Where `$scope.downloaded` (download progress) and `$scope.size` (total size of download) are the variables used in the example to track the progress of a download. +### Element size + +The circles size is based on the width of the parent element. + +This size is static and is set at the following times: + +1. when the directive is linked +2. on mobile device rotation +3. when the browser window is resized +4. on the $broadcast of `'orb width'` to the elements scope + +Broadcasting or emitting should be used to programmatically resize circles + + ## Upgrading from version 1.x.x There is a single breaking change: (resolving a conflict with bootstrap UI)