Deploy website - based on 8fc27a2

NaveOWO · Jan 3, 2024 · 50a1942 · 50a1942
1 parent 8fc27a2
commit 50a1942
Show file tree

Hide file tree

Showing 27 changed files with 15,655 additions and 0 deletions.
diff --git a/my-website/.gitignore b/my-website/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/my-website/README.md b/my-website/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/my-website/babel.config.js b/my-website/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/my-website/docs/01-Overview/Introduce.md b/my-website/docs/01-Overview/Introduce.md
@@ -0,0 +1,32 @@
+### navrary-ck-util-components
+
+웹 어플리케이션이서 범용적으로 사용되는 컴포넌트 UI를 제공하는 UI라이브러리 입니다.
+
+### Characteristics
+
+- **Flexible Styling**
+
+  CSS-in-JS 라이브러리와 CSS-in-CSS 모두를 이용하여 컴포넌트의 스타일을 유연하게 조정할 수 있도록 해줍니다.
+
+- **Reusability**
+
+  재사용 가능한 컴포넌트들을 제공하여 개발자가 코드를 더 간결하고 효율적으로 작성할 수 있도록 돕습니다.
+
+- **Component Interactions**
+
+  컴포넌트 간의 상호 작용을 쉽게 구현할 수 있는 API를 제공 합니다.
+
+- **Built-in Components**
+
+  다양한 UI 컴포넌트를 제공 합니다.
+
+### Version
+
+```sh
+1.4.0
+```
+
+### Upcoming
+
+- 웹 접근성을 위한 옵션
+- 추가적인 Built-in-components (Dropdown, Tooltip, Popover ...)
diff --git a/my-website/docs/01-Overview/Start.md b/my-website/docs/01-Overview/Start.md
@@ -0,0 +1,13 @@
+### Install
+
+**npm**
+
+```sh
+npm install navrary-ck-util-components
+```
+
+**yarn**
+
+```sh
+yarn add navrary-ck-util-components
+```
diff --git a/my-website/docs/02-Components/Checkbox.md b/my-website/docs/02-Components/Checkbox.md
@@ -0,0 +1,39 @@
+### Checkbox
+
+사용자에게 선택 옵션을 제공하고, 사용자가 옵션을 선택하거나 선택을 해제할 수 있는 컴포넌트 입니다.
+
+### Basic Usage
+
+```jsx
+<Checkbox>
+  <Checkbox.Indicator />
+  <Checkbox.Label>checkbox</Checkbox.Label>
+</Checkbox>
+```
+
+### API
+
+**Checkbox**
+
+| Prop           | Type                   | Default | Description                                                        |
+| -------------- | ---------------------- | ------- | ------------------------------------------------------------------ |
+| externalCheck? | `boolean`              | -       | external checked state                                             |
+| defalutCheck?  | `T = any`              | -       | default checked state                                              |
+| onCheckChange? | `(option : T) => void` | -       | external checked setState. should be accompanied by externalCheck. |
+| id             | `T = any`              | -       | The props used to identify an option.                              |
+
+**Indicator**
+
+| Prop              | Type                      | Default | Description                                                                                           |
+| ----------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?          | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?        | `string`                  | -       | styling props for target component                                                                    |
+| onIndicatorClick? | `(e: MouseEvent) => void` | -       | external function to control indicator component.                                                     |
+
+**Label**
+
+| Prop          | Type                      | Default | Description                                                                                           |
+| ------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?      | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?    | `string`                  | -       | styling props for target component                                                                    |
+| onLabelClick? | `(e: MouseEvent) => void` | -       | external function to control label component.                                                         |
diff --git a/my-website/docs/02-Components/Dialog.md b/my-website/docs/02-Components/Dialog.md
@@ -0,0 +1,47 @@
+### Dialog
+
+사용자에게 특정 작업을 수행하거나 추가 정보를 제공하기 위해 화면 상에 일시적으로 띄워지는 컴포넌트 입니다.
+
+### Basic Usage
+
+```jsx
+<Dialog>
+  <Dialog.Trigger />
+  <Dialog.BackDrop />
+  <Dialog.Content>content</Dialog.Content>
+</Dialog>
+```
+
+### API
+
+**Dialog**
+
+| Prop          | Type         | Default | Description                                                    |
+| ------------- | ------------ | ------- | -------------------------------------------------------------- |
+| externalOpen? | `boolean`    | -       | external open state                                            |
+| defaultOpen?  | `boolean`    | -       | default open state                                             |
+| onOpenChange? | `() => void` | -       | external open setState. should be accompanied by externalOpen. |
+
+**Trigger**
+
+| Prop           | Type                      | Default | Description                                                                                           |
+| -------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?       | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?     | `string`                  | -       | styling props for target component                                                                    |
+| onTriggerClick | `(e: MouseEvent) => void` | -       | external function to control trigger component.                                                       |
+
+**BackDrop**
+
+| Prop            | Type                      | Default | Description                                                                                           |
+| --------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?        | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?      | `string`                  | -       | styling props for target component                                                                    |
+| onBackDropClick | `(e: MouseEvent) => void` | -       | external function to control backdrop component.                                                      |
+
+**Content**
+
+| Prop        | Type                  | Default | Description                                                                                           |
+| ----------- | --------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?    | `boolean` `undefined` | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?  | `string`              | -       | styling props for target component                                                                    |
+| closeOnEsc? | `boolean`             | -       | The option to determine whether the modal should close when the 'ESC' key is pressed.                 |
diff --git a/my-website/docs/02-Components/Select.md b/my-website/docs/02-Components/Select.md
@@ -0,0 +1,63 @@
+### Select
+
+사용자가 여러 옵션 중 하나를 선택할 수 있도록 하는 컴포넌트 입니다.
+
+### Basic Usage
+
+```jsx
+<Select>
+  <Select.Trigger />
+  <Select.Value>apple</Select.Value>
+  <Select.OptionGroup>
+    <Select.Option id="orange">Orange</Select.Option>
+    <Select.Option id="apple">Apple</Select.Option>
+    <Select.Option id="grape">Grape</Select.Option>
+  </Select.OptionGroup>
+</Select>
+```
+
+### API
+
+**Select**
+
+| Prop                    | Type                   | Default | Description                                                                |
+| ----------------------- | ---------------------- | ------- | -------------------------------------------------------------------------- |
+| externalSelectedOption? | `T = any`              | -       | external select state                                                      |
+| defalutSelected?        | `T = any`              | -       | default select state                                                       |
+| onSelectChange?         | `(option : T) => void` | -       | external select setState. should be accompanied by externalSelectedOption. |
+| externalOpen?           | `boolean`              | -       | external open state                                                        |
+| defaultOpen?            | `boolean`              | -       | default open state                                                         |
+| onOpenChange?           | `() => void`           | -       | external open setState. should be accompanied by externalOpen.             |
+
+**Trigger**
+
+| Prop           | Type                      | Default | Description                                                                                           |
+| -------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?       | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?     | `string`                  | -       | styling props for target component                                                                    |
+| onTriggerClick | `(e: MouseEvent) => void` | -       | external function to control trigger component.                                                       |
+
+**OptionGroup**
+
+| Prop       | Type                  | Default | Description                                                                                           |
+| ---------- | --------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?   | `boolean` `undefined` | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className? | `string`              | -       | styling props for target component                                                                    |
+
+**Option**
+
+| Prop          | Type                      | Default | Description                                                                                           |
+| ------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?      | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?    | `string`                  | -       | styling props for target component                                                                    |
+| onOptionClick | `(e: MouseEvent) => void` | -       | external function to control option component.                                                        |
+| id            | `T = any`                 | -       | props used to identify an option.                                                                     |
+
+**Value**
+
+| Prop         | Type                      | Default | Description                                                                                           |
+| ------------ | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?     | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?   | `string`                  | -       | styling props for target component                                                                    |
+| options      | `Record<number, T = any>` | -       | external object to match option with specific value.                                                  |
+| defaultValue | `T = any`                 | -       | default value.                                                                                        |
diff --git a/my-website/docs/02-Components/Switch.md b/my-website/docs/02-Components/Switch.md
@@ -0,0 +1,41 @@
+### Switch
+
+활성화 또는 비활성화 상태를 전환할 수 있는 컴포넌트 입니다.
+
+### Basic Usage
+
+```jsx
+<Switch>
+  <Switch.Box>
+    <Switch.Thumb />
+  </Switch.Box>
+</Switch>
+```
+
+### API
+
+**Switch**
+
+| Prop          | Type                   | Default | Description                                                      |
+| ------------- | ---------------------- | ------- | ---------------------------------------------------------------- |
+| externalMode? | `boolean`              | -       | external switch state                                            |
+| defalutMode?  | `T = any`              | -       | default switch state                                             |
+| onModeChange? | `(option : T) => void` | -       | external swtich setState. should be accompanied by externalMode. |
+
+**Thumb**
+
+| Prop          | Type                      | Default | Description                                                                                           |
+| ------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?      | `boolean` `undefined`     | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?    | `string`                  | -       | styling props for target component                                                                    |
+| onThumbClick? | `(e: MouseEvent) => void` | -       | external function to control thumb component.                                                         |
+
+**Box**
+
+| Prop                            | Type                              | Default | Description                                                                                           |
+| ------------------------------- | --------------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| asChild?                        | `boolean` `undefined`             | false   | Change the default rendered element for the one passed as a child, merging their props and functions. |
+| className?                      | `string`                          | -       | styling props for target component                                                                    |
+| clickable?                      | `boolean`                         | -       |
+| Option to enable clickable box. |
+| onBoxClick?                     | `(e: MouseEvent) => void` `never` | -       | external function to control box component.                                                           |