widget-box.html 14.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
<section>
	<h1 class="blue" data-id="#custom/widget-box"><i class="ace-icon fa fa-desktop grey"></i> Widget Box</h1>

	<div class="hr hr-double hr32"></div>

	<!-- #section:custom/widget-box -->
	<div class="help-content">
		<h3 class="info-title smaller">1. Widget Box</h3>
		<div class="info-section">
		 <ul class="info-list list-unstyled">
			<li>
				<div class="well">
					<i class="ace-icon fa fa-hand-o-right"></i>
					Please note that widget box title should now have <code>.widget-title</code> class.
					<br />
					Also widget color options
					are now applied to the box, not header.
					<br />
					For example <code>.widget-header.header-color-blue</code> becomes
					<code>.widget-box.widget-color-blue</code>
				</div>
			</li>
		 
			<li>
				Widget box consists of <b>header</b> and <b>body</b>.
<pre data-language="html">
 <div class="widget-box">
   <div class="widget-header"></div>
   <div class="widget-body"></div>
 </div>
</pre>
			</li>
 		  </ul>
		</div>
		
		
		
		<h3 class="info-title smaller" data-id="#custom/widget-box.options">2. Widget Box Options</h3>
		<!-- #section:custom/widget-box.options -->
		<div class="info-section">
		 <ul class="info-list list-unstyled">
			<li>
				You can use following classes for a different widget box color:
				<ol>
					<li><code>.widget-color-blue</code></li>
					<li><code>.widget-color-blue2</code></li>
					<li><code>.widget-color-blue3</code></li>
					<li><code>.widget-color-green</code></li>
					<li><code>.widget-color-green2</code></li>
					<li><code>.widget-color-green3</code></li>
					<li><code>.widget-color-red</code></li>
					<li><code>.widget-color-red2</code></li>
					<li><code>.widget-color-red3</code></li>
					<li><code>.widget-color-yellow</code></li>
					<li><code>.widget-color-purple</code></li>
					<li><code>.widget-color-pink</code></li>
					<li><code>.widget-color-dark</code></li>
					<li><code>.widget-color-grey</code></li>
				</ol>
<pre data-language="html">
 <div class="widget-box widget-color-blue">
  ...
 </div>
</pre>

			</li>
			<li>
				<!-- #section:custom/widget-box.options.transparent -->
				Add <code>.transparent</code> for transparent widget box:
<pre data-language="html">
 <div class="widget-box transparent">
  ...
 </div>
</pre>
				<!-- /section:custom/widget-box.options.transparent -->
			</li>
			
			<li>
				Add <code>.light-border</code> for light widget body border:
<pre data-language="html">
 <div class="widget-box widget-color-dark light-border">
  ...
 </div>
</pre>
			</li>
			
			<li>
				<!-- #section:custom/widget-box.options.collapsed -->
				Add <code>.collapsed</code> for widget box to be collapsed by default:
<pre data-language="html">
 <div class="widget-box collapsed">
  ...
 </div>
</pre>
				<!-- /section:custom/widget-box.options.collapsed -->
			</li>
 		  </ul>
		</div>
		<!-- /section:custom/widget-box.options -->

	
		<h3 class="info-title smaller" data-id="custom/widget-box.toolbar">3. Widget Header</h3>
		<!-- #section:custom/widget-box.toolbar -->
		<div class="info-section">
		 <ul class="info-list list-unstyled">
			<li>
				Header consists of title and toolbar(optional action buttons):
<pre data-language="html">
 <div class="widget-header">
   <h4 class="widget-title smaller">title!</h4>
   <div class="widget-toolbar"></div>
 </div>
</pre>
			</li>
			
			<li>
			  <h3 class="hidden" data-id="#custom/widget-box.header.options">Widget Header</h3>
			  <!-- #section:custom/widget-box.header.options -->
			  <ol>
				<li><code>.widget-header-small</code> makes <code>.widget-header</code> smaller</li>
				<li><code>.widget-header-large</code> makes <code>.widget-header</code> larger</li>
				<li><code>.widget-header-flat</code> disables gradient background on <code>.widget-header</code></li>
			  </ol>
