TG Sticker Creator Documentation

Index

Enumerations

Interfaces

Type Aliases

Variables

Functions

optimizeFilesize

Type Aliases

CancellableCallback

CancellableCallback<T>: ((item: T, cancel: (() => void), parents: LottieItem[]) => void)

Type Parameters

Type declaration

- (item: T, cancel: (() => void), parents: LottieItem[]): void
- Parameters
  - item: T
  - cancel: (() => void)
    - - (): void
      - Returns void
  - parents: LottieItem[]
  Returns void

Coordinate

Coordinate: [number, number]

[x, y]

Easing

Easing: EasingArray | EasingName

Either a predefined easing name or a custom bezier easing encoded as array: [x1, y1, x2, y2]

EasingArray

EasingArray: [number, number, number, number]

EasingName

Easing presets collected from https://github.com/ai/easings.net/blob/master/src/easings.yml, MDN and Chrome DevTools

JsonArray

JsonArray: JsonValue[]

object without any non-serializable values

JsonObject

JsonObject: {}

object without any non-serializable values

Type declaration

[idx: string]: JsonValue

JsonValue

object without any non-serializable values

RandomizableValue

RandomizableValue: number | { max: number; min: number }

Exact value or range

Variables

Const create

create: { animatablePath: { (path: Path): AnimatablePath; (inPoints: Coordinate[], outPoints: Coordinate[], vertices: Coordinate[], closed: boolean): AnimatablePath }; animation: { blink: (<T, C>(animatable: T, __namedParameters: C) => T); particles: ((shape: Shape, options: Partial<ParticleAnimationOptions>) => GroupShape) }; color: { (red: number, green: number, blue: number, alpha: number): AnimatableColor; (colorNameOrHexValue: string): AnimatableColor; (rgba: RgbaValue): AnimatableColor }; gradient: ((stops: RgbaStopValue[]) => AnimatableGradient); value: { (value: number | [number]): Animatable1DValue; (value: Coordinate): Animatable2DValue; (x: number, y: number): AnimatablePosition }; compLayer: any; ellipse: any; fill: any; gradientFill: any; gradientStroke: any; group: any; layerTransform: any; mask: any; merge: any; nullLayer: any; path: any; pathValue: any; preComp: any; rect: any; repeater: any; rgba: any; roundedCorners: any; shapeLayer: any; solidLayer: any; star: any; sticker: any; stickerFromPlain: any; stickerFromTgs: any; stop: any; stroke: any; transform: any; trim: any } = ...

Type declaration

animatablePath: { (path: Path): AnimatablePath; (inPoints: Coordinate[], outPoints: Coordinate[], vertices: Coordinate[], closed: boolean): AnimatablePath }
- - (path: Path): AnimatablePath
  - (inPoints: Coordinate[], outPoints: Coordinate[], vertices: Coordinate[], closed: boolean): AnimatablePath
  - Parameters
    - path: Path
    Returns AnimatablePath
  - Parameters
    - inPoints: Coordinate[]
    - outPoints: Coordinate[]
    - vertices: Coordinate[]
    - closed: boolean
    Returns AnimatablePath
animation: { blink: (<T, C>(animatable: T, __namedParameters: C) => T); particles: ((shape: Shape, options: Partial<ParticleAnimationOptions>) => GroupShape) }
- blink: (<T, C>(animatable: T, __namedParameters: C) => T)
  - - <T, C>(animatable: T, __namedParameters: C): T
    - Type Parameters
      - T extends AnimatableValue<any, any, T>
      - C extends BlinkAnimationOptions<Parameters<T["addKeyframe"]>["1"], C>
      Parameters
      - animatable: T
      - __namedParameters: C
      Returns T
- particles: ((shape: Shape, options: Partial<ParticleAnimationOptions>) => GroupShape)
  - - (shape: Shape, options: Partial<ParticleAnimationOptions>): GroupShape
    - Uses shape as template for a particle
      
      Parameters
      - shape: Shape
      - options: Partial<ParticleAnimationOptions>
      Returns GroupShape
