# track-1-design-system

> track-1의 디자인 시스템 라이브러리

Latest version **0.1.5** (published 2023-12-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install track-1-design-system
pnpm add track-1-design-system
yarn add track-1-design-system
bun add track-1-design-system
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2023-12-30 |
| First published | 2023-12-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 31.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | seojisoo |
| Keywords | react, component, track-1, bottome-sheet, cover, button, check-box |

## Links

- npm: https://www.npmjs.com/package/track-1-design-system
- Repository: https://github.com/Track-1/design-system
- Homepage: https://github.com/Track-1/design-system#readme
- Issues: https://github.com/Track-1/design-system/issues
- npm.io page: https://npm.io/package/track-1-design-system

## Dependencies (9)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [framer-motion](https://npm.io/package/framer-motion.md) ^10.16.16
- [vite-plugin-svgr](https://npm.io/package/vite-plugin-svgr.md) ^4.2.0
- [react-modal-sheet](https://npm.io/package/react-modal-sheet.md) ^2.2.0
- [vite-plugin-babel](https://npm.io/package/vite-plugin-babel.md) ^1.2.0
- [vite-tsconfig-paths](https://npm.io/package/vite-tsconfig-paths.md) ^4.2.1
- [@radix-ui/react-dialog](https://npm.io/package/@radix-ui/react-dialog.md) ^1.0.5
- [@vanilla-extract/vite-plugin](https://npm.io/package/@vanilla-extract/vite-plugin.md) ^3.9.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.5 (latest) — 2023-12-30
- 0.1.4 — 2023-12-30
- 0.1.3 — 2023-12-29
- 0.1.2 — 2023-12-29
- 0.1.1 — 2023-12-27
- 0.1.0 — 2023-12-27
- 0.0.9 — 2023-12-26
- 0.0.8 — 2023-12-26
- 0.0.7 — 2023-12-26
- 0.0.6 — 2023-12-26
- 0.0.5 — 2023-12-26
- 0.0.4 — 2023-12-18
- 0.0.3 — 2023-12-18
- 0.0.2 — 2023-12-18
- 0.0.1 — 2023-12-18

## README

# Track-1-Design-system

Track-1의 디자인 시스템 라이브러리

## Features

- **Cover**: 앨범 커버 디자인
- **BottomSheet**: 바텀시트
- **Button**: 각종 버튼
- **CheckBox**: 체크박스

## Installation

```bash
yarn add track-1-design-system
```

## Usage

1. Cover

   ```js
   // props
   interface CoverProps {
     imageUrl: string;
     shape: "circle" | "rectangle" | "window";
     width: number;
     height: number;
     align?: "center" | "rightBottom";
     isPlay?: boolean;
     isBlur?: boolean;
     onPlay?: () => void;
   }
   ```

   ```js
   const [isPlay, setIsplay] = useState(false);

   function onPlay() {
     setIsplay((prev) => !prev);
   }

   return <Cover imageUrl="url" shape="circle" width={12} height={12} isPlay={isPlay} onPlay={onPlay} />;
   ```

2. BottomSheet

   ```js
   //props
   export interface BottomSheetProps extends PropsWithChildren<ComponentProps<typeof Sheet>> {
     header?: ReactNode;
     onClose: () => void;
   }
   ```

   ```js
   const [isOpen, setIsOpen] = useState(false);
   function onClose() {
     setIsOpen(false);
   }

   function onOpen() {
     setIsOpen(true);
   }

   return (
     <>
       <button type="button" onClick={onOpen}>
         클릭하여 바텀시트 열기
       </button>
       <BottomSheet isOpen={isOpen} onClose={onClose} header="Category">
         <>바텀시트</>
       </BottomSheet>
     </>
   );
   ```

3. Button

   ```js
   //props
   interface ButtonProps {
     children: ReactNode;
     size?: "small" | "middle" | "large";
     type?: "free" | "bottom";
     backgroundColor?: "purple" | "pink" | "green" | "grey";
     color?: "white" | "black" | "grey";
     disabled?: boolean;
     onClick?: () => void;
   }
   ```

   ```js
   <Button size="small" type="free" backgroundColor="purple" color="white" disable>
     button
   </Button>
   ```

4. CheckBox

   ```js
   // props
   export interface CheckBoxProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "size"> {
     checked?: boolean;
   }
   ```

   ```js
   const [checked, onChange] = useState < boolean > false;
   return <CheckBox checked={checked} onChange={(e) => onChange(e.target.checked)} />;
   ```

---
_Source: https://npm.io/package/track-1-design-system · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._