Animation — Kuito Documentation

Usage

Overlay a now-playing caption

This type is used by Blur

tsx

import { Blur, Image, Text, VStack } from 'kuito';

export default function NowPlaying() {
  return (
    <VStack flex={1}>
      <Image
        src="https://example.com/cover.jpg"
        position="absolute"
        top={0}
        left={0}
        right={0}
        bottom={0}
      />
      <Blur material="thin" position="absolute" bottom={0} left={0} right={0} padding={16}>
        <Text>Now playing</Text>
      </Blur>
    </VStack>
  );
}

Type declaration

export interface Animation<T = number> {
  /** Where it comes to rest; without one, the prop or transition says. */
  readonly target?: T | readonly number[];
  readonly __kuitoAnimation: AnimationSpec;
  readonly onEnd?: AnimationCallback;
  /**
   * The same animation toward `target`. Several numbers are snap points: a
   * release goes to the one nearest where the throw would land.
   */
  to<U extends number | string>(
    target: U | readonly number[],
  ): Animation<U extends number ? number : string>;
}

Members 3

Name	Type	Required	Description
`target`readonly	`T \| readonly number[]`	No	Where it comes to rest; without one, the prop or transition says.
`onEnd`readonly	`AnimationCallback`	No	—
`to`	`<U extends number \| string>(target: U \| readonly number[]) => Animation<U extends number ? number : string>`	Yes	The same animation toward `target`. Several numbers are snap points: a release goes to the one nearest where the throw would land.

onEnd — method signatures

Signatures

(finished: boolean): void

Parameters

Name	Type	Required	Description
`finished`	`boolean`	Yes	—

Returns

void

to — method signatures

Signatures

<U extends number | string>(target: U | readonly number[]): Animation<U extends number ? number : string>

Type parameters

Name	Constraint	Default
`U`	`string \| number`	—

Parameters

Name	Type	Required	Description
`target`	`readonly number[] \| U`	Yes	—

Returns

Animation<U extends number ? number : string>

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.