iztro-hook
iztro-hook 将 iztro 的排盘和运限计算封装为 React Hook。使用 useIztro 获取数据后,可以自行设计星盘、表格或筛选界面。如果需要直接嵌入完整的交互星盘,可以使用 react-iztro。在 React 之外也可以直接使用 iztro。
安装
sh
npm install iztro iztro-hook以下示例和参数以 iztro-hook 1.3.5、iztro 2.6.5 为基准。
获取星盘与运限
在 React 函数组件或自定义 Hook 的顶层调用 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: 'zh-CN',
});
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>
);
}滚动至此处时加载可运行示例。
排盘参数
| 参数 | 类型 | 说明 |
|---|---|---|
birthday | string | 必填。出生日期,例如 '2000-8-16'。由 birthdayType 决定使用公历还是农历。 |
birthdayType | 'solar' | 'lunar' | 必填。公历填 'solar',农历填 'lunar'。 |
birthTime | number | 必填。出生时辰索引,范围为 0 至 12。例如 2 表示寅时,12 表示晚子时。 |
gender | GenderName | 必填。简体中文示例使用 '男' 或 '女'。 |
isLeapMonth | boolean | 农历出生日期是否在闰月,默认 false。 |
fixLeap | boolean | 排盘时是否处理闰月,默认 true。详见 astro.withOptions()。 |
lang | Language | 星盘和运限的输出语言。显式传值时优先于 options.language。 |
astroType | AstroType | 星盘类型,'heaven' 为默认天盘,'earth' 为地盘,'human' 为人盘。 |
options | Config | 当前星盘的排盘配置,例如 { yearDivide: 'exact' } 表示以立春为年分界。 |
若出生资料来自表单,校验完成后再渲染调用 Hook 的子组件。空日期或无法解析的日期会跳过排盘,已有结果可能继续显示。其他无效输入可能由 iztro 报错。详见排盘配置与输入校验。
返回值
| 字段 | 说明 |
|---|---|
astrolabe | FunctionalAstrolabe 实例。可以读取十二宫、主星等数据,也可以调用实例方法继续查询。 |
horoscope | FunctionalHoroscope 功能对象,包含大限、小限、流年、流月、流日和流时等结果。初始按本地当前日期和时辰计算。 |
setHoroscope(date, hour?) | 更新运限查询条件。date 接受公历日期字符串或 Date,hour 接受 0 至 12 的时辰索引。省略 hour 时,Hook 根据传入日期的本地小时换算时辰。 |
setHoroscope 的返回值是 void。在后续渲染中读取更新后的 horoscope。调用此方法只改变运限查询条件,出生资料仍由 Hook 的入参决定。