~bcsaller/juju-gui/update-reductions

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

1610

</span>

1611

1612

1613

1614

1615

1616

<span class="flag protected">protected</span>

1617

1618

1619

1620

1621

1622

1623

1624

1625

1626

1627

1628

1629

<p>

1630

1631

Defined in

1632

1633

1634

1635

1636

1637

1638

</p>

1639

1640

1641

1642

1643

1644

<p>Available since 3.5.0</p>

1645

1646

</div>

1647

1648

1649

<p>Returns the current path root after popping off the last path segment,

1650

making it useful for resolving other URL paths against.</p>

1651

1652

<p>The path root will always begin and end with a '/'.</p>

1653

</div>

1654

1655

1656

1657

1658

1659

<h4>Returns:</h4>

1660

1661

1662

1663

1664

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

1665

1666

The URL's path root.

1667

1668

</div>

1669

</div>

1670

1671

1672

1673

</div>

1674

1675

1676

1677

<h3 class="name"><code>_navigate</code></h3>

1678

1679

1680

1681

1682

1683

1684

1685

1686

1687

</li>

1688

1689

1690

1691

<code class="optional">[options]</code>

1692

1693

</li>

1694

1695

</ul><span class="paren">)</span>

1696

</div>

1697

1698

1699

1700

1701

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

1702

</span>

1703

1704

1705

1706

1707

1708

<span class="flag protected">protected</span>

1709

1710

1711

1712

1713

1714

1715

1716

1717

1718

1719

1720

1721

<p>

1722

1723

Defined in

1724

1725

1726

1727

1728

1729

1730

</p>

1731

1732

1733

1734

1735

1736

<p>Available since 3.5.0</p>

1737

1738

</div>

1739

1740

1741

<p>Underlying implementation for <code>navigate()</code>.</p>

1742

</div>

1743

1744

1745

1746

<h4>Parameters:</h4>

1747

1748

1749

1750

1751

1752

1753

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

1754

1755

1756

1757

1758

1759

<p>The fully-resolved URL that the router should dispatch

1760

to its route handlers to fulfill the enhanced navigation "request", or use

1761

to update <code>window.location</code> in non-HTML5 history capable browsers.</p>

1762

</div>

1763

1764

1765

</li>

1766

1767

1768

1769

<code class="param-name optional">[options]</code>

1770

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

1771

<span class="flag optional" title="This parameter is optional.">optional</span>

1772

1773

1774

1775

1776

1777

<p>Additional options to configure the navigation.

1778

These are mixed into the <code>navigate</code> event facade.</p>

1779

</div>

1780

1781

1782

1783

1784

1785

1786

<code class="param-name optional">[replace]</code>

1787

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

1788

<span class="flag optional" title="This parameter is optional.">optional</span>

1789

1790

1791

1792

<p>Whether or not the current history

1793

entry will be replaced, or a new entry will be created. Will default

1794

to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p>

1795

</div>

1796

1797

1798

</li>

1799

1800

1801

1802

<code class="param-name optional">[force=false]</code>

1803

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

1804

<span class="flag optional" title="This parameter is optional.">optional</span>

1805

1806

1807

1808

<p>Whether the enhanced navigation

1809

should occur even in browsers without HTML5 history.</p>

1810

</div>

1811

1812

1813

</li>

1814

1815

</ul>

1816

1817

</li>

1818

1819

</ul>

1820

</div>

1821

1822

1823

1824

1825

<h4>Returns:</h4>

1826

1827

1828

1829

1830

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

1831

1832

<code>true</code> if the URL was navigated to, <code>false</code> otherwise.

1833

1834

</div>

1835

</div>

1836

1837

1838

1839

</div>

1840

1841

1842

1843

<h3 class="name"><code>_normalizePath</code></h3>

1844

1845

1846

1847

1848

1849

1850

1851

1852

1853

</li>

1854

1855

</ul><span class="paren">)</span>

1856

</div>

1857

1858

1859

1860

1861

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

1862

</span>

1863

1864

1865

1866

1867

1868

<span class="flag protected">protected</span>

1869

1870

1871

1872

1873

1874

1875

1876

1877

1878

1879

1880

1881

<p>

1882

1883

Defined in

1884

1885

1886

1887

1888

1889

1890

</p>

1891

