+
Skip to content

minjeongss/surff

Repository files navigation

Surff UI

NPM Badge Storybook Badge

Installation

To use Surff, Install the surff package and its peer dependencies(tailwindcss).

pnpm install surff tailwindcss
npm install surff tailwindcss
yarn add surff tailwindcss

Usage

Components

  • Modal
Attribute Type Default Optional Description
isOpen boolean X Control the visibility
onClose () => void X Callback function to handle modal close action
header ReactNode X Define the header content
body ReactNode X Define the main content
position 'top','center','bottom' 'center' O Define the position
  • Skeleton
Attribute Type Default Optional Description
width number 60 O Set up the width
height number 60 O Set up the height

Custom hooks

  • usePortal
  • useOnClickOutSide
  • useDisclosure
  • useFadeOutMotion

About

Simple React UI Design Library

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载