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-CN');

export default function App() {
  return (
    <div style={{ maxWidth: 1024, margin: '0 auto' }}>
      <Iztrolabe
        birthday="2000-8-16"
        birthdayType="solar"
        birthTime={2}
        gender="女"
        lang="zh-CN"
        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