color: { (red: number, green: number, blue: number, alpha: number): AnimatableColor; (colorNameOrHexValue: string): AnimatableColor; (rgba: RgbaValue): AnimatableColor }
- - (red: number, green: number, blue: number, alpha: number): AnimatableColor
  - (colorNameOrHexValue: string): AnimatableColor
  - (rgba: RgbaValue): AnimatableColor
  - Parameters
    - red: number
      
      0-1
    - green: number
      
      0-1
    - blue: number
      
      0-1
    - alpha: number
      
      0-1
    Returns AnimatableColor
  - Parameters
    - colorNameOrHexValue: string
    Returns AnimatableColor
  - Parameters
    - rgba: RgbaValue
    Returns AnimatableColor
gradient: ((stops: RgbaStopValue[]) => AnimatableGradient)
- - (stops: RgbaStopValue[]): AnimatableGradient
  - Parameters
    - stops: RgbaStopValue[]
    Returns AnimatableGradient
value: { (value: number | [number]): Animatable1DValue; (value: Coordinate): Animatable2DValue; (x: number, y: number): AnimatablePosition }
- - (value: number | [number]): Animatable1DValue
  - (value: Coordinate): Animatable2DValue
  - (x: number, y: number): AnimatablePosition
  - Parameters
    - value: number | [number]
    Returns Animatable1DValue
  - Parameters
    - value: Coordinate
    Returns Animatable2DValue
  - Parameters
    - x: number
    - y: number
    Returns AnimatablePosition
compLayer:function
- compLayer(referenceId?: string): CompLayer
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:88
  Parameters
  - Optional referenceId: string
  Returns CompLayer
ellipse:function
- ellipse(): EllipseShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:43
  Returns EllipseShape
fill:function
- fill(): FillShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:46
  Returns FillShape
gradientFill:function
- gradientFill(): GradientFillShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:49
  Returns GradientFillShape
gradientStroke:function
- gradientStroke(): GradientStrokeShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:52
  Returns GradientStrokeShape
group:function
- group(): GroupShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:55
  Returns GroupShape
layerTransform:function
- layerTransform(): LayerTransform
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:106
  Returns LayerTransform
mask:function
- mask(): Mask
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:109
  Returns Mask
merge:function
- merge(): MergeShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:58
  Returns MergeShape
nullLayer:function
- nullLayer(): NullLayer
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:91
  Returns NullLayer
path:function
- path(): PathShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:61
  Returns PathShape
pathValue:function
- pathValue(): Path
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:120
  Returns Path
preComp:function
- preComp(): PreComp
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:103
  Returns PreComp
rect:function
- rect(): RectShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:64
  Returns RectShape
repeater:function
- repeater(): RepeaterShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:67
  Returns RepeaterShape
rgba:function
- rgba(color: string | Instance): RgbaValue
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:116
  Parameters
  - color: string | Instance
  Returns RgbaValue
roundedCorners:function
- roundedCorners(): RoundedCornersShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:70
  Returns RoundedCornersShape
shapeLayer:function
- shapeLayer(): ShapeLayer
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:94
  Returns ShapeLayer
solidLayer:function
- solidLayer(): SolidLayer
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:97
  Returns SolidLayer
star:function
- star(): StarShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:73
  Returns StarShape
sticker:function
- sticker(): Lottie
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:126
  Returns Lottie
stickerFromPlain:function
- stickerFromPlain(obj: JsonObject): Lottie
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:129
  Parameters
  - obj: JsonObject
  Returns Lottie

stickerFromTgs:function

stickerFromTgs(obj: string | JsonObject): Lottie

Does not decompress obj

// example usage
import pako from "pako";
const output = pako.inflate(new Uint8Array(await tgsBlob.arrayBuffer()));
const text = new TextDecoder().decode(output);
const animation = create.stickerFromTgs(text);

Parameters

obj: string | JsonObject

Returns Lottie

stop:function
- stop(color: string | Instance, stop: number): RgbaStopValue
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:112
  Parameters
  - color: string | Instance
  - stop: number
  Returns RgbaStopValue
stroke:function
- stroke(): StrokeShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:82
  Returns StrokeShape
