README.md

ESC-UI

UI Library built in purpose to be used internally by Engineering Student Committee, Chulalongkorn University.

Installation

1. Install the package using your preferred package manager.

   # Using npm
   npm install esc-ui
   # Using yarn
   yarn add esc-ui
   # Using pnpm
   pnpm add esc-ui
   # Using bun
   bun add esc-ui

2. Import the CSS file in your layout file or files that aim to use the components.

   import 'esc-ui/css'

3. Done! You can now use the components in your project.

Components

• Accordion
• Alert Dialog
• Avatar
• Button
• Checkbox
• Collapsible
• Command
• Context Menu
• Dialog
• Dropdown Menu
• ESC Logo
• Hover Card
• Input
• Label
• Menubar
• Navigation Menu
• Popover
• Progress
• Radio Group
• Scroll Area
• Select
• Seperator
• Slider
• Switch
• Tabs
• Text Area
• Tooltip
• Typography

Please check the storybook for more information.

Contributing

Please read the CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.