Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat(core): mark signal-based query APIs as stable (#57921)

Browse source 
This commit marks the contentChild, contentChildren, viewChild
and viewChildren APIs (along with any associated APIs) as stable
and thus exits the dev preview
phase for those APIs.

PR Close #57921
This commit is contained in:
Pawel Kozlowski 2024-09-23 14:41:50 +02:00
parent 48216a28e8
commit a7eff3ffaa
2 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
adev/src/content/guide/signals/queries.md
View file

@ -8,8 +8,6 @@ There are two categories of query: view queries and content queries.
Signal queries supply query results as a reactive signal primitive. You can use query results in `computed` and `effect`, composing these results with other signals.
IMPORTANT: Signal queries are in [developer preview](reference/releases#developer-preview). APIs may change based on feedback without going through Angular's deprecation cycle.
If you're already familiar with Angular queries, you can jump straight to [Comparing signal-based queries to decorator-based queries](#comparing-signal-based-queries-to-decorator-based-queries)
## View queries

18
packages/core/src/authoring/queries.ts
View file

@ -37,7 +37,7 @@ function viewChildRequiredFn<LocatorT, ReadT>(
* It is a special function that also provides access to required query results via the `.required`
* property.
*
* @developerPreview
* @publicAPI
* @docsPrivate Ignored because `viewChild` is the canonical API entry.
*/
export interface ViewChildFunction {
@ -45,7 +45,7 @@ export interface ViewChildFunction {
* Initializes a view child query. Consider using `viewChild.required` for queries that should
* always match.
*
* @developerPreview
* @publicAPI
*/
<LocatorT>(locator: ProviderToken<LocatorT> | string): Signal<LocatorT | undefined>;
<LocatorT, ReadT>(
@ -56,7 +56,7 @@ export interface ViewChildFunction {
/**
* Initializes a view child query that is expected to always match an element.
*
* @developerPreview
* @publicAPI
*/
required: {
<LocatorT>(locator: ProviderToken<LocatorT> | string): Signal<LocatorT>;
@ -87,7 +87,7 @@ export interface ViewChildFunction {
* }
* ```
*
* @developerPreview
* @publicAPI
* @initializerApiFunction
*/
export const viewChild: ViewChildFunction = (() => {
@ -124,7 +124,7 @@ export function viewChildren<LocatorT, ReadT>(
* ```
*
* @initializerApiFunction
* @developerPreview
* @publicAPI
*/
export function viewChildren<LocatorT, ReadT>(
locator: ProviderToken<LocatorT> | string,
@ -156,7 +156,7 @@ function contentChildRequiredFn<LocatorT, ReadT>(
* The contentChild function creates a singular content query. It is a special function that also
* provides access to required query results via the `.required` property.
*
* @developerPreview
* @publicAPI
* @docsPrivate Ignored because `contentChild` is the canonical API entry.
*/
export interface ContentChildFunction {
@ -164,7 +164,7 @@ export interface ContentChildFunction {
* Initializes a content child query.
*
* Consider using `contentChild.required` for queries that should always match.
* @developerPreview
* @publicAPI
*/
<LocatorT>(
locator: ProviderToken<LocatorT> | string,
@ -220,7 +220,7 @@ export interface ContentChildFunction {
* ```
*
* @initializerApiFunction
* @developerPreview
* @publicAPI
*/
export const contentChild: ContentChildFunction = (() => {
// Note: This may be considered a side-effect, but nothing will depend on
@ -257,7 +257,7 @@ export function contentChildren<LocatorT, ReadT>(
* ```
*
* @initializerApiFunction
* @developerPreview
* @publicAPI
*/
export function contentChildren<LocatorT, ReadT>(
locator: ProviderToken<LocatorT> | string,