1892

1893

1894

1895

1896

<p>Available since 3.5.0</p>

1897

1898

</div>

1899

1900

1901

<p>Returns a normalized path, ridding it of any '..' segments and properly

1902

handling leading and trailing slashes.</p>

1903

</div>

1904

1905

1906

1907

<h4>Parameters:</h4>

1908

1909

1910

1911

1912

1913

1914

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

1915

1916

1917

1918

1919

1920

<p>URL path to normalize.</p>

1921

</div>

1922

1923

1924

</li>

1925

1926

</ul>

1927

</div>

1928

1929

1930

1931

1932

<h4>Returns:</h4>

1933

1934

1935

1936

1937

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

1938

1939

Normalized path.

1940

1941

</div>

1942

</div>

1943

1944

1945

1946

</div>

1947

1948

1949

1950

<h3 class="name"><code>_onLinkClick</code></h3>

1951

1952

1953

1954

1955

1956

1957

1958

1959

1960

</li>

1961

1962

</ul><span class="paren">)</span>

1963

</div>

1964

1965

1966

1967

1968

1969

1970

1971

<span class="flag protected">protected</span>

1972

1973

1974

1975

1976

1977

1978

1979

1980

1981

1982

1983

1984

<p>

1985

1986

Defined in

1987

1988

1989

1990

1991

1992

1993

</p>

1994

1995

1996

1997

1998

1999

<p>Available since 3.5.0</p>

2000

2001

</div>

2002

2003

2004

<p>Handler for delegated link-click events which match the <code>linkSelector</code>.</p>

2005

2006

<p>This will attempt to enhance the navigation to the link element's <code>href</code> by

2007

passing the URL to the <code>_navigate()</code> method. When the navigation is being

2008

enhanced, the default action is prevented.</p>

2009

2010

<p>If the user clicks a link with the middle/right mouse buttons, or is holding

2011

down the Ctrl or Command keys, this method's behavior is not applied and

2012

allows the native behavior to occur. Similarly, if the router is not capable

2013

or handling the URL because no route-handlers match, the link click will

2014

behave natively.</p>

2015

</div>

2016

2017

2018

2019

<h4>Parameters:</h4>

2020

2021

2022

2023

2024

2025

2026

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2027

2028

2029

2030

2031

2032

2033

</div>

2034

2035

2036

</li>

2037

2038

</ul>

2039

</div>

2040

2041

2042

2043

2044

2045

</div>

2046

2047

2048

2049

<h3 class="name"><code>_pjaxBindUI</code></h3>

2050

2051

2052

2053

2054

2055

2056

2057

2058

2059

2060

<span class="flag protected">protected</span>

2061

2062

2063

2064

2065

2066

2067

2068

2069

2070

2071

2072

2073

<p>

2074

2075

Defined in

2076

2077

2078

2079

2080

2081

2082

</p>

2083

2084

2085

2086

2087

2088

<p>Available since 3.5.0</p>

2089

2090

</div>

2091

2092

2093

<p>Binds the delegation of link-click events that match the <code>linkSelector</code> to

2094

the <code>_onLinkClick()</code> handler.</p>

2095

2096

<p>By default this method will only be called if the browser is capable of

2097

using HTML5 history.</p>

2098

</div>

2099

2100

2101

2102

2103

2104

2105

</div>

2106

2107

2108

2109

<h3 class="name"><code>_resolvePath</code></h3>

2110

2111

2112

2113

2114

2115

2116

2117

2118

2119

</li>

2120

2121

</ul><span class="paren">)</span>

2122

</div>

2123

2124

2125

2126

2127

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2128

</span>

2129

2130

2131

2132

2133

2134

<span class="flag protected">protected</span>

2135

2136

2137

2138

2139

2140

2141

2142

2143

2144

2145

2146

2147

<p>

2148

2149

Defined in

2150

2151

2152

2153

2154

2155

2156

</p>

2157

2158

2159

2160

2161

2162

<p>Available since 3.5.0</p>

2163

2164

</div>

2165

2166

2167

<p>Returns the normalized result of resolving the <code>path</code> against the current

2168

path. Falsy values for <code>path</code> will return just the current path.</p>

2169

</div>

2170

2171

2172

2173

<h4>Parameters:</h4>

2174

2175

2176

2177