<pre data-language="html">
<div class="widget-header widget-header-small widget-header-flat">
</div>
</pre>
				<!-- /section:custom/widget-box.header.options -->
			</li>
			
			<li>
				Widget toolbar consists of buttons with custom icons and elements.
<pre data-language="html">
 <div class="widget-toolbar">
   <a data-action="settings" href="#"><i class="ace-icon fa fa-bars"></i></a>
   <a data-action="reload" href="#"><i class="ace-icon fa fa-refresh"></i></a>
   <a data-action="fullscreen" class="orange2" href="#"><i class="ace-icon fa fa-expand"></i></a>
   <a data-action="collapse" href="#"><i class="ace-icon fa fa-chevron-up"></i></a>
   <a data-action="close" href="#"><i class="ace-icon fa fa-times"></i></a>
 </div>
</pre>
			</li>
			
			<li>
				Current action buttons that trigger an event and perform an action are:
				<ol>
					<li><code>settings</code></li>
					<li><code>reload</code></li>
					<li><code>fullscreen</code></li>
					<li><code>collapse</code></li>
					<li><code>close</code></li>
				</ol>
				Please refer to widget events section for more info.
			</li>
			
			<li>
				For <code>data-action="collapse"</code> button, you can change collapsed/expanded icons by
				specifying icon's <code>data-icon-show</code> & <code>data-icon-hide</code> attributes:
<pre data-language="html">
  <a data-action="collapse" href="#">
    <i class="ace-icon fa fa-minus" data-icon-show="fa-plus" data-icon-hide="fa-minus"></i>
  </a>
</pre>
			Also, if you specify any icon with <code>-up</code> or <code>-down</code> in its name, it will be automatically flipped.
			<div class="space-4"></div>
			
			You can also add <code>.collapsed</code> class to <code>.widget-box</code> to become collapsed by default.
			</li>
			
			<li>
				You can have multiple toolbars in widget header:
<pre data-language="html">
<div class="widget-header">
 <h4 class="widget-title"></h4>

 <div class="widget-toolbar no-border"></div>
 <div class="widget-toolbar"></div>
</div>
</pre>

				<code>.no-border</code> class on a <code>.widget-toolbar</code> hides its border.
			</li>
			

			
			<li>
				To have a dropdown menu inside widget toolbar,
				you should wrap the action button and menu inside a <code>.widget-menu</code> element:
<pre data-language="html">
 <div class="widget-toolbar">

    <a data-action="reload" href="#"><i class="ace-icon fa fa-refresh"></i></a>

    <div class="widget-menu">
      <a data-toggle="dropdown" data-action="settings" href="#"><i class="ace-icon fa fa-bars"></i></a>
      <ul class="dropdown-menu dropdown-menu-right dropdown-light-blue dropdown-caret dropdown-closer">
         <li><a href="#dropdown1" data-toggle="tab">Option#1</a></li>
         <li><a href="#dropdown2" data-toggle="tab">Option#2</a></li>
      </ul>
    </div>

 </div>
</pre>
			</li>			
			
			<li>
				<!-- #section:custom/widget-box.tabbed -->
				To have tabs in widgets, you should put the <code>ul.nav-tabs</code> element inside <code>.widget-toolbar</code>
				and <code>.tab-content</code> should be inside widget body's <code>.widget-main</code>:
<pre data-language="html">
 <div class="widget-header widget-header-small">
   <h5 class="widget-title">Tabbed</h5>
   <div class="widget-toolbar no-border">
      <ul id="myTab" class="nav nav-tabs">
         <li class="active"><a href="#home" data-toggle="tab">Home</a></li>
         <li><a href="#profile" data-toggle="tab">Profile</a></li>
         <li><a href="#info" data-toggle="tab">Info</a></li>
      </ul>
   </div>
 </div>
 
 <div class="widget-body">
   <div class="widget-main">
	<!-- tab content here -->
   </div>
 </div>
 
