Skip to content
이 페이지의 내용

iztro-hook ​

iztro-hook은 iztro의 명반 작성과 운한 계산을 React 훅으로 제공합니다. useIztro로 데이터를 받아 명반, 표, 필터를 원하는 방식으로 구현할 수 있습니다. 완성된 대화형 명반을 삽입하려면 react-iztro를 사용하세요. React 밖에서는 iztro를 직접 사용할 수 있습니다.

설치 ​

sh
npm install iztro iztro-hook

아래 예제와 매개변수는 iztro-hook 1.3.5와 iztro 2.6.5를 기준으로 합니다.

명반과 운한 가져오기 ​

React 함수 컴포넌트나 커스텀 훅의 최상위에서 useIztro를 호출합니다. 첫 렌더링에서는 astrolabe와 horoscope가 모두 undefined일 수 있습니다. 결과를 표시하기 전에 데이터가 준비되었는지 확인하세요.

tsx
import React from 'react';
import { useIztro } from 'iztro-hook';

export default function App() {
  const { astrolabe, horoscope, setHoroscope } = useIztro({
    birthday: '2000-8-16',
    birthdayType: 'solar',
    birthTime: 2,
    gender: '여자',
    lang: 'ko-KR',
  });

  if (!astrolabe || !horoscope) {
    return <p>명반을 만드는 중…</p>;
  }

  return (
    <section>
      <p>음력 생년월일: {astrolabe.lunarDate}</p>
      <p>운한 조회 날짜: {horoscope.solarDate}</p>
      <p>유년 간지: {horoscope.yearly.heavenlyStem}{horoscope.yearly.earthlyBranch}</p>
      <button type="button" onClick={() => setHoroscope('2025-10-19', 2)}>
        2025년 10월 19일 인시의 운한 보기
      </button>
    </section>
  );
}

스크롤하면 실행 예제를 불러옵니다.

명반 작성 매개변수 ​

매개변수타입설명
birthdaystring필수. 생년월일입니다. 예를 들어 '2000-8-16'을 사용합니다. 양력과 음력은 birthdayType으로 구분합니다.
birthdayType'solar' | 'lunar'필수. 양력에는 'solar', 음력에는 'lunar'를 사용합니다.
birthTimenumber필수. 출생 시진 인덱스입니다. 범위는 0부터 12까지이며, 예를 들어 2는 인시(寅時), 12는 만자시(晚子時)입니다.
genderGenderName필수. 한국어에서는 '남성' 또는 '여자'를 사용합니다.
isLeapMonthboolean음력 생년월일이 윤달에 해당하는지 여부입니다. 기본값은 false입니다.
fixLeapboolean명반을 작성할 때 윤달을 보정할지 여부입니다. 기본값은 true입니다. astro.withOptions()를 참고하세요.
langLanguage명반과 운한의 출력 언어입니다. 값을 명시하면 options.language보다 우선합니다.
astroTypeAstroType명반 유형입니다. 'heaven'은 기본값인 천반(天盤), 'earth'는 지반(地盤), 'human'은 인반(人盤)입니다.
optionsConfig현재 명반의 설정입니다. 예를 들어 { yearDivide: 'exact' }를 지정하면 입춘(立春)을 연도의 경계로 삼습니다.

출생 정보를 양식에서 받는 경우, 입력값을 검증한 뒤 훅을 호출하는 자식 컴포넌트를 렌더링하세요. 날짜가 비어 있거나 해석할 수 없으면 명반 계산을 건너뛰므로 이전 결과가 계속 표시될 수 있습니다. 그 밖의 잘못된 입력은 iztro에서 오류를 일으킬 수 있습니다. 명반 설정과 입력값 검증을 참고하세요.

반환값 ​

필드설명
astrolabeFunctionalAstrolabe 인스턴스입니다. 열두 궁(十二宮)과 주성(主星) 등의 데이터를 읽거나 인스턴스의 메서드로 추가 조회를 할 수 있습니다.
horoscopeFunctionalHoroscope 객체입니다. 대한(大限), 소한(小限), 유년(流年), 유월(流月), 유일(流日), 유시(流時) 등의 결과가 포함됩니다. 처음에는 현지의 현재 날짜와 시진으로 계산합니다.
setHoroscope(date, hour?)운한 조회 조건을 갱신합니다. date는 양력 날짜 문자열 또는 Date를, hour는 0부터 12까지의 시진 인덱스를 받습니다. hour를 생략하면 전달한 날짜의 현지 시각에서 시진 인덱스를 구합니다.

setHoroscope의 반환값은 void입니다. 이후 렌더링에서 갱신된 horoscope를 읽으세요. 이 메서드는 운한 조회 조건만 바꾸며, 출생 정보는 계속 훅의 입력값으로 결정됩니다.

GitHub 소스 코드 · npm