Skip to content
頁內導覽

react-iztro ​

react-iztro 提供可直接使用的 React 星盤元件 Iztrolabe,可顯示十二宮、星曜、四化和三方四正,並在星盤內切換運限。如需自行設計介面,可用 iztro-hook 直接取得資料。

安裝 ​

sh
npm install iztro react-iztro

以下範例與參數以 react-iztro 1.5.1 為基準。

顯示星盤 ​

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

astro.setLanguage('zh-TW');

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

捲動至此處時載入可執行範例。

元件會載入內建樣式,建置工具必須支援從相依套件匯入 CSS。可以透過外層容器控制星盤寬度,並在應用程式的樣式表中覆寫預設樣式。

lang 指定星盤資料的語言。範例也呼叫 astro.setLanguage(),讓中宮的介面標籤採用相同語言。建議在應用程式初始化時設定一次。

元件參數 ​

Iztrolabe 接受 useIztro 的排盤參數。必填項目為 birthday、birthdayType、birthTime 和 gender。元件也提供以下顯示與運限參數。

參數型別說明
horoscopeDatestring | Date查詢運限的國曆日期。預設為本地目前的日期。
horoscopeHournumber查詢流時的時辰索引,範圍為 0 至 12。元件預設為 0(早子時)。
centerPalaceAlignboolean設為 true 時,中宮內容會置中對齊。

可以在中宮調整運限日期和時辰。父元件更新 horoscopeDate 或 horoscopeHour 時,元件也會更新查詢條件。如果要使用某個 Date 物件對應的時辰,請另行傳入換算後的 horoscopeHour。

切換中州派盤型 ​

元件預設採用通行排盤演算法。可在中宮切換排盤演算法,選擇中州派後可選天盤、地盤或人盤。如要直接開啟中州派地盤,請為上述元件加上下列兩個屬性。

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

盤型和其他排盤設定的意義請見 AstroType 和 Config。

GitHub 原始碼 · npm