2178

2179

2180

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2181

2182

2183

2184

2185

2186

<p>URL path to resolve.</p>

2187

</div>

2188

2189

2190

</li>

2191

2192

</ul>

2193

</div>

2194

2195

2196

2197

2198

<h4>Returns:</h4>

2199

2200

2201

2202

2203

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

2204

2205

Resolved path.

2206

2207

</div>

2208

</div>

2209

2210

2211

2212

</div>

2213

2214

2215

2216

<h3 class="name"><code>_resolveURL</code></h3>

2217

2218

2219

2220

2221

2222

2223

2224

2225

2226

</li>

2227

2228

</ul><span class="paren">)</span>

2229

</div>

2230

2231

2232

2233

2234

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2235

</span>

2236

2237

2238

2239

2240

2241

<span class="flag protected">protected</span>

2242

2243

2244

2245

2246

2247

2248

2249

2250

2251

2252

2253

2254

<p>

2255

2256

Defined in

2257

2258

2259

2260

2261

2262

2263

</p>

2264

2265

2266

2267

2268

2269

<p>Available since 3.5.0</p>

2270

2271

</div>

2272

2273

2274

<p>Resolves the specified URL against the current URL.</p>

2275

2276

<p>This method resolves URLs like a browser does and will always return an

2277

absolute URL. When the specified URL is already absolute, it is assumed to

2278

be fully resolved and is simply returned as is. Scheme-relative URLs are

2279

prefixed with the current protocol. Relative URLs are giving the current

2280

URL's origin and are resolved and normalized against the current path root.</p>

2281

</div>

2282

2283

2284

2285

<h4>Parameters:</h4>

2286

2287

2288

2289

2290

2291

2292

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2293

2294

2295

2296

2297

2298

<p>URL to resolve.</p>

2299

</div>

2300

2301

2302

</li>

2303

2304

</ul>

2305

</div>

2306

2307

2308

2309

2310

<h4>Returns:</h4>

2311

2312

2313

2314

2315

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

2316

2317

Resolved URL.

2318

2319

</div>

2320

</div>

2321

2322

2323

2324

</div>

2325

2326

2327

2328

<h3 class="name"><code>navigate</code></h3>

2329

2330

2331

2332

2333

2334

2335

2336

2337

2338

</li>

2339

2340

2341

2342

<code class="optional">[options]</code>

2343

2344

</li>

2345

2346

</ul><span class="paren">)</span>

2347

</div>

2348

2349

2350

2351

2352

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

2353

</span>

2354

2355

2356

2357

2358

2359

2360

2361

2362

2363

2364

2365

2366

2367

2368

2369

2370

<p>

2371

2372

Defined in

2373

2374

2375

2376

2377

2378

2379

</p>

2380

2381

2382

2383

2384

2385

<p>Available since 3.5.0</p>

2386

2387

</div>

2388

2389

2390

<p>Navigates to the specified URL if there is a route handler that matches. In

2391

browsers capable of using HTML5 history, the navigation will be enhanced by

2392

firing the <code>navigate</code> event and having the router handle the "request".

2393

Non-HTML5 browsers will navigate to the new URL via manipulation of

2394

<code>window.location</code>.</p>

2395

2396

<p>When there is a route handler for the specified URL and it is being

2397

navigated to, this method will return <code>true</code>, otherwise it will return

2398

<code>false</code>.</p>

2399

2400

<p><strong>Note:</strong> The specified URL <em>must</em> be of the same origin as the current URL,

2401

otherwise an error will be logged and navigation will not occur. This is

2402

intended as both a security constraint and a purposely imposed limitation as

2403

it does not make sense to tell the router to navigate to a URL on a

2404

different scheme, host, or port.</p>

2405

</div>

2406

2407

2408

2409

<h4>Parameters:</h4>

2410

2411

2412

2413

2414

2415

2416

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2417

2418

2419

2420

2421

2422

<p>The URL to navigate to. This must be of the same origin

2423

as the current URL.</p>

2424

</div>

2425

2426

2427

</li>

2428

2429

2430

2431

<code class="param-name optional">[options]</code>

2432

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

2433

<span class="flag optional" title="This parameter is optional.">optional</span>

2434

2435

2436

2437

2438

2439

<p>Additional options to configure the navigation.

