d3d9aac4e9
Add optional, backwards compatible generic type to `ElementRef` to support typed `nativeElement` Fix #13139 PR Close #20765
50 lines
1.8 KiB
TypeScript
50 lines
1.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
/**
|
|
* A wrapper around a native element inside of a View.
|
|
*
|
|
* An `ElementRef` is backed by a render-specific element. In the browser, this is usually a DOM
|
|
* element.
|
|
*
|
|
* @security Permitting direct access to the DOM can make your application more vulnerable to
|
|
* XSS attacks. Carefully review any use of `ElementRef` in your code. For more detail, see the
|
|
* [Security Guide](http://g.co/ng/security).
|
|
*
|
|
* @stable
|
|
*/
|
|
// Note: We don't expose things like `Injector`, `ViewContainer`, ... here,
|
|
// i.e. users have to ask for what they need. With that, we can build better analysis tools
|
|
// and could do better codegen in the future.
|
|
export class ElementRef<T = any> {
|
|
/**
|
|
* The underlying native element or `null` if direct access to native elements is not supported
|
|
* (e.g. when the application runs in a web worker).
|
|
*
|
|
* <div class="callout is-critical">
|
|
* <header>Use with caution</header>
|
|
* <p>
|
|
* Use this API as the last resort when direct access to DOM is needed. Use templating and
|
|
* data-binding provided by Angular instead. Alternatively you can take a look at {@link
|
|
* Renderer2}
|
|
* which provides API that can safely be used even when direct access to native elements is not
|
|
* supported.
|
|
* </p>
|
|
* <p>
|
|
* Relying on direct DOM access creates tight coupling between your application and rendering
|
|
* layers which will make it impossible to separate the two and deploy your application into a
|
|
* web worker.
|
|
* </p>
|
|
* </div>
|
|
* @stable
|
|
*/
|
|
public nativeElement: T;
|
|
|
|
constructor(nativeElement: T) { this.nativeElement = nativeElement; }
|
|
}
|