Skip to content
このページの内容

react-iztro ​

react-iztro は、十二宮、星曜、四化、三方四正を表示できる React コンポーネント Iztrolabe を提供します。命盤上で運限を切り替えられます。UI を自作する場合は、iztro-hook でデータを直接取得できます。

インストール ​

sh
npm install iztro react-iztro

以下の例と props は react-iztro 1.5.1 を対象としています。

命盤を表示する ​

tsx
import React from 'react';
import { astro } from 'iztro';
import { Iztrolabe } from 'react-iztro';

astro.setLanguage('ja-JP');

export default function App() {
  return (
    <div style={{ maxWidth: 1024, margin: '0 auto' }}>
      <Iztrolabe
        birthday="2000-8-16"
        birthdayType="solar"
        birthTime={2}
        gender="女"
        lang="ja-JP"
        horoscopeDate="2026-11-22"
        horoscopeHour={2}
      />
    </div>
  );
}

スクロールすると実行例を読み込みます。

コンポーネントは付属のスタイルを読み込みます。依存パッケージから CSS を読み込めるビルドツールを使用してください。外側のコンテナーで命盤の幅を調整し、アプリのスタイルシートで既定のスタイルを上書きできます。

lang で命盤データの言語を指定します。この例では astro.setLanguage() も呼び出し、中宮に表示する項目名の言語をそろえています。アプリの初期化時に一度設定してください。

コンポーネントの props ​

Iztrolabe には useIztro の命盤作成パラメータを渡せます。birthday、birthdayType、birthTime、gender は必須です。表示と運限の制御には次の props も使えます。

パラメータ型説明
horoscopeDatestring | Date運限を照会する新暦の日付。省略するとローカルの現在の日付を使用します。
horoscopeHournumber流時の照会に使う時辰インデックス。範囲は 0 から 12 までで、既定値は 0(早子時)です。
centerPalaceAlignbooleantrue にすると中宮の内容を中央揃えにします。

中宮で運限の照会日と時辰を調整できます。親コンポーネントが horoscopeDate または horoscopeHour を変更したときも、照会条件が更新されます。特定の Date に対応する時辰を使う場合は、変換したインデックスを horoscopeHour に渡してください。

中州派の命盤を切り替える ​

既定では一般的な命盤作成アルゴリズムを使用します。中宮で中州派に切り替えると、天盤・地盤・人盤を選べます。中州派の地盤を最初から表示するには、上のコンポーネントに次の二つの props を追加します。

tsx
options={{ algorithm: 'zhongzhou' }}
astroType="earth"

命盤の種類とその他の設定については、AstroType と Config を参照してください。

GitHub ソースコード · npm