2440

These are mixed into the <code>navigate</code> event facade.</p>

2441

</div>

2442

2443

2444

2445

2446

2447

2448

<code class="param-name optional">[replace]</code>

2449

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

2450

<span class="flag optional" title="This parameter is optional.">optional</span>

2451

2452

2453

2454

<p>Whether or not the current history

2455

entry will be replaced, or a new entry will be created. Will default

2456

to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p>

2457

</div>

2458

2459

2460

</li>

2461

2462

2463

2464

<code class="param-name optional">[force=false]</code>

2465

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

2466

<span class="flag optional" title="This parameter is optional.">optional</span>

2467

2468

2469

2470

<p>Whether the enhanced navigation

2471

should occur even in browsers without HTML5 history.</p>

2472

</div>

2473

2474

2475

</li>

2476

2477

</ul>

2478

2479

</li>

2480

2481

</ul>

2482

</div>

2483

2484

2485

2486

2487

<h4>Returns:</h4>

2488

2489

2490

2491

2492

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

2493

2494

<code>true</code> if the URL was navigated to, <code>false</code> otherwise.

2495

2496

</div>

2497

</div>

2498

2499

2500

2501

</div>

2502

2503

2504

</div>

2505

2506

2507

2508

2509

<h2 class="off-left">Properties</h2>

2510

2511

2512

2513

<h3 class="name"><code>_pjaxEvents</code></h3>

2514

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

2515

2516

2517

2518

2519

<span class="flag protected">protected</span>

2520

2521

2522

2523

2524

2525

2526

2527

2528

2529

2530

<p>

2531

2532

Defined in

2533

2534

2535

2536

2537

2538

2539

</p>

2540

2541

2542

2543

2544

<p>Available since 3.5.0</p>

2545

2546

</div>

2547

2548

2549

<p>Holds the delegated pjax-link click handler.</p>

2550

</div>

2551

2552

2553

2554

2555

2556

2557

</div>

2558

2559

2560

2561

<h3 class="name"><code>_regexURL</code></h3>

2562

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>

2563

2564

2565

2566

2567

<span class="flag protected">protected</span>

2568

2569

2570

2571

2572

2573

2574

2575

2576

2577

2578

<p>

2579

2580

Defined in

2581

2582

2583

2584

2585

2586

2587

</p>

2588

2589

2590

2591

2592

<p>Available since 3.5.0</p>

2593

2594

</div>

2595

2596

2597

<p>Regex used to break up a URL string around the URL's path.</p>

2598

2599

<p>Subpattern captures:</p>

2600

2601

<ol>

2602

<li>Origin, everything before the URL's path-part.</li>

2603

2604

<li>Suffix, everything after the URL's path-part.</li>

2605

</ol>

2606

</div>

2607

2608

2609

2610

2611

2612

2613

</div>

2614

2615

2616

</div>

2617

2618

2619

2620

2621

<h2 class="off-left">Attributes</h2>

2622

2623

2624

2625

2626

<h3 class="name"><code>linkSelector</code></h3>

2627

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

2628

2629

2630

2631

2632

2633

2634

2635

2636

2637

2638

2639

2640

2641

<p>

2642

2643

Defined in

2644

2645

2646

2647

2648

2649

2650

</p>

2651

2652

2653

2654

2655

<p>Available since 3.5.0</p>

2656

2657

</div>

2658

2659

2660

<p>CSS selector string used to filter link click events so that only the links

2661

which match it will have the enhanced navigation behavior of Pjax applied.</p>

2662

2663

<p>When a link is clicked and that link matches this selector, Pjax will

2664

attempt to dispatch to any route handlers matching the link's <code>href</code> URL. If

2665

HTML5 history is not supported or if no route handlers match, the link click

2666

will be handled by the browser just like any old link.</p>

2667

</div>

2668

2669

2670

<p><strong>Default:</strong> "a.pjax"</p>

2671

2672

2673

2674

2675

<h4>Fires event <code>linkSelectorChange</code></h4>

2676

2677

<p>

2678

Fires when the value for the configuration attribute <code>linkSelector</code> is

2679

changed. You can listen for the event using the <code>on</code> method if you

2680

wish to be notified before the attribute's value has changed, or

2681

using the <code>after</code> method if you wish to be notified after the

2682

