Leave Yamada UI a star

Star
Yamada UIYamada UIv1.6.4

Flip

Flip is a component that provides an animation to switch between two elements while flipping.

Source@yamada-ui/transitions

Props

FlipProps

from

Required

Description

Passing React elements to "from" is required.

Type

ReactElement<any, string | JSXElementConstructor<any>>

to

Required

Description

Passing React elements to "to" is required.

Type

ReactElement<any, string | JSXElementConstructor<any>>

as

Description

The HTML element to render.

Type

"symbol" | "object" | "clipPath" | "filter" | "g" | "marker" | "mask" | "p" | "text" | "style" | "animate" | "button" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | ... 149 more ... | "textPath"

colorScheme

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

defaultValue

Description

You can set the initial state.

Type

FlipIdent

Default

'from'

delay

Description

 The animation delay.

Type

number

Default

0

disabled

Description

If true, the component is disabled.

Type

boolean

Default

false

duration

Description

The animation duration.

Type

number

Default

0.4

isDisabled

Deprecated

Description

If true, the component is disabled.

Deprecated

Use disabled instead.

Type

boolean

Default

false

isReadOnly

Deprecated

Description

If true, the component is readonly.

Deprecated

Use readOnly instead.

Type

boolean

Default

false

onChange

Description

This is a callback function that is called when the animation state changes.

Type

(value: FlipIdent) => void

orientation

Description

The orientation of the flip effect. Determines whether the flip occurs horizontally or vertically.

Type

FlipOrientation

Default

'horizontal'

readOnly

Description

If true, the component is readonly.

Type

boolean

Default

false

size

Description

The size of the Flip.

Type

string

transition

Description

The animation transition.

Type

Transition$1

value

Description

Use this when you want to control the animation from outside the component.

Type

FlipIdent

variant

Description

The variant of the Flip.

Type

string

Edit this page on GitHub

PreviousFadeNextRotate