</pre>
			<!-- /section:custom/widget-box.tabbed -->
			</li>
		</ul>
	  </div>
	  <!-- /section:custom/widget-box.toolbar -->

	  
	  <h3 class="info-title smaller">4. Widget Body</h3>
	  <div class="info-section">
		 <ul class="info-list list-unstyled">
			<li>
				Widget box consists of <b>header</b> and <b>body</b>.
<pre data-language="html">
 <div class="widget-box">
   <div class="widget-header"></div>
   <div class="widget-body"></div>
 </div>
</pre>
			</li>
			
			<li>
				<code>.widget-body</code> consists of <code>.widget-main</code>
				and optional toolboxes <code>.widget-toolbox</code>
<pre data-language="html">
<div class="widget-body">
  <div class="widget-toolbox"> ... </div>

  <div class="widget-main"> ... </div>

  <div class="widget-toolbox padding-8"> ... </div>
</div>
</pre>
			</li>
			
			<li>
				<code>.widget-main</code> and <code>.widget-toolbox</code>
				can have the following padding classes:
				<ul>
					<li><code>.no-padding</code></li>
					<li><code>.padding-2</code></li>
					<li><code>.padding-4</code></li>
					<li>...</li>
					<li><code>.padding-30</code></li>
					<li><code>.padding-32</code></li>
				</ul>
				
				For example when putting a table inside widget box
				you may want to use <code>.no-padding</code>
				
<pre data-language="html">
<div class="widget-body">
  <div class="widget-main no-padding">
  
    <table class="table table-striped table-bordered table-hover">
      <thead class="thin-border-bottom">
      </thead>
	  
      <tbody>
      </tbody>
    </table>
	
  </div>
</div>
</pre>
			</li>
			
			<li>
				<!-- #section:custom/widget-box.toolbox -->
				<code>.widget-toolbox</code> can be before or after <code>.widget-main</code>
<pre data-language="html">
<div class="widget-toolbox">
 <div class="btn-toolbar">
  ...
 </div>
</div>

<div class="widget-main">
 ...
</div>

<div class="widget-toolbox padding-8 clearfix">
   <button class="btn btn-xs btn-danger pull-left">
      <i class="ace-icon fa fa-times"></i>
      I don't accept
   </button>
   <button class="btn btn-xs btn-success pull-right">
      I accept
      <i class="ace-icon fa fa-arrow-right icon-on-right"></i>
   </button>
</div>
</pre>
				<!-- /section:custom/widget-box.toolbox -->
			</li>
			
 		  </ul>
		</div>



		<h3 class="info-title smaller">5. Functions & Events</h3>
		<div class="info-section">
		 <ul class="info-list list-unstyled">
			<li>
				The following functions are available for widgets:
				<ol>
					<li><code>close</code></li>
					<li><code>toggle</code></li>
					<li><code>hide</code></li>
					<li><code>show</code></li>
					<li><code>reload</code></li>
					<li><code>fullscreen</code></li>
				</ol>
				
<pre data-language="html">
 <div class="widget-box" id="my-widget">
  ....
 </div>
</pre>

<pre data-language="javascript">
 $('#my-widget').widget_box('toggle');
 $('#my-widget').widget_box('show');
 $('#my-widget').widget_box('close');
 $('#my-widget').widget_box('reload');
