Collapse

Collapseは、要素を展開または折りたたんで表示するコンポーネントです。

クリリンのことか……クリリンのことかーーーっ！！！！！

const [open, { toggle }] = useBoolean()

return (
  <VStack align="flex-start" gap="0">
    <Button onClick={toggle}>Please Click</Button>

    <Collapse open={open}>
      <Box borderWidth={1} mt="lg" p="md" rounded="l2" w="full">
        クリリンのことか……クリリンのことかーーーっ！！！！！
      </Box>
    </Collapse>
  </VStack>
)

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

使い方

import { Collapse } from "@yamada-ui/react"

import { Collapse } from "@/components/ui"

import { Collapse } from "@workspaces/ui"

<Collapse />

所要時間を変更する

所要時間を変更する場合は、durationに数値(秒)を設定します。

クリリンのことか……クリリンのことかーーーっ！！！！！

const [open, { toggle }] = useBoolean()

return (
  <VStack align="flex-start" gap="0">
    <Button onClick={toggle}>Please Click</Button>

    <Collapse open={open} duration={0.7}>
      <Box borderWidth={1} mt="lg" p="md" rounded="l2" w="full">
        クリリンのことか……クリリンのことかーーーっ！！！！！
      </Box>
    </Collapse>
  </VStack>
)

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

非表示時にアンマウントする

非表示時にアンマウントする場合は、unmountOnExitをtrueに設定します。

私の戦闘力は530000です。ですがもちろんフルパワーであなたと戦う気はありませんからご心配なく……

const [open, { toggle }] = useBoolean()

return (
  <VStack align="flex-start" gap="0">
    <Button onClick={toggle}>Please Click</Button>

    <Collapse open={open} unmountOnExit>
      <Box borderWidth={1} mt="lg" p="md" rounded="l2" w="full">
        クリリンのことか……クリリンのことかーーーっ！！！！！
      </Box>
    </Collapse>

    <Box borderWidth={1} mt="md" p="md" rounded="l2" w="full">
      私の戦闘力は530000です。ですがもちろんフルパワーであなたと戦う気はありませんからご心配なく……
    </Box>
  </VStack>
)

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

不透明度を無効にする

不透明度を無効にする場合は、animationOpacityをfalseに設定します。

クリリンのことか……クリリンのことかーーーっ！！！！！

私の戦闘力は530000です。ですがもちろんフルパワーであなたと戦う気はありませんからご心配なく……

const [open, { toggle }] = useBoolean()

return (
  <VStack align="flex-start" gap="0">
    <Button onClick={toggle}>Please Click</Button>

    <Collapse animationOpacity={false} open={open}>
      <Box borderWidth={1} mt="lg" p="md" rounded="l2" w="full">
        クリリンのことか……クリリンのことかーーーっ！！！！！
      </Box>
    </Collapse>

    <Box borderWidth={1} mt="lg" p="md" rounded="l2" w="full">
      私の戦闘力は530000です。ですがもちろんフルパワーであなたと戦う気はありませんからご心配なく……
    </Box>
  </VStack>
)

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

高さに初期値を追加する

高さに初期値を追加する場合は、startingHeightに文字列または数値を設定します。

私の戦闘力は530000です。
ですがもちろんフルパワーであなたと戦う気はありませんからご心配なく……

const [open, { toggle }] = useBoolean()

return (
  <VStack alignItems="flex-start">
    <Button onClick={toggle}>Please Click</Button>

    <Collapse open={open} startingHeight={23}>
      <Box>
        私の戦闘力は530000です。
        <br />
        ですがもちろんフルパワーであなたと戦う気はありませんからご心配なく……
      </Box>
    </Collapse>
  </VStack>
)

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

Props

Prop	デフォルト	型 / 説明
`as`	-	`keyof IntrinsicElements` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`enter`	-	`any` Custom `enter`.
`exit`	-	`any` Custom `exit`. A target to animate to when this component is removed from the tree. This component must be the first animatable child of an `AnimatePresence` to enable this exit animation. This limitation exists because React doesn't allow components to defer unmounting until after an animation is complete. Once this limitation is fixed, the `AnimatePresence` component will be unnecessary.
`initial`	-	`any` Custom `initial`. Properties, variant label or array of variant labels to start in. Set to `false` to initialise with the values in `animate` (disabling the mount animation)
`animationOpacity`	`true`	`boolean` If `true`, the opacity of the content will be animated.
`delay`	`0`	`MotionLifecycleProps<number> \| number` Custom `delay` definition for `enter` and `exit`.
`duration`	`0.2`	`MotionLifecycleProps<number> \| number` Custom `duration` definition for `enter` and `exit`.
`endingHeight`	`"auto"`	`number \| string` The height you want the content in its expanded state.
`open`	-	`boolean` Show the component. triggers when enter or exit states.
`startingHeight`	`0`	`number \| string` The height you want the content in its collapsed state.
`transition`	-	`MotionLifecycleProps<Transition>` Custom `transition` definition for `enter` and `exit`.
`transitionEnd`	-	`MotionLifecycleProps<ResolvedValues>` Custom `transitionEnd` definition for `enter` and `exit`.
`unmountOnExit`	-	`boolean` If `true`, the element will unmount when `open={false}` and animation is done.

類似のコンポーネント

Fadeは、要素を次第に表示または非表示にするコンポーネントです。

FadeScaleは、要素を次第に拡大して表示または縮小して非表示にするコンポーネントです。

Slideは、要素をページの隅から表示または非表示にするコンポーネントです。

SlideFadeは、要素を指定位置から移動しながら次第に表示または非表示にするコンポーネントです。

Accordionは、情報を展開または折りたたんで表示するリストのコンポーネントです。

Airyは、２つの要素をふわっと切り替えるアニメーションを提供するコンポーネントです。

Drawerは、画面の端から表示されるパネルのコンポーネントです。

Flipは、２つの要素をフリップさせながら切り替えるアニメーションを提供するコンポーネントです。

使用しているコンポーネント・フック

Motionは、MotionにYamada UIのStyle Propsを拡張した便利なコンポーネントです。

使用されているコンポーネント・フック

Accordionは、情報を展開または折りたたんで表示するリストのコンポーネントです。