cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: push animation api doc changes back to stable (#24525)

Browse Source 
PR Close #24525
This commit is contained in:
Judy Bogart 2018-05-03 10:54:51 -07:00 committed by Miško Hevery
parent e1bc3f5c1a
commit aa66e84e44
2 changed files with 655 additions and 661 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1248
packages/animations/src/animation_metadata.ts
View File

File diff suppressed because it is too large Load Diff

32
tools/public_api_guard/animations/animations.d.ts vendored
View File

@ -1,36 +1,28 @@
/** @experimental */
export declare function animate(timings: string | number, styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null): AnimationAnimateMetadata; export declare function animate(timings: string | number, styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null): AnimationAnimateMetadata;
/** @experimental */
export declare function animateChild(options?: AnimateChildOptions | null): AnimationAnimateChildMetadata; export declare function animateChild(options?: AnimateChildOptions | null): AnimationAnimateChildMetadata;
/** @experimental */
export interface AnimateChildOptions extends AnimationOptions { export interface AnimateChildOptions extends AnimationOptions {
duration?: number | string; duration?: number | string;
} }
/** @experimental */
export declare type AnimateTimings = { export declare type AnimateTimings = {
duration: number; duration: number;
delay: number; delay: number;
easing: string | null; easing: string | null;
}; };
/** @experimental */
export declare function animation(steps: AnimationMetadata | AnimationMetadata[], options?: AnimationOptions | null): AnimationReferenceMetadata; export declare function animation(steps: AnimationMetadata | AnimationMetadata[], options?: AnimationOptions | null): AnimationReferenceMetadata;
/** @experimental */
export interface AnimationAnimateChildMetadata extends AnimationMetadata { export interface AnimationAnimateChildMetadata extends AnimationMetadata {
options: AnimationOptions | null; options: AnimationOptions | null;
} }
/** @experimental */
export interface AnimationAnimateMetadata extends AnimationMetadata { export interface AnimationAnimateMetadata extends AnimationMetadata {
styles: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null; styles: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null;
timings: string | number | AnimateTimings; timings: string | number | AnimateTimings;
} }
/** @experimental */
export interface AnimationAnimateRefMetadata extends AnimationMetadata { export interface AnimationAnimateRefMetadata extends AnimationMetadata {
animation: AnimationReferenceMetadata; animation: AnimationReferenceMetadata;
options: AnimationOptions | null; options: AnimationOptions | null;
@ -57,23 +49,19 @@ export declare abstract class AnimationFactory {
abstract create(element: any, options?: AnimationOptions): AnimationPlayer; abstract create(element: any, options?: AnimationOptions): AnimationPlayer;
} }
/** @experimental */
export interface AnimationGroupMetadata extends AnimationMetadata { export interface AnimationGroupMetadata extends AnimationMetadata {
options: AnimationOptions | null; options: AnimationOptions | null;
steps: AnimationMetadata[]; steps: AnimationMetadata[];
} }
/** @experimental */
export interface AnimationKeyframesSequenceMetadata extends AnimationMetadata { export interface AnimationKeyframesSequenceMetadata extends AnimationMetadata {
steps: AnimationStyleMetadata[]; steps: AnimationStyleMetadata[];
} }
/** @experimental */
export interface AnimationMetadata { export interface AnimationMetadata {
type: AnimationMetadataType; type: AnimationMetadataType;
} }
/** @experimental */
export declare const enum AnimationMetadataType { export declare const enum AnimationMetadataType {
State = 0, State = 0,
Transition = 1, Transition = 1,
@ -90,7 +78,6 @@ export declare const enum AnimationMetadataType {
Stagger = 12, Stagger = 12,
} }
/** @experimental */
export interface AnimationOptions { export interface AnimationOptions {
delay?: number | string; delay?: number | string;
params?: { params?: {
@ -118,38 +105,32 @@ export interface AnimationPlayer {
setPosition(p: any): void; setPosition(p: any): void;
} }
/** @experimental */
export interface AnimationQueryMetadata extends AnimationMetadata { export interface AnimationQueryMetadata extends AnimationMetadata {
animation: AnimationMetadata | AnimationMetadata[]; animation: AnimationMetadata | AnimationMetadata[];
options: AnimationQueryOptions | null; options: AnimationQueryOptions | null;
selector: string; selector: string;
} }
/** @experimental */
export interface AnimationQueryOptions extends AnimationOptions { export interface AnimationQueryOptions extends AnimationOptions {
limit?: number; limit?: number;
optional?: boolean; optional?: boolean;
} }
/** @experimental */
export interface AnimationReferenceMetadata extends AnimationMetadata { export interface AnimationReferenceMetadata extends AnimationMetadata {
animation: AnimationMetadata | AnimationMetadata[]; animation: AnimationMetadata | AnimationMetadata[];
options: AnimationOptions | null; options: AnimationOptions | null;
} }
/** @experimental */
export interface AnimationSequenceMetadata extends AnimationMetadata { export interface AnimationSequenceMetadata extends AnimationMetadata {
options: AnimationOptions | null; options: AnimationOptions | null;
steps: AnimationMetadata[]; steps: AnimationMetadata[];
} }
/** @experimental */
export interface AnimationStaggerMetadata extends AnimationMetadata { export interface AnimationStaggerMetadata extends AnimationMetadata {
animation: AnimationMetadata | AnimationMetadata[]; animation: AnimationMetadata | AnimationMetadata[];
timings: string | number; timings: string | number;
} }
/** @experimental */
export interface AnimationStateMetadata extends AnimationMetadata { export interface AnimationStateMetadata extends AnimationMetadata {
name: string; name: string;
options?: { options?: {
@ -160,7 +141,6 @@ export interface AnimationStateMetadata extends AnimationMetadata {
styles: AnimationStyleMetadata; styles: AnimationStyleMetadata;
} }
/** @experimental */
export interface AnimationStyleMetadata extends AnimationMetadata { export interface AnimationStyleMetadata extends AnimationMetadata {
offset: number | null; offset: number | null;
styles: '*' | { styles: '*' | {
@ -170,7 +150,6 @@ export interface AnimationStyleMetadata extends AnimationMetadata {
} | '*'>; } | '*'>;
} }
/** @experimental */
export interface AnimationTransitionMetadata extends AnimationMetadata { export interface AnimationTransitionMetadata extends AnimationMetadata {
animation: AnimationMetadata | AnimationMetadata[]; animation: AnimationMetadata | AnimationMetadata[];
expr: string | ((fromState: string, toState: string, element?: any, params?: { expr: string | ((fromState: string, toState: string, element?: any, params?: {
@ -179,7 +158,6 @@ export interface AnimationTransitionMetadata extends AnimationMetadata {
options: AnimationOptions | null; options: AnimationOptions | null;
} }
/** @experimental */
export interface AnimationTriggerMetadata extends AnimationMetadata { export interface AnimationTriggerMetadata extends AnimationMetadata {
definitions: AnimationMetadata[]; definitions: AnimationMetadata[];
name: string; name: string;
@ -190,13 +168,10 @@ export interface AnimationTriggerMetadata extends AnimationMetadata {
} | null; } | null;
} }
/** @experimental */
export declare const AUTO_STYLE = "*"; export declare const AUTO_STYLE = "*";
/** @experimental */
export declare function group(steps: AnimationMetadata[], options?: AnimationOptions | null): AnimationGroupMetadata; export declare function group(steps: AnimationMetadata[], options?: AnimationOptions | null): AnimationGroupMetadata;
/** @experimental */
export declare function keyframes(steps: AnimationStyleMetadata[]): AnimationKeyframesSequenceMetadata; export declare function keyframes(steps: AnimationStyleMetadata[]): AnimationKeyframesSequenceMetadata;
/** @experimental */ /** @experimental */
@ -219,30 +194,24 @@ export declare class NoopAnimationPlayer implements AnimationPlayer {
setPosition(p: number): void; setPosition(p: number): void;
} }
/** @experimental */
export declare function query(selector: string, animation: AnimationMetadata | AnimationMetadata[], options?: AnimationQueryOptions | null): AnimationQueryMetadata; export declare function query(selector: string, animation: AnimationMetadata | AnimationMetadata[], options?: AnimationQueryOptions | null): AnimationQueryMetadata;
/** @experimental */
export declare function sequence(steps: AnimationMetadata[], options?: AnimationOptions | null): AnimationSequenceMetadata; export declare function sequence(steps: AnimationMetadata[], options?: AnimationOptions | null): AnimationSequenceMetadata;
/** @experimental */
export declare function stagger(timings: string | number, animation: AnimationMetadata | AnimationMetadata[]): AnimationStaggerMetadata; export declare function stagger(timings: string | number, animation: AnimationMetadata | AnimationMetadata[]): AnimationStaggerMetadata;
/** @experimental */
export declare function state(name: string, styles: AnimationStyleMetadata, options?: { export declare function state(name: string, styles: AnimationStyleMetadata, options?: {
params: { params: {
[name: string]: any; [name: string]: any;
}; };
}): AnimationStateMetadata; }): AnimationStateMetadata;
/** @experimental */
export declare function style(tokens: '*' | { export declare function style(tokens: '*' | {
[key: string]: string | number; [key: string]: string | number;
} | Array<'*' | { } | Array<'*' | {
[key: string]: string | number; [key: string]: string | number;
}>): AnimationStyleMetadata; }>): AnimationStyleMetadata;
/** @experimental */
export declare function transition(stateChangeExpr: string | ((fromState: string, toState: string, element?: any, params?: { export declare function transition(stateChangeExpr: string | ((fromState: string, toState: string, element?: any, params?: {
[key: string]: any; [key: string]: any;
}) => boolean), steps: AnimationMetadata | AnimationMetadata[], options?: AnimationOptions | null): AnimationTransitionMetadata; }) => boolean), steps: AnimationMetadata | AnimationMetadata[], options?: AnimationOptions | null): AnimationTransitionMetadata;
@ -250,5 +219,4 @@ export declare function transition(stateChangeExpr: string | ((fromState: string
/** @experimental */ /** @experimental */
export declare function trigger(name: string, definitions: AnimationMetadata[]): AnimationTriggerMetadata; export declare function trigger(name: string, definitions: AnimationMetadata[]): AnimationTriggerMetadata;
/** @experimental */
export declare function useAnimation(animation: AnimationReferenceMetadata, options?: AnimationOptions | null): AnimationAnimateRefMetadata; export declare function useAnimation(animation: AnimationReferenceMetadata, options?: AnimationOptions | null): AnimationAnimateRefMetadata;