transform:function
- transform(): TransformShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:76
  Returns TransformShape
trim:function
- trim(): TrimShape
- - Defined in packages/tg-sticker-creator/src/utilities/create.ts:79
  Returns TrimShape

Const easings

easings: { [ name in EasingName]: EasingArray } = ...

Easings

Bezier handles encoded as [x1, y1, x2, y2] - the same as cubic-bezier(x1, y1, x2, y2) in css

Const enums

enums: { BlendMode: typeof BlendMode; FillRule: typeof FillRule; GradientType: typeof GradientType; LayerType: typeof LayerType; LineCap: typeof LineCap; LineJoin: typeof LineJoin; MaskMode: typeof MaskMode; MatteMode: typeof MatteMode; MergeMode: typeof MergeMode; ShapeType: typeof ShapeType; StarType: typeof StarType; TrimMultiple: typeof TrimMultiple } = ...

All enums as single variable for easier importing

Type declaration

BlendMode: typeof BlendMode
FillRule: typeof FillRule
GradientType: typeof GradientType
LayerType: typeof LayerType
LineCap: typeof LineCap
LineJoin: typeof LineJoin
MaskMode: typeof MaskMode
MatteMode: typeof MatteMode
MergeMode: typeof MergeMode
ShapeType: typeof ShapeType
StarType: typeof StarType
TrimMultiple: typeof TrimMultiple

Functions

optimizeFilesize

optimizeFilesize(sticker: Lottie, options?: Partial<OptimizeFilesizeOptions>): Lottie

- Defined in packages/tg-sticker-creator/src/utilities/optimize.ts:41
Parameters
- sticker: Lottie
- options: Partial<OptimizeFilesizeOptions> = {}
Returns Lottie

Index

Enumerations

Classes Errors

Classes Layers

Classes Other

Classes Shapes

Classes Values

Interfaces

Type Aliases

Variables

Functions

Type Aliases

CancellableCallback

Type Parameters

T

Type declaration

Parameters

item: T

cancel: (() => void)

Returns void

parents: LottieItem[]

Returns void

Coordinate

Easing

EasingArray

EasingName

JsonArray

JsonObject

Type declaration

[idx: string]: JsonValue

JsonValue

RandomizableValue

Variables

Const create

Type declaration

animatablePath: { (path: Path): AnimatablePath; (inPoints: Coordinate[], outPoints: Coordinate[], vertices: Coordinate[], closed: boolean): AnimatablePath }

Parameters

path: Path

Returns AnimatablePath

Parameters

inPoints: Coordinate[]

outPoints: Coordinate[]

vertices: Coordinate[]

closed: boolean

Returns AnimatablePath

animation: { blink: (<T, C>(animatable: T, __namedParameters: C) => T); particles: ((shape: Shape, options: Partial<ParticleAnimationOptions>) => GroupShape) }

blink: (<T, C>(animatable: T, __namedParameters: C) => T)

Type Parameters

T extends AnimatableValue<any, any, T>

C extends BlinkAnimationOptions<Parameters<T["addKeyframe"]>["1"], C>

Parameters

animatable: T

__namedParameters: C

Returns T

particles: ((shape: Shape, options: Partial<ParticleAnimationOptions>) => GroupShape)

Parameters

shape: Shape

options: Partial<ParticleAnimationOptions>

Returns GroupShape

color: { (red: number, green: number, blue: number, alpha: number): AnimatableColor; (colorNameOrHexValue: string): AnimatableColor; (rgba: RgbaValue): AnimatableColor }

Parameters

red: number

green: number

blue: number

alpha: number

Returns AnimatableColor

Parameters

colorNameOrHexValue: string

Returns AnimatableColor

Parameters

rgba: RgbaValue

Returns AnimatableColor

gradient: ((stops: RgbaStopValue[]) => AnimatableGradient)

Parameters

stops: RgbaStopValue[]

Returns AnimatableGradient

value: { (value: number | [number]): Animatable1DValue; (value: Coordinate): Animatable2DValue; (x: number, y: number): AnimatablePosition }

Parameters

value: number | [number]

Returns Animatable1DValue