attribute's value has changed.

2683

</p>

2684

2685

2686

<h4>Parameters:</h4>

2687

2688

2689

2690

2691

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2692

2693

2694

An Event Facade object with the following

2695

attribute-specific properties added:

2696

</div>

2697

2698

2699

2700

<code class="param-name">prevVal</code>

2701

2702

<div class="param-description">The value of the attribute, prior to it being set.</div>

2703

</li>

2704

2705

<code class="param-name">newVal</code>

2706

2707

<div class="param-description">The value the attribute is to be set to.</div>

2708

</li>

2709

2710

<code class="param-name">attrName</code>

2711

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2712

<div class="param-description">The name of the attribute being set.</div>

2713

</li>

2714

2715

<code class="param-name">subAttrName</code>

2716

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2717

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

2718

</li>

2719

</ul>

2720

</li>

2721

</ul>

2722

</div>

2723

</div>

2724

2725

2726

2727

</div>

2728

2729

2730

2731

2732

<h3 class="name"><code>navigateOnHash</code></h3>

2733

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

2734

2735

2736

2737

2738

2739

2740

2741

2742

2743

2744

2745

2746

2747

<p>

2748

2749

Defined in

2750

2751

2752

2753

2754

2755

2756

</p>

2757

2758

2759

2760

2761

<p>Available since 3.5.0</p>

2762

2763

</div>

2764

2765

2766

<p>Whether navigating to a hash-fragment identifier on the current page should

2767

be enhanced and cause the <code>navigate</code> event to fire.</p>

2768

2769

<p>By default Pjax allows the browser to perform its default action when a user

2770

is navigating within a page by clicking in-page links

2771

(e.g. <code><a href="#top">Top of page</a></code>) and does not attempt to interfere or

2772

enhance in-page navigation.</p>

2773

</div>

2774

2775

2776

<p><strong>Default:</strong> false</p>

2777

2778

2779

2780

2781

<h4>Fires event <code>navigateOnHashChange</code></h4>

2782

2783

<p>

2784

Fires when the value for the configuration attribute <code>navigateOnHash</code> is

2785

changed. You can listen for the event using the <code>on</code> method if you

2786

wish to be notified before the attribute's value has changed, or

2787

using the <code>after</code> method if you wish to be notified after the

2788

attribute's value has changed.

2789

</p>

2790

2791

2792

<h4>Parameters:</h4>

2793

2794

2795

2796

2797

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2798

2799

2800

An Event Facade object with the following

2801

attribute-specific properties added:

2802

</div>

2803

2804

2805

2806

<code class="param-name">prevVal</code>

2807

2808

<div class="param-description">The value of the attribute, prior to it being set.</div>

2809

</li>

2810

2811

<code class="param-name">newVal</code>

2812

2813

<div class="param-description">The value the attribute is to be set to.</div>

2814

</li>

2815

2816

<code class="param-name">attrName</code>

2817

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2818

<div class="param-description">The name of the attribute being set.</div>

2819

</li>

2820

2821

<code class="param-name">subAttrName</code>

2822

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2823

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

2824

</li>

2825

</ul>

2826

</li>

2827

</ul>

2828

</div>

2829

</div>

2830

2831

2832

2833

</div>

2834

2835

2836

2837

2838

<h3 class="name"><code>scrollToTop</code></h3>

2839

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

2840

2841

2842

2843

2844

2845

2846

2847

2848

2849

2850

2851

2852

2853

<p>

2854

2855

Defined in

2856

2857

2858

2859

2860

2861

2862

</p>

2863

2864

2865

2866

2867

<p>Available since 3.5.0</p>

2868

2869

</div>

2870

2871

2872

<p>Whether the page should be scrolled to the top after navigating to a URL.</p>

2873

2874

<p>When the user clicks the browser's back button, the previous scroll position

2875

will be maintained.</p>

2876

</div>

2877

2878

2879

<p><strong>Default:</strong> true</p>

2880

2881

2882

2883

2884

<h4>Fires event <code>scrollToTopChange</code></h4>

2885

2886

<p>

2887

Fires when the value for the configuration attribute <code>scrollToTop</code> is

2888

changed. You can listen for the event using the <code>on</code> method if you

2889

wish to be notified before the attribute's value has changed, or

2890

