Skip to content
このページの内容

iztro-hook ​

iztro-hook は、iztro の命盤作成と運限の計算を React Hook として提供します。useIztro でデータを取得し、命盤や表、絞り込み用の UI を自由に作成できます。すぐに使えるインタラクティブな命盤を埋め込むには react-iztro を使います。React 以外の環境では iztro を直接利用できます。

インストール ​

sh
npm install iztro iztro-hook

以下の例とパラメータは iztro-hook 1.3.5 と iztro 2.6.5 を対象としています。

命盤と運限を取得する ​

useIztro は、React の関数コンポーネントやカスタム Hook のトップレベルで呼び出します。初回のレンダーでは 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: 'ja-JP',
  });

  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' } を指定すると立春が年の境目になります。

出生情報をフォームから受け取る場合は、入力を検証してから Hook を呼び出す子コンポーネントを表示します。日付が空欄か解析できない場合は命盤の計算がスキップされ、以前の結果が表示されたままになることがあります。ほかにも無効な入力があると、iztro がエラーをスローする場合があります。命盤の設定と入力値の検証を参照してください。

戻り値 ​

フィールド説明
astrolabeFunctionalAstrolabe のインスタンス。十二宮や主星のデータを取得したり、インスタンスのメソッドでさらに照会したりできます。
horoscopeFunctionalHoroscope オブジェクト。大限、小限、流年、流月、流日、流時などの結果が含まれます。初期値はローカルの現在の日付と時辰で計算します。
setHoroscope(date, hour?)運限の照会条件を更新します。date には新暦の日付文字列または Date を、hour には 0 から 12 までの時辰インデックスを指定します。hour を省略すると、渡した日付のローカル時刻の「時」から時辰を求めます。

setHoroscope の戻り値は void です。更新後の horoscope は以降のレンダーで読み取ります。このメソッドが変更するのは運限の照会条件で、出生情報は引き続き Hook の入力で指定します。

GitHub ソースコード · npm