Skip to content
홈으로

AI용 문서

구조화된 형식으로 AI가 효율적으로 처리할 수 있는 문서

이 문서는 YAML 형식으로 구조화되어 있어 AI 어시스턴트(Claude, GPT 등)가 패키지 정보를 빠르게 파악하고 코드를 생성할 수 있습니다.

제공 문서

@hua-labs/hua-ux

hua-ux.ai.yaml

@hua-labs/ui

ui.ai.yaml

@hua-labs/motion-core

motion-core.ai.yaml

@hua-labs/i18n-core

i18n-core.ai.yaml

문서 형식

YAML 구조

AI가 쉽게 파싱할 수 있도록 일관된 YAML 스키마를 사용합니다.

package:

패키지 메타데이터

exports:

내보내기 경로 및 항목

hooks:

Hook API 문서

usage:

설치 및 사용 예제

예시: @hua-labs/hua-ux

yaml
# @hua-labs/hua-ux - AI Documentation
# Version: 0.1.0-alpha.12
# Last Updated: 2026-01-12

package:
  name: "@hua-labs/hua-ux"
  version: "0.1.0-alpha.12"
  description: "Ship UX faster: UI + Motion + i18n, pre-wired"
  category: "framework"
  license: "MIT"

exports:
  main:
    path: "@hua-labs/hua-ux"
    provides:
      - Button
      - Card
      - Badge
      - Input
      - Modal
      - useTranslation
      - useLanguageChange

  framework:
    path: "@hua-labs/hua-ux/framework"
    provides:
      - HuaUxLayout
      - useMotion
      - useBranding
      - SkipToContent

  server:
    path: "@hua-labs/hua-ux/framework/server"
    provides:
      - getSSRTranslations

  config:
    path: "@hua-labs/hua-ux/framework/config"
    provides:
      - defineConfig
      - setConfig

usage:
  installation:
    command: "npm install @hua-labs/hua-ux"
    peer_dependencies:
      - "react@>=18"
      - "next@>=14"

  basic_example: |
    import { Button, useTranslation } from '@hua-labs/hua-ux';
    import { useMotion } from '@hua-labs/hua-ux/framework';

    function Component() {
      const { t } = useTranslation();
      const motion = useMotion({ type: 'fadeIn' });

      return (
        <div ref={motion.ref} style={motion.style}>
          <Button>{t('click_me')}</Button>
        </div>
      );
    }

hooks:
  useMotion:
    description: "Animation hook wrapping motion-core"
    parameters:
      - name: "options"
        type: "UseMotionOptions"
        required: true
        properties:
          - name: "type"
            type: "EntranceType"
            values: ["fadeIn", "slideUp", "slideDown", "scale"]
          - name: "duration"
            type: "number"
            default: 300
          - name: "delay"
            type: "number"
            default: 0
    returns:
      - name: "ref"
        type: "RefObject"
      - name: "style"
        type: "CSSProperties"
      - name: "start"
        type: "() => void"
      - name: "reset"
        type: "() => void"

  useTranslation:
    description: "Translation hook for i18n"
    returns:
      - name: "t"
        type: "(key: string) => string"
      - name: "currentLanguage"
        type: "string"
      - name: "isLoading"
        type: "boolean"

dependencies:
  internal:
    - "@hua-labs/ui"
    - "@hua-labs/motion-core"
    - "@hua-labs/i18n-core"
    - "@hua-labs/i18n-core-zustand"
    - "@hua-labs/state"
  external:
    - "react"
    - "next"
    - "zustand"

compatibility:
  react: ">=18.0.0"
  next: ">=14.0.0"
  node: ">=18.0.0"

keywords:
  - hua-ux
  - react
  - framework
  - ui
  - motion
  - i18n
  - ssr
  - next.js

AI와 함께 사용하기

AI 어시스턴트에게 이 문서를 제공하면 더 정확한 코드를 생성할 수 있습니다.

프롬프트 예시:

"다음 hua-ux 문서를 참고해서 로그인 페이지를 만들어줘: [YAML 문서 붙여넣기]"

AI Context로 사용:

.claude/project-context.md 또는 .cursorrules에 추가하면 프로젝트 전체에서 참조됩니다.