</pre>
			</li>
			
			<li>
				The following events are triggered when using widgets:
				<br />
				<b>Before Events:</b>
				<ol>
					<li><code>show.ace.widget</code> triggered before a widget box is shown</li>
					<li><code>hide.ace.widget</code> triggered before a widget box is hidden</li>
					<li><code>close.ace.widget</code> triggered before a widget box is closed</li>
					<li><code>reload.ace.widget</code> triggered before a widget box is reloaded</li>
					<li><code>fullscreen.ace.widget</code> triggered before a widget box is fullscreen</li>
					<li><code>setting.ace.widget</code> triggered before a widget box is fullscreen</li>
				</ol>
				
				<b>After Events:</b>
				<ol>
					<li><code>shown.ace.widget</code> triggered after a widget box is shown</li>
					<li><code>hidden.ace.widget</code> triggered after a widget box is hidden</li>
					<li><code>closed.ace.widget</code> triggered after a widget box is closed</li>
					<li><code>reloaded.ace.widget</code> triggered after a widget box is reloaded</li>
					<li><code>fullscreened.ace.widget</code> triggered after a widget box is fullscreened</li>
				</ol>
			</li>
			
			<li>
				With "before events" you can cancel an action.
				<br />
			For example when you are waiting for remote content to arrive, you can cancel "close" events:
<pre data-language="javascript">
 $('#my-widget').on('close.ace.widget reload.ace.widget', function(event) {
    if(waitingForContent) {
       event.preventDefault();//action will be cancelled, widget box won't close
    }
 });
</pre>
			</li>
			
			<li>
				With "after events" you can do some action after its finished:
<pre data-language="javascript">
 $('#my-widget').on('shown.ace.widget', function(event) {
    //$(this).doSomething();
 });
</pre>
			</li>
			
			<li>
				<code><span class="blue">reload</span>.ace.widget</code> can be used to load remote content.
				<br />
				When data is ready, you can trigger <code><span class="green">reloaded</span>.ace.widget</code>:
<pre data-language="javascript">
 $('#my-widget').on('reload.ace.widget', function(ev) {
   $.ajax({url: 'remote-data.php'}).done(function(content) {
     //use content
     //when ready ...
     $('#my-widget').trigger('reloaded.ace.widget');
   });
 });
</pre>
			</li>
			
			<li>
				<code>setting.ace.widget</code> event does not have an "after" event.
				<br />
				You can use it to be notified when "settings" button is clicked and show a dialog:
<pre data-language="javascript">
 $('#my-widget').on('setting.ace.widget', function(ev) {
   //launch a modal (settings box) or other appropriate action
 });
</pre>
			</li>
			
 		  </ul>
		</div>
		

		
		
		<h3 class="info-title smaller">7. Widget Drag & Drop</h3>
		<div class="info-section">
		 <ul class="info-list list-unstyled">
			<li>
				Using jQuery UI, you can add drag & drop functionality to widget boxes or any other set of elements:
<pre data-language="html">
<div class="row">

 <div class="col-sm-6 widget-container-col">
   <div class="widget-box">
   ...
   </div>
 </div>

 <div class="col-sm-6 widget-container-col">
   <div class="widget-box">
   ...
   </div>
 </div>

</div>
</pre>

<pre data-language="javascript">
 $('.widget-container-col').sortable({
    connectWith: '.widget-container-col',
    items: '> .widget-box',
    opacity: 0.8,
    revert: true,
    forceHelperSize: true,
    placeholder: 'widget-placeholder',
    forcePlaceholderSize: true,
    tolerance: 'pointer',
    start: function(event, ui){
        //when an element is moved, its parent (.widget-container-col) becomes empty with almost zero height
        //we set a "min-height" for it to be large enough so that later we can easily drop elements back onto it
        ui.item.parent().css({'min-height': ui.item.height()})
    },
    update: function(event, ui) {
        //the previously set "min-height" is not needed anymore
        //now the parent (.widget-container-col) should take the height of its child (.wiget-box)
        ui.item.parent({'min-height':''})
    }
 });
</pre>
			</li>
 		  </ul>
		</div>
	
	</div>
	<!-- /section:custom/widget-box -->
	
</section>