ref: master
public/javascripts/vendor/jquery-ui-1.10.4/development-bundle/docs/tabs.html
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 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 |
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI tabs documentation</title> <style> body { font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif" } .gutter { display: none; } </style> </head> <body> <script>{ "title": "Tabs Widget", "excerpt": "A single content area with multiple panels, each associated with a header in a list.", "termSlugs": { "category": [ "widgets" ] } }</script><article id="tabs1" class="entry widget"><h2 class="section-title"> <span>Tabs Widget</span><span class="version-details">version added: 1.0</span> </h2> <div class="entry-wrapper"> <p class="desc"><strong>Description: </strong>A single content area with multiple panels, each associated with a header in a list.</p> <section id="quick-nav"><header><h2>QuickNav<a href="#entry-examples">Examples</a> </h2></header><div class="quick-nav-section"> <h3>Options</h3> <div><a href="#option-active">active</a></div> <div><a href="#option-collapsible">collapsible</a></div> <div><a href="#option-disabled">disabled</a></div> <div><a href="#option-event">event</a></div> <div><a href="#option-heightStyle">heightStyle</a></div> <div><a href="#option-hide">hide</a></div> <div><a href="#option-show">show</a></div> </div> <div class="quick-nav-section"> <h3>Methods</h3> <div><a href="#method-destroy">destroy</a></div> <div><a href="#method-disable">disable</a></div> <div><a href="#method-enable">enable</a></div> <div><a href="#method-load">load</a></div> <div><a href="#method-option">option</a></div> <div><a href="#method-refresh">refresh</a></div> <div><a href="#method-widget">widget</a></div> </div> <div class="quick-nav-section"> <h3>Events</h3> <div><a href="#event-activate">activate</a></div> <div><a href="#event-beforeActivate">beforeActivate</a></div> <div><a href="#event-beforeLoad">beforeLoad</a></div> <div><a href="#event-create">create</a></div> <div><a href="#event-load">load</a></div> </div></section><div class="longdesc" id="entry-longdesc"> <p>Tabs are generally used to break content into multiple sections that can be swapped to save space, much like an accordion.</p> <p>Tabs have a particular set of markup that must be used in order for them to work properly:</p> <ul> <li>The tabs themselves must be in either an ordered (<code><ol></code>) or unordered (<code><ul></code>) list</li> <li>Each tab "title" must be inside of a list item (<code><li></code>) and wrapped by an anchor (<code><a></code>) with an <code>href</code> attribute</li> <li>Each tab panel may be any valid element but it must have an id which corresponds to the hash in the anchor of the associated tab.</li> </ul> <p>The content for each tab panel can be defined in-page or can be loaded via Ajax; both are handled automatically based on the <code>href</code> of the anchor associated with the tab. By default tabs are activated on click, but the events can be changed to hover via the <a href="#option-event"><code>event</code></a> option.</p> <p>Below is some sample markup:</p> <div class="syntaxhighlighter xml nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> <div class="line n6">6</div> <div class="line n7">7</div> <div class="line n8">8</div> <div class="line n9">9</div> <div class="line n10">10</div> <div class="line n11">11</div> <div class="line n12">12</div> <div class="line n13">13</div> <div class="line n14">14</div> <div class="line n15">15</div> <div class="line n16">16</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"tabs"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">ul</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">li</span>></span><span class="tag"><<span class="title">a</span> <span class="attribute">href</span>=<span class="value">"#fragment-1"</span>></span>One<span class="tag"></<span class="title">a</span>></span><span class="tag"></<span class="title">li</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">li</span>></span><span class="tag"><<span class="title">a</span> <span class="attribute">href</span>=<span class="value">"#fragment-2"</span>></span>Two<span class="tag"></<span class="title">a</span>></span><span class="tag"></<span class="title">li</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">li</span>></span><span class="tag"><<span class="title">a</span> <span class="attribute">href</span>=<span class="value">"#fragment-3"</span>></span>Three<span class="tag"></<span class="title">a</span>></span><span class="tag"></<span class="title">li</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">ul</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"fragment-1"</span>></span></code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"fragment-2"</span>></span></code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"fragment-3"</span>></span></code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">div</span>></span></code></div></div></pre> </td> </tr> </tbody> </table> </div> <h3>Keyboard interaction</h3> <p>When focus is on a tab, the following key commands are available:</p> <ul> <li>UP/LEFT: Move focus to the previous tab. If on first tab, moves focus to last tab. Activate focused tab after a short delay.</li> <li>DOWN/RIGHT: Move focus to the next tab. If on last tab, moves focus to first tab. Activate focused tab after a short delay.</li> <li>HOME: Move focus to the first tab. Activate focused tab after a short delay.</li> <li>END: Move focus to the last tab. Activate focused tab after a short delay.</li> <li>SPACE: Activate panel associated with focused tab.</li> <li>ENTER: Activate or toggle panel associated with focused tab.</li> <li>ALT+PAGE UP: Move focus to the previous tab and immediately activate.</li> <li>ALT+PAGE DOWN: Move focus to the next tab and immediately activate.</li> </ul> <p>When focus is in a panel, the following key commands are available:</p> <ul> <li>CTRL+UP: Move focus to associated tab.</li> <li>ALT+PAGE UP: Move focus to the previous tab and immediately activate.</li> <li>ALT+PAGE DOWN: Move focus to the next tab and immediately activate.</li> </ul> <div> <h3 id="theming">Theming</h3> <p>The tabs widget uses the <a href="/theming/css-framework/">jQuery UI CSS framework</a> to style its look and feel. If tabs specific styling is needed, the following CSS class names can be used:</p> </div> <ul> <li> <code>ui-tabs</code>: The outer container of the tabs. This element will additionally have a class of <code>ui-tabs-collapsible</code> when the <a href="#option-collapsible"><code>collapsible</code></a> option is set. <ul> <li> <code>ui-tabs-nav</code>: The list of tabs. <ul> <li>The active list item in the nav will have a <code>ui-tabs-active</code> class. Any list item whose associated content is loading via an Ajax call will have a <code>ui-tabs-loading</code> class. <ul> <li> <code>ui-tabs-anchor</code>: The anchors used to switch panels.</li> </ul> </li> </ul> </li> <li> <code>ui-tabs-panel</code>: The panels associated with the tabs. Only the panel whose corresponding tab is active will be visible.</li> </ul> </li> </ul> <h3>Dependencies</h3> <ul> <li><a href="/category/ui-core/">UI Core</a></li> <li><a href="/jQuery.widget/">Widget Factory</a></li> <li> <a href="/category/effects-core/">Effects Core</a> (optional; for use with the <a href="#option-show"><code>show</code></a> and <a href="#option-hide"><code>hide</code></a> options)</li> </ul> </div> <h3>Additional Notes:</h3> <div class="longdesc"><ul><li> This widget requires some functional CSS, otherwise it won't work. If you build a custom theme, use the widget's specific CSS file as a starting point. </li></ul></div> <section id="options"><header><h2>Options</h2></header><div id="option-active" class="api-item first-item"> <h3>active<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#Integer">Integer</a></span> </h3> <div class="default"> <strong>Default: </strong><code>0</code> </div> <div> Which panel is currently open. </div> <strong>Multiple types supported:</strong><ul> <li> <strong>Boolean</strong>: Setting <code>active</code> to <code>false</code> will collapse all panels. This requires the <a href="#option-collapsible"><code>collapsible</code></a> option to be <code>true</code>.</li> <li> <strong>Integer</strong>: The zero-based index of the panel that is active (open). A negative value selects panels going backward from the last panel.</li> </ul> <strong>Code examples:</strong><p>Initialize the tabs with the <code>active</code> option specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({ active: <span class="number">1</span> });</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Get or set the <code>active</code> option, after initialization:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> active = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"active"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"active"</span>, <span class="number">1</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> <div id="option-collapsible" class="api-item"> <h3>collapsible<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a></span> </h3> <div class="default"> <strong>Default: </strong><code>false</code> </div> <div>When set to <code>true</code>, the active panel can be closed.</div> <strong>Code examples:</strong><p>Initialize the tabs with the <code>collapsible</code> option specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({ collapsible: <span class="literal">true</span> });</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Get or set the <code>collapsible</code> option, after initialization:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> collapsible = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"collapsible"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"collapsible"</span>, <span class="literal">true</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> <div id="option-disabled" class="api-item"> <h3>disabled<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#Array">Array</a></span> </h3> <div class="default"> <strong>Default: </strong><code>false</code> </div> <div>Which tabs are disabled.</div> <strong>Multiple types supported:</strong><ul> <li> <strong>Boolean</strong>: Enable or disable all tabs.</li> <li> <strong>Array</strong>: An array containing the zero-based indexes of the tabs that should be disabled, e.g., <code>[ 0, 2 ]</code> would disable the first and third tab.</li> </ul> <strong>Code examples:</strong><p>Initialize the tabs with the <code>disabled</code> option specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({ disabled: [ <span class="number">0</span>, <span class="number">2</span> ] });</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Get or set the <code>disabled</code> option, after initialization:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> disabled = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"disabled"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"disabled"</span>, [ <span class="number">0</span>, <span class="number">2</span> ] );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> <div id="option-event" class="api-item"> <h3>event<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span> </h3> <div class="default"> <strong>Default: </strong><code>"click"</code> </div> <div>The type of event that the tabs should react to in order to activate the tab. To activate on hover, use <code>"mouseover"</code>.</div> <strong>Code examples:</strong><p>Initialize the tabs with the <code>event</code> option specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({ event: <span class="string">"mouseover"</span> });</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Get or set the <code>event</code> option, after initialization:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> event = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"event"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"event"</span>, <span class="string">"mouseover"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> <div id="option-heightStyle" class="api-item"> <h3>heightStyle<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span> </h3> <div class="default"> <strong>Default: </strong><code>"content"</code> </div> <div> Controls the height of the tabs widget and each panel. Possible values: <ul> <li> <code>"auto"</code>: All panels will be set to the height of the tallest panel.</li> <li> <code>"fill"</code>: Expand to the available height based on the tabs' parent height.</li> <li> <code>"content"</code>: Each panel will be only as tall as its content.</li> </ul> </div> <strong>Code examples:</strong><p>Initialize the tabs with the <code>heightStyle</code> option specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({ heightStyle: <span class="string">"fill"</span> });</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Get or set the <code>heightStyle</code> option, after initialization:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> heightStyle = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"heightStyle"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"heightStyle"</span>, <span class="string">"fill"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> <div id="option-hide" class="api-item"> <h3>hide<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a> or <a href="http://api.jquery.com/Types/#Object">Object</a></span> </h3> <div class="default"> <strong>Default: </strong><code>null</code> </div> <div>If and how to animate the hiding of the panel.</div> <strong>Multiple types supported:</strong><ul> <li> <strong>Boolean</strong>: When set to <code>false</code>, no animation will be used and the panel will be hidden immediately. When set to <code>true</code>, the panel will fade out with the default duration and the default easing. </li> <li> <strong>Number</strong>: The panel will fade out with the specified duration and the default easing. </li> <li> <strong>String</strong>: The panel will be hidden using the specified effect. The value can either be the name of a built-in jQuery animation method, such as <code>"slideUp"</code>, or the name of a <a href="/category/effects/">jQuery UI effect</a>, such as <code>"fold"</code>. In either case the effect will be used with the default duration and the default easing. </li> <li> <strong>Object</strong>: If the value is an object, then <code>effect</code>, <code>delay</code>, <code>duration</code>, and <code>easing</code> properties may be provided. If the <code>effect</code> property contains the name of a jQuery method, then that method will be used; otherwise it is assumed to be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If <code>duration</code> or <code>easing</code> is omitted, then the default values will be used. If <code>effect</code> is omitted, then <code>"fadeOut"</code> will be used. If <code>delay</code> is omitted, then no delay is used.</li> </ul> <strong>Code examples:</strong><p>Initialize the tabs with the <code>hide</code> option specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({ hide: { effect: <span class="string">"explode"</span>, duration: <span class="number">1000</span> } });</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Get or set the <code>hide</code> option, after initialization:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> hide = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"hide"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"hide"</span>, { effect: <span class="string">"explode"</span>, duration: <span class="number">1000</span> } );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> <div id="option-show" class="api-item"> <h3>show<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a> or <a href="http://api.jquery.com/Types/#Object">Object</a></span> </h3> <div class="default"> <strong>Default: </strong><code>null</code> </div> <div>If and how to animate the showing of the panel.</div> <strong>Multiple types supported:</strong><ul> <li> <strong>Boolean</strong>: When set to <code>false</code>, no animation will be used and the panel will be shown immediately. When set to <code>true</code>, the panel will fade in with the default duration and the default easing. </li> <li> <strong>Number</strong>: The panel will fade in with the specified duration and the default easing. </li> <li> <strong>String</strong>: The panel will be shown using the specified effect. The value can either be the name of a built-in jQuery animation method, such as <code>"slideDown"</code>, or the name of a <a href="/category/effects/">jQuery UI effect</a>, such as <code>"fold"</code>. In either case the effect will be used with the default duration and the default easing. </li> <li> <strong>Object</strong>: If the value is an object, then <code>effect</code>, <code>delay</code>, <code>duration</code>, and <code>easing</code> properties may be provided. If the <code>effect</code> property contains the name of a jQuery method, then that method will be used; otherwise it is assumed to be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If <code>duration</code> or <code>easing</code> is omitted, then the default values will be used. If <code>effect</code> is omitted, then <code>"fadeIn"</code> will be used. If <code>delay</code> is omitted, then no delay is used.</li> </ul> <strong>Code examples:</strong><p>Initialize the tabs with the <code>show</code> option specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({ show: { effect: <span class="string">"blind"</span>, duration: <span class="number">800</span> } });</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Get or set the <code>show</code> option, after initialization:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> show = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"show"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"show"</span>, { effect: <span class="string">"blind"</span>, duration: <span class="number">800</span> } );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div></section><section id="methods"><header><h2>Methods</h2></header><div id="method-destroy"><div class="api-item first-item"> <h3>destroy()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div> Removes the tabs functionality completely. This will return the element back to its pre-init state. </div> <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> <div> <strong>Code examples:</strong><p>Invoke the destroy method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"destroy"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div></div> <div id="method-disable"> <div class="api-item"> <h3>disable()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div>Disables all tabs.</div> <ul><li><div class="null-signature">This signature does not accept any arguments.</div></li></ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"disable"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div class="api-item"> <h3>disable( index )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div> Disables a tab. The selected tab cannot be disabled. To disable more than one tab at once, set the <a href="#option-disabled"><code>disabled</code></a> option: <code>$( "#tabs" ).tabs( "option", "disabled", [ 1, 2, 3 ] )</code>. </div> <ul><li> <div><strong>index</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a> </div> <div>Which tab to disable.</div> </li></ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"disable"</span>, <span class="number">1</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> </div> <div id="method-enable"> <div class="api-item"> <h3>enable()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div>Enables all tabs.</div> <ul><li><div class="null-signature">This signature does not accept any arguments.</div></li></ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"enable"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div class="api-item"> <h3>enable( index )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div>Enables a tab. To enable more than one tab at once reset the disabled property like: <code>$( "#example" ).tabs( "option", "disabled", [] );</code>.</div> <ul><li> <div><strong>index</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a> </div> <div>Which tab to enable.</div> </li></ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"enable"</span>, <span class="number">1</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> </div> <div id="method-load"><div class="api-item"> <h3>load( index )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div>Loads the panel content of a remote tab.</div> <ul><li> <div><strong>index</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a> </div> <div>Which tab to load.</div> </li></ul> <div> <strong>Code examples:</strong><p>Invoke the load method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"load"</span>, <span class="number">1</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div></div> <div id="method-option"> <div class="api-item"> <h3>option( optionName )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#Object">Object</a></span> </h3> <div>Gets the value currently associated with the specified <code>optionName</code>.</div> <ul><li> <div><strong>optionName</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#String">String</a> </div> <div>The name of the option to get.</div> </li></ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="keyword">var</span> isDisabled = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"disabled"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div class="api-item"> <h3>option()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#PlainObject">PlainObject</a></span> </h3> <div>Gets an object containing key/value pairs representing the current tabs options hash.</div> <ul><li><div class="null-signature">This signature does not accept any arguments.</div></li></ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="keyword">var</span> options = $( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div class="api-item"> <h3>option( optionName, value )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div>Sets the value of the tabs option associated with the specified <code>optionName</code>.</div> <ul> <li> <div><strong>optionName</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#String">String</a> </div> <div>The name of the option to set.</div> </li> <li> <div><strong>value</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div>A value to set for the option.</div> </li> </ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, <span class="string">"disabled"</span>, <span class="literal">true</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div class="api-item"> <h3>option( options )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div>Sets one or more options for the tabs.</div> <ul><li> <div><strong>options</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div>A map of option-value pairs to set.</div> </li></ul> <div> <strong>Code examples:</strong><p>Invoke the method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"option"</span>, { disabled: <span class="literal">true</span> } );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> </div> <div id="method-refresh"><div class="api-item"> <h3>refresh()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/">plugin only</a>)</span> </h3> <div>Process any tabs that were added or removed directly in the DOM and recompute the height of the tab panels. Results depend on the content and the <a href="#option-heightStyle"><code>heightStyle</code></a> option.</div> <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> <div> <strong>Code examples:</strong><p>Invoke the refresh method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs( <span class="string">"refresh"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div></div> <div id="method-widget"><div class="api-item"> <h3>widget()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a></span> </h3> <div> Returns a <code>jQuery</code> object containing the tabs container. </div> <ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> <div> <strong>Code examples:</strong><p>Invoke the widget method:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="keyword">var</span> widget = $( <span class="string">".selector"</span> ).tabs( <span class="string">"widget"</span> );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div></div></section><section id="events"><header><h2>Events</h2></header><div id="event-activate" class="api-item first-item"> <h3>activate( event, ui )<span class="returns">Type: <code>tabsactivate</code></span> </h3> <div> <p>Triggered after a tab has been activated (after animation completes). If the tabs were previously collapsed, <code>ui.oldTab</code> and <code>ui.oldPanel</code> will be empty jQuery objects. If the tabs are collapsing, <code>ui.newTab</code> and <code>ui.newPanel</code> will be empty jQuery objects.</p> <div class="warning"> <strong>Note:</strong> Since the <code>activate</code> event is only fired on tab activation, it is not fired for the initial tab when the tabs widget is created. If you need a hook for widget creation use the <a href="#event-create"><code>create</code></a> event.</div> </div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div></div> <ul> <li> <div><strong>newTab</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The tab that was just activated.</div> </li> <li> <div><strong>oldTab</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The tab that was just deactivated.</div> </li> <li> <div><strong>newPanel</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The panel that was just activated.</div> </li> <li> <div><strong>oldPanel</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The panel that was just deactivated.</div> </li> </ul> </li> </ul> <div> <strong>Code examples:</strong><p>Initialize the tabs with the activate callback specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({</code></div></div><div class="container"><div class="line"><code> activate: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Bind an event listener to the tabsactivate event:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"tabsactivate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div id="event-beforeActivate" class="api-item"> <h3>beforeActivate( event, ui )<span class="returns">Type: <code>tabsbeforeactivate</code></span> </h3> <div>Triggered immediately before a tab is activated. Can be canceled to prevent the tab from activating. If the tabs are currently collapsed, <code>ui.oldTab</code> and <code>ui.oldPanel</code> will be empty jQuery objects. If the tabs are collapsing, <code>ui.newTab</code> and <code>ui.newPanel</code> will be empty jQuery objects.</div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div></div> <ul> <li> <div><strong>newTab</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The tab that is about to be activated.</div> </li> <li> <div><strong>oldTab</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The tab that is about to be deactivated.</div> </li> <li> <div><strong>newPanel</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The panel that is about to be activated.</div> </li> <li> <div><strong>oldPanel</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The panel that is about to be deactivated.</div> </li> </ul> </li> </ul> <div> <strong>Code examples:</strong><p>Initialize the tabs with the beforeActivate callback specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({</code></div></div><div class="container"><div class="line"><code> beforeActivate: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Bind an event listener to the tabsbeforeactivate event:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"tabsbeforeactivate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div id="event-beforeLoad" class="api-item"> <h3>beforeLoad( event, ui )<span class="returns">Type: <code>tabsbeforeload</code></span> </h3> <div> <p>Triggered when a remote tab is about to be loaded, after the <a href="#event-beforeActivate"><code>beforeActivate</code></a> event. Can be canceled to prevent the tab panel from loading content; though the panel will still be activated. This event is triggered just before the Ajax request is made, so modifications can be made to <code>ui.jqXHR</code> and <code>ui.ajaxSettings</code>.</p> <p><em>Note: Although <code>ui.ajaxSettings</code> is provided and can be modified, some of these settings have already been processed by jQuery. For example, <a href="//api.jquery.com/jQuery.ajaxPrefilter/">prefilters</a> have been applied, <code>data</code> has been processed, and <code>type</code> has been determined. The <code>beforeLoad</code> event occurs at the same time, and therefore has the same restrictions, as the <code>beforeSend</code> callback from <a href="//api.jquery.com/jQuery.ajax/"><code>jQuery.ajax()</code></a>.</em></p> </div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div></div> <ul> <li> <div><strong>tab</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The tab that is being loaded.</div> </li> <li> <div><strong>panel</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The panel which will be populated by the Ajax response.</div> </li> <li> <div><strong>jqXHR</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jqXHR">jqXHR</a> </div> <div>The <code>jqXHR</code> object that is requesting the content.</div> </li> <li> <div><strong>ajaxSettings</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div>The settings that will be used by <a href="//api.jquery.com/jQuery.ajax/"><code>jQuery.ajax</code></a> to request the content.</div> </li> </ul> </li> </ul> <div> <strong>Code examples:</strong><p>Initialize the tabs with the beforeLoad callback specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({</code></div></div><div class="container"><div class="line"><code> beforeLoad: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Bind an event listener to the tabsbeforeload event:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"tabsbeforeload"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div id="event-create" class="api-item"> <h3>create( event, ui )<span class="returns">Type: <code>tabscreate</code></span> </h3> <div>Triggered when the tabs are created. If the tabs are collapsed, <code>ui.tab</code> and <code>ui.panel</code> will be empty jQuery objects.</div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div></div> <ul> <li> <div><strong>tab</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The active tab.</div> </li> <li> <div><strong>panel</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The active panel.</div> </li> </ul> </li> </ul> <div> <strong>Code examples:</strong><p>Initialize the tabs with the create callback specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({</code></div></div><div class="container"><div class="line"><code> create: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Bind an event listener to the tabscreate event:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"tabscreate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div> <div id="event-load" class="api-item"> <h3>load( event, ui )<span class="returns">Type: <code>tabsload</code></span> </h3> <div>Triggered after a remote tab has been loaded.</div> <ul> <li> <div><strong>event</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Event">Event</a> </div> <div></div> </li> <li> <div><strong>ui</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#Object">Object</a> </div> <div></div> <ul> <li> <div><strong>tab</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The tab that was just loaded.</div> </li> <li> <div><strong>panel</strong></div> <div>Type: <a href="http://api.jquery.com/Types/#jQuery">jQuery</a> </div> <div>The panel which was just populated by the Ajax response.</div> </li> </ul> </li> </ul> <div> <strong>Code examples:</strong><p>Initialize the tabs with the load callback specified:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).tabs({</code></div></div><div class="container"><div class="line"><code> load: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> </td> </tr> </tbody> </table> </div> <p>Bind an event listener to the tabsload event:</p> <div class="syntaxhighlighter javascript nogutter"> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"tabsload"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> </td> </tr> </tbody> </table> </div> </div> </div></section><section class="entry-examples" id="entry-examples"><header><h2>Example:</h2></header><div class="entry-example" id="example-0"> <h4><span class="desc">A simple jQuery UI Tabs</span></h4> <div class="syntaxhighlighter xml "> <table> <tbody> <tr> <td class="gutter"> <div class="line n1">1</div> <div class="line n2">2</div> <div class="line n3">3</div> <div class="line n4">4</div> <div class="line n5">5</div> <div class="line n6">6</div> <div class="line n7">7</div> <div class="line n8">8</div> <div class="line n9">9</div> <div class="line n10">10</div> <div class="line n11">11</div> <div class="line n12">12</div> <div class="line n13">13</div> <div class="line n14">14</div> <div class="line n15">15</div> <div class="line n16">16</div> <div class="line n17">17</div> <div class="line n18">18</div> <div class="line n19">19</div> <div class="line n20">20</div> <div class="line n21">21</div> <div class="line n22">22</div> <div class="line n23">23</div> <div class="line n24">24</div> <div class="line n25">25</div> <div class="line n26">26</div> <div class="line n27">27</div> <div class="line n28">28</div> <div class="line n29">29</div> <div class="line n30">30</div> <div class="line n31">31</div> <div class="line n32">32</div> <div class="line n33">33</div> <div class="line n34">34</div> <div class="line n35">35</div> <div class="line n36">36</div> <div class="line n37">37</div> <div class="line n38">38</div> </td> <td class="code"> <pre><div class="container"><div class="line"><code><span class="doctype"><!doctype html></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">html</span> <span class="attribute">lang</span>=<span class="value">"en"</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">head</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">meta</span> <span class="attribute">charset</span>=<span class="value">"utf-8"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">title</span>></span>tabs demo<span class="tag"></<span class="title">title</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">link</span> <span class="attribute">rel</span>=<span class="value">"stylesheet"</span> <span class="attribute">href</span>=<span class="value">"//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/jquery-1.10.2.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/ui/1.10.4/jquery-ui.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">head</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"tabs"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">ul</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">li</span>></span><span class="tag"><<span class="title">a</span> <span class="attribute">href</span>=<span class="value">"#fragment-1"</span>></span><span class="tag"><<span class="title">span</span>></span>One<span class="tag"></<span class="title">span</span>></span><span class="tag"></<span class="title">a</span>></span><span class="tag"></<span class="title">li</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">li</span>></span><span class="tag"><<span class="title">a</span> <span class="attribute">href</span>=<span class="value">"#fragment-2"</span>></span><span class="tag"><<span class="title">span</span>></span>Two<span class="tag"></<span class="title">span</span>></span><span class="tag"></<span class="title">a</span>></span><span class="tag"></<span class="title">li</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">li</span>></span><span class="tag"><<span class="title">a</span> <span class="attribute">href</span>=<span class="value">"#fragment-3"</span>></span><span class="tag"><<span class="title">span</span>></span>Three<span class="tag"></<span class="title">span</span>></span><span class="tag"></<span class="title">a</span>></span><span class="tag"></<span class="title">li</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">ul</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"fragment-1"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">p</span>></span>First tab is active by default:<span class="tag"></<span class="title">p</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">pre</span>></span><span class="tag"><<span class="title">code</span>></span>$( "#tabs" ).tabs(); <span class="tag"></<span class="title">code</span>></span><span class="tag"></<span class="title">pre</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"fragment-2"</span>></span></code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"fragment-3"</span>></span></code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.</code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">script</span>></span><span class="javascript"></span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">"#tabs"</span> ).tabs();</code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">html</span>></span></code></div></div></pre> </td> </tr> </tbody> </table> </div> <h4>Demo:</h4> <div class="demo code-demo"></div> </div></section> </div></article> </body> </html> |