Skip to content
This repository was archived by the owner on May 29, 2019. It is now read-only.

Commit 64d2c03

Browse files
author
Arthur Evans
authored
Merge pull request #2571 from Polymer/3-0-api-links
Update API doc links
2 parents 68eee79 + 46ae081 commit 64d2c03

File tree

8 files changed

+27
-27
lines changed

8 files changed

+27
-27
lines changed

app/3.0/docs/devguide/custom-css-properties.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ import '@webcomponents/shadycss/entrypoints/apply-shim.js';
404404
Polymer's custom property shim evaluates and applies custom property values once
405405
at element creation time. In order to have an element (and its subtree) re-
406406
evaluate custom property values due to dynamic changes such as application of
407-
CSS classes, call the [`updateStyles`](/3.0/docs/api/elements/Polymer.Element#method-updateStyles)
407+
CSS classes, call the [`updateStyles`](/3.0/docs/api/polymer-element#PolymerElement-method-updateStyles)
408408
method on the element. To update _all_ elements on the page, you can also call
409409
`Polymer.updateStyles`.
410410

@@ -449,7 +449,7 @@ if (ShadyCSS) {
449449
```
450450

451451
Elements using the legacy API can use the
452-
[`getComputedStyleValue`](/3.0/docs/api/mixins/Polymer.LegacyElementMixin#method-getComputedStyleValue)
452+
[`getComputedStyleValue`](/3.0/docs/api/legacy/legacy-element-mixin#LegacyElementMixin-method-getComputedStyleValue)
453453
instance method instead of testing for `ShadyCSS`.
454454

455455
### Custom properties shim limitations
@@ -471,7 +471,7 @@ dynamism will continue to be explored.
471471
Only property definitions which match the element at *creation time* are applied.
472472
Any dynamic changes that update property values are not applied automatically. You
473473
can force styles to be re-evaluated by calling the
474-
[`updateStyles`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-updateStyles) method on a
474+
[`updateStyles`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-updateStyles) method on a
475475
Polymer element, or the global `updateStyles` function to update all element
476476
styles.
477477

app/3.0/docs/devguide/custom-elements.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Related topics:
198198
199199
### Defer non-critical work {#defer-work}
200200
201-
When possible, defer work until after first paint. The [`render-status`](/{{{polymer_version_dir}}}/docs/api/namespaces/Polymer.RenderStatus) module provides
201+
When possible, defer work until after first paint. The [`render-status`](/{{{polymer_version_dir}}}/docs/api/utils/render-status) module provides
202202
an `afterNextRender` utility for this purpose.
203203
204204
```js
@@ -436,7 +436,7 @@ in Document your elements.
436436
When creating a mixin that you intend to share with other groups or publish, a couple of additional
437437
steps are recommended:
438438
439-
- Use the [`dedupingMixin`](/{{{polymer_version_dir}}}/docs/api/#function-Polymer.dedupingMixin)
439+
- Use the [`dedupingMixin`](/{{{polymer_version_dir}}}/docs/api/utils/mixin#function-dedupingMixin)
440440
function to produce a mixin that can only be applied once.
441441
442442
- Define the mixin in an ES module and export it.

app/3.0/docs/devguide/data-system.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,8 @@ this.push('users', { name: 'Maturin'});
162162

163163
In some cases, you can't use the Polymer methods to mutate objects and arrays (for example, if
164164
you're using a third-party library). In this case, you can use the
165-
[`notifyPath`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-notifyPath) and
166-
[`notifySplices`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-notifySplices)
165+
[`notifyPath`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-notifyPath) and
166+
[`notifySplices`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-notifySplices)
167167
methods to *notify* the element about changes that have **already taken place.**
168168

169169

@@ -196,7 +196,7 @@ If you have a data structure with multiple levels of objects and arrays, you may
196196
deep copy to pick up changes.
197197

198198
If your application requires it, you can eliminate dirty-checking of objects and arrays on a
199-
per-element basis using the `Polymer.MutableData` mixin. This mixin may trade some performance
199+
per-element basis using the `MutableData` mixin. This mixin may trade some performance
200200
for increased ease of use. For details, see [Using the MutableData mixin](#mutable-data).
201201

202202
Related tasks:
@@ -357,7 +357,7 @@ maintains path linkages between an array and a selected item from that array. (`
357357
also works when selecting multiple items from an array.)
358358

359359
For other use cases, there's an imperative method,
360-
[`linkPaths`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-linkPaths) to
360+
[`linkPaths`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-linkPaths) to
361361
associate two paths. When two paths are *linked*, an [observable change](#observable-changes) to one
362362
path is observable on the other path, as well.
363363

@@ -888,7 +888,7 @@ the following is true:
888888
* You always use the Polymer data mutation methods to make granular changes.
889889

890890
However, for apps that don't use immutable data and can't use the Polymer data methods, Polymer 3.0
891-
provides the [`MutableData`](/{{{polymer_version_dir}}}/docs/api/mixins/Polymer.MutableData)
891+
provides the [`MutableData`](/{{{polymer_version_dir}}}/docs/api/mixins/mutable-data#MutableData)
892892
mixin.
893893

894894
```js
@@ -954,7 +954,7 @@ complex reusable elements (like `dom-repeat` or `iron-list`), or for application
954954
that hold complex state information.
955955

956956
Note that the `MutableData` mixin does not affect the element's shadow DOM children. **Any element
957-
that doesn't use the `Polymer.MutableData` mixin uses the default dirty-checking policy.**
957+
that doesn't use the `MutableData` mixin uses the default dirty-checking policy.**
958958

959959
If you're using the `dom-repeat` element, you can enable mutable data mode by setting its
960960
`mutableData` property:
@@ -970,7 +970,7 @@ If you're using the `dom-repeat` element, you can enable mutable data mode by se
970970
### Optional mutable data for reusable elements {#optional-mutable-data}
971971

972972
If you're building a reusable element that takes structured data, you can use the
973-
[`Polymer.OptionalMutableData`](/{{{polymer_version_dir}}}/docs/api/mixins/Polymer.OptionalMutableData)
973+
[`OptionalMutableData`](/{{{polymer_version_dir}}}/docs/api/mixins/mutable-data#OptionalMutableData)
974974
mixin. This mixin lets the element user select `MutableData` mode by setting the `mutableData`
975975
property on the element.
976976

app/3.0/docs/devguide/model-data.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ There are a few special types of path segments.
4141

4242
## Get a value by path {#get-value}
4343

44-
Use the [`get`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-get) method to retrieve a value based on
44+
Use the [`get`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-get) method to retrieve a value based on
4545
its path.
4646

4747
```
@@ -54,7 +54,7 @@ var item = this.get(['myArray', 11])
5454

5555
## Set a property or subproperty by path {#set-path}
5656

57-
Use the [`set`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-set) method to
57+
Use the [`set`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-set) method to
5858
make an [observable change](data-system#observable-changes) to a subproperty.
5959

6060
```js
@@ -206,7 +206,7 @@ a few choices:
206206
Whenever possible you should always use Polymer's [array mutation methods](#array-mutation).
207207
However, this isn't always possible. For example, you may be using a third-party library
208208
that does not use Polymer's array mutation methods. In these scenarios you can call
209-
<a href="/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-notifySplices">`notifySplices`</a>
209+
<a href="/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-notifySplices">`notifySplices`</a>
210210
after the mutations to ensure that any Polymer elements observing the array
211211
are properly notified of the changes.
212212

@@ -225,7 +225,7 @@ object or array itself hasn't changed. For details, see [Using the MutableData m
225225

226226
## Batch multiple property changes {#set-property}
227227

228-
Use [`setProperties`](/{{{polymer_version_dir}}}/docs/api/mixins/Polymer.PropertyEffects#method-setProperties)
228+
Use [`setProperties`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-setProperties)
229229
method to make a batch change to a set of properties. This ensures the property changes
230230
run as a coherent set.
231231

@@ -248,7 +248,7 @@ this.setProperties({
248248

249249
## Link two paths to the same object {#linkpaths}
250250

251-
Use the [`linkPaths`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.Element#method-linkPaths)
251+
Use the [`linkPaths`](/{{{polymer_version_dir}}}/docs/api/polymer-element#PolymerElement-method-linkPaths)
252252
method to associate two paths. Use `linkPaths` when an element has two paths that refer to the same
253253
object, as described in [Two paths referencing the same object](data-system#two-paths).
254254

app/3.0/docs/devguide/observers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This allows the element to avoid running observers in the default case.
4444

4545
Like all property effects, observers are synchronous. If the observer is likely to be invoked
4646
frequently, consider deferring time-consuming work, like inserting or removing DOM. For example, you
47-
can use the [`Polymer.Async`](/{{{polymer_version_dir}}}/docs/api/namespaces/Polymer.Async) module to defer work.
47+
can use the [`async`](/{{{polymer_version_dir}}}/docs/api/utils/async) module to defer work.
4848

4949
However, if you handle a data change asynchronously, note that the parameters passed to the observer
5050
may not match the element's current property values.

app/3.0/docs/devguide/templates.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ static get template() {
386386

387387
### Forcing synchronous renders {#synchronous-renders}
388388

389-
Call [`render`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.DomRepeat#method-render)
389+
Call [`render`](/{{{polymer_version_dir}}}/docs/api/elements/dom-repeat#DomRepeat-method-render)
390390
to force a `dom-repeat` template to synchronously render any changes to its
391391
data. Normally changes are batched and rendered asynchronously. Synchronous
392392
rendering has a performance cost, but can be useful in a few scenarios:
@@ -423,7 +423,7 @@ one of the following:
423423
For complex data structures, a deep clone may be required.
424424

425425
* If you don't have an exact set of changes, you can set the
426-
[`mutableData`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.DomRepeat#property-mutableData)
426+
[`mutableData`](/{{{polymer_version_dir}}}/docs/api/elements/dom-repeat#DomRepeat-property-mutableData)
427427
property on the `dom-repeat` to disable dirty checking on the array.
428428
429429
```html
@@ -448,22 +448,22 @@ By default, `dom-repeat` tries to render all of the list items at once. If
448448
you try to use `dom-repeat` to render a very large list of items, the UI may
449449
freeze while it's rendering the list. If you encounter this problem, enable
450450
"chunked" rendering by setting
451-
[`initialCount`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.DomRepeat#property-initialCount).
451+
[`initialCount`](/{{{polymer_version_dir}}}/docs/api/elements/dom-repeat#DomRepeat-property-initialCount).
452452
In chunked mode,
453453
`dom-repeat` renders `initialCount` items at first, then renders the rest of
454454
the items incrementally one chunk per animation frame. This lets the UI thread
455455
handle user input between chunks. You can keep track of how many items have
456456
been rendered with the
457-
[`renderedItemCount`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.DomRepeat#property-renderedItemCount)
457+
[`renderedItemCount`](/{{{polymer_version_dir}}}/docs/api/elements/dom-repeat#DomRepeat-property-renderedItemCount)
458458
read-only property.
459459

460460
`dom-repeat` adjusts the number of items rendered in each chunk to try and
461461
maintain a target framerate. You can further tune rendering by setting
462-
[`targetFramerate`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.DomRepeat#property-targetFramerate).
462+
[`targetFramerate`](/{{{polymer_version_dir}}}/docs/api/elements/dom-repeat#DomRepeat-property-targetFramerate).
463463

464464
You can also set a debounce time that must pass before a `filter` or `sort`
465465
function is re-run by setting the
466-
[`delay`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.DomRepeat#property-delay)
466+
[`delay`](/{{{polymer_version_dir}}}/docs/api/elements/dom-repeat#DomRepeat-property-delay)
467467
property.
468468

469469
## Data bind an array selection (array-selector) {#array-selector}

app/3.0/docs/upgrade.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1395,7 +1395,7 @@ rather than being bundled in with `Polymer.Element`. For details, see
13951395
13961396
In many cases you can use the native platform features (such as `setTimeout` or
13971397
`requestAnimationFrame` instead of the `async` call. Polymer 2.x also provides an optional
1398-
[`Polymer.Async`](/{{{polymer_version_dir}}}/docs/api/namespaces/Polymer.Async) module that provides
1398+
[`Polymer.Async`](/{{{polymer_version_dir}}}/docs/api/utils/async) module that provides
13991399
a set of Async APIs with a common interface. This is particularly useful for microtask timing, which
14001400
is harder to time consistently across browsers.
14011401
@@ -1546,7 +1546,7 @@ separate, optional imports. These include:
15461546
- [`<dom-bind>` element](devguide/templates#dom-bind)
15471547
- [`<dom-if>` element](devguide/templates#dom-if)
15481548
- [`<dom-repeat>` element](devguide/templates#dom-repeat)
1549-
- [`Polymer.RenderStatus`](/{{{polymer_version_dir}}}/docs/api/namespaces/Polymer.RenderStatus)
1549+
- [`Polymer.RenderStatus`](/{{{polymer_version_dir}}}/docs/api/utils/render-status)
15501550
module.
15511551
15521552
Element imports are found in the Polymer folder under `/lib/elements`, mixins under `/lib/mixins`,

app/3.0/toolbox/case-study.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ _pageChanged(page, oldPage) {
129129
In the logic above, the home view is built into the app shell, but the other
130130
views are demand-loaded fragments.
131131

132-
Shop also uses [`dom-if`](/{{{polymer_version_dir}}}/docs/api/elements/Polymer.DomIf) templates to lazily create views:
132+
Shop also uses [`dom-if`](/{{{polymer_version_dir}}}/docs/api/elements/dom-if) templates to lazily create views:
133133

134134
```html
135135
<!-- Lazy-create the tabs for larger screen sizes. -->

0 commit comments

Comments
 (0)