using the <code>after</code> method if you wish to be notified after the

2891

attribute's value has changed.

2892

</p>

2893

2894

2895

<h4>Parameters:</h4>

2896

2897

2898

2899

2900

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2901

2902

2903

An Event Facade object with the following

2904

attribute-specific properties added:

2905

</div>

2906

2907

2908

2909

<code class="param-name">prevVal</code>

2910

2911

<div class="param-description">The value of the attribute, prior to it being set.</div>

2912

</li>

2913

2914

<code class="param-name">newVal</code>

2915

2916

<div class="param-description">The value the attribute is to be set to.</div>

2917

</li>

2918

2919

<code class="param-name">attrName</code>

2920

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2921

<div class="param-description">The name of the attribute being set.</div>

2922

</li>

2923

2924

<code class="param-name">subAttrName</code>

2925

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

2926

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

2927

</li>

2928

</ul>

2929

</li>

2930

</ul>

2931

</div>

2932

</div>

2933

2934

2935

2936

</div>

2937

2938

2939

</div>

2940

2941

2942

2943

2944

<h2 class="off-left">Events</h2>

2945

2946

2947

2948

<h3 class="name"><code>navigate</code></h3>

2949

2950

2951

2952

2953

2954

2955

2956

2957

2958

2959

2960

2961

2962

2963

<p>

2964

2965

Defined in

2966

2967

2968

2969

2970

2971

2972

</p>

2973

2974

2975

2976

2977

<p>Available since 3.5.0</p>

2978

2979

</div>

2980

2981

2982

<p>Fired when navigating to a URL via Pjax.</p>

2983

2984

<p>When the <code>navigate()</code> method is called or a pjax link is clicked, this event

2985

will be fired if the browser supports HTML5 history <em>and</em> the router has a

2986

route handler for the specified URL.</p>

2987

2988

<p>This is a useful event to listen to for adding a visual loading indicator

2989

while the route handlers are busy handling the URL change.</p>

2990

</div>

2991

2992

2993

2994

<h4>Event Payload:</h4>

2995

2996

2997

2998

2999

3000

3001

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

3002

3003

3004

3005

3006

3007

<p>The URL that the router will dispatch to its route

3008

handlers in order to fulfill the enhanced navigation "request".</p>

3009

</div>

3010

3011

3012

</li>

3013

3014

3015

3016

<code class="param-name optional">[force=false]</code>

3017

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

3018

<span class="flag optional" title="This parameter is optional.">optional</span>

3019

3020

3021

3022

3023

3024

<p>Whether the enhanced navigation should occur

3025

even in browsers without HTML5 history.</p>

3026

</div>

3027

3028

3029

</li>

3030

3031

3032

3033

3034

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

3035

<span class="flag optional" title="This parameter is optional.">optional</span>

3036

3037

3038

3039

3040

3041

<p>The hash-fragment (including "#") of the <code>url</code>. This

3042

will be present when the <code>url</code> differs from the current URL only by its

3043

hash and <code>navigateOnHash</code> has ben set to <code>true</code>.</p>

3044

</div>

3045

3046

3047

</li>

3048

3049

3050

3051

<code class="param-name optional">[originEvent]</code>

3052

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

3053

<span class="flag optional" title="This parameter is optional.">optional</span>

3054

3055

3056

3057

3058

3059

<p>The event that caused the navigation. Usually

3060

this would be a click event from a "pjax" anchor element.</p>

3061

</div>

3062

3063

3064

</li>

3065

3066

3067

3068

<code class="param-name optional">[replace]</code>

3069

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

3070

<span class="flag optional" title="This parameter is optional.">optional</span>

3071

3072

3073

3074

3075

3076

<p>Whether or not the current history entry will be

3077

replaced, or a new entry will be created. Will default to <code>true</code> if the

3078

specified <code>url</code> is the same as the current URL.</p>

3079

</div>

3080

3081

3082

</li>

3083

3084

</ul>

3085

</div>

3086

3087

3088

3089

3090

</div>

3091

3092

3093

</div>

3094

3095

</div>

3096

</div>

3097

3098

</div>

3099

</div>

3100

</div>

3101

</div>

3102

</div>

3103

</div>

3104

3105

3106

3107

3108

3109

3110

3111

3112

</body>

3113

</html>

Older »