Skip to content

Commit

Permalink
docs(useBakedTransition, useGenericTransition): add tsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
StevenJPx2 committed Jan 3, 2024
1 parent 0dbe5a1 commit 267df27
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/runtime/composables/transitions/baked.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ export type UseBakedTransitionOptions = Simplify<
} & UseConstructTransitionOptions
>;

/**
* Composable to create baked transitions
*/
export function useBakedTransition(
options: UseBakedTransitionOptions,
): TransitionOutput {
Expand Down
5 changes: 5 additions & 0 deletions src/runtime/composables/transitions/bendy-wendy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ export type BendyWendyOptions = Simplify<
} & Omit<UseConstructTransitionOptions, "parentContainer">
>;

/**
* Composable to create bendy wendy transitions
* @remarks
* This transition uses the `path` element to create a bendy wendy animation; it's a bit like a liquid animation.
*/
export function useBendyWendyTransition(
options: BendyWendyOptions,
): TransitionOutput {
Expand Down
6 changes: 6 additions & 0 deletions src/runtime/composables/transitions/generic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export type UseGenericTransitionOptions = Simplify<
>;
/**
* Composable to create generic transitions
* @remarks
* - This transition uses the `from` and `to` variables to animate
* - The enter and leave will be the same, just in reverse
* - The `from` is the initial and end, `to` is the entered state
* - to have separate durations and ease for enter and exit, adjust `to` for entry, and `from` for exit
* @see {@link useBakedTransition}for a transition that uses this composable
*/
export function useGenericTransition(
options: UseGenericTransitionOptions,
Expand Down

0 comments on commit 267df27

Please sign in to comment.