# @digitransit-component/digitransit-component-favourite-modal 中文文档

规范地址：https://npmcn.com/package/%40digitransit-component/digitransit-component-favourite-modal/

版本：8\.0\.5
npm 元数据更新时间：2026-11-09T10:17:10.635Z
中文译文更新时间：2026-11-12T13:11:55.433Z
软件包许可：\(AGPL-3\.0 OR EUPL-1\.2\)

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40digitransit-component/digitransit-component-favourite-modal
原文对照：https://npmcn.com/package/%40digitransit-component/digitransit-component-favourite-modal/?lang=original
项目主页：https://github.com/HSLdevcom/digitransit-ui#readme
源码仓库：https://github.com/HSLdevcom/digitransit-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：196 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：react ^18\.3\.1，i18next ^22\.5\.1，classnames ^2\.5\.1，prop-types ^15\.8\.1，@hsl-fi/form ^5\.0\.4，react-i18next ^12\.3\.1，@hsl-fi/dialog ^3\.1\.3，@hsl-fi/layout-primitives ^4\.9\.0，@digitransit-component/digitransit-component-icon ^5\.0\.5
- 首次发布：2020-05-26T06:57:35.782Z
- 最新版本发布：2026-11-09T10:17:10.212Z
- 近 30 天下载量：2431（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：76（近 12 个月 23 个）

## 中文简介

digitransit 组件最喜欢的模式模块

## 安装

```sh
npm install @digitransit-component/digitransit-component-favourite-modal
```

也可以使用：`pnpm add @digitransit-component/digitransit-component-favourite-modal`、`yarn add @digitransit-component/digitransit-component-favourite-modal`、`bun add @digitransit-component/digitransit-component-favourite-modal`

## README

# @ digitalransit- 组件/ digitalransit- 组件- favourite- 模式

## 是 Modal 打开

要求。 对话框是否打开 .

类型 : [布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)

## 关闭

要求。 当对话框关闭而不保存时调用 .

类型 : [函数](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)

## 保存爱好

要求。 用户保存时使用最喜爱的调用 .

类型 : [函数](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)

## 取消选中内容

可选, 但编辑时需要( favourite 有最喜欢的Id): call 保存后和用户按下取消后,通常返回 喜欢的列表 。 添加新最爱时未使用 .

类型 : [函数](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)

## 自动推荐组件

自动推荐用于搜索首选位置的组件 .

类型 : [节点](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)

## 最爱

可选的 预填对话框的对象 。 有个最爱的 编辑模式中的对话框 .

类型 : [对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

### 属性

-   `type` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `address` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `gtfsId` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `gid` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `lat` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
-   `lon` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
-   `name` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `selectedIconId` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `favouriteId` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `layer` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `defaultName` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**

## 朗语

可选的 语言, fi, en 或 sv. 默认为 fi.

类型 : [字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

## 喜好莫达尔

用于添加新首选位置或编辑现有位置的对话框, 建立在HSL设计系统Modal上. 颜色、打字和 移动/桌面布局由设计系统处理,所以对话框 遵循当前部署的主题.

### 参数

-   `$0` **[对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
    
    -   `$0.isModalOpen`
    -   `$0.handleClose`
    -   `$0.saveFavourite`
    -   `$0.cancelSelected` (可选,默认) `noop`(中文(简体) )
    -   `$0.autosuggestComponent`
    -   `$0.favourite` (可选,默认) `null`(中文(简体) )
    -   `$0.lang` (可选,默认) `'fi'`(中文(简体) )

### 实例

```javascript
<FavouriteModal
  isModalOpen={modalOpen}
  handleClose={handleClose}
  saveFavourite={onSaveFavourite}
  favourite={favourite}
  lang={lang}
  autosuggestComponent={
    <AutoSuggest
      sources={['History', 'Datasource']}
      targets={['Locations', 'CurrentPosition']}
      id="favourite"
      autoFocus={false}
      placeholder="search-address-or-place"
      value={favourite.address || ''}
      selectHandler={setLocationProperties}
      lang={lang}
    />
  }
/>
```

\-- -- . .

这个模块是Digitransit-ui项目的一部分. 保留在 [HSLdevcom/数码-i](https://github.com/HSLdevcom/digitransit-ui) 库,您可以创建的地方 公关和问题.

### 安装

单独安装此模块 :

```sh
$ npm install @digitransit-component/digitransit-component-favourite-modal
```

## 常见问题

### @digitransit-component/digitransit-component-favourite-modal 是什么？

digitransit 组件最喜欢的模式模块

### 如何安装 @digitransit-component/digitransit-component-favourite-modal？

在项目目录运行 npm install @digitransit-component/digitransit-component-favourite-modal，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.3\.1）、i18next（^22\.5\.1）、classnames（^2\.5\.1）、prop-types（^15\.8\.1）、@hsl-fi/form（^5\.0\.4）、react-i18next（^12\.3\.1）、@hsl-fi/dialog（^3\.1\.3）、@hsl-fi/layout-primitives（^4\.9\.0）、@digitransit-component/digitransit-component-icon（^5\.0\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @digitransit-component/digitransit-component-favourite-modal 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/digitransit-component\_\_digitransit-component-favourite-modal 是否存在。

### @digitransit-component/digitransit-component-favourite-modal 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @digitransit-component/digitransit-component-favourite-modal 可以商用吗？

@digitransit-component/digitransit-component-favourite-modal 使用 \(AGPL-3\.0 OR EUPL-1\.2\) 许可。可在 AGPL-3\.0、EUPL-1\.2 中任选其一遵守。以上为概括，不构成法律意见，请以许可原文为准。

### @digitransit-component/digitransit-component-favourite-modal 的下载量有多少？

根据 npm 官方下载统计，@digitransit-component/digitransit-component-favourite-modal 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,431 次，日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @digitransit-component/digitransit-component-favourite-modal 还在维护吗？

最新版本 8\.0\.5 发布于 2026/11/09（4 天前）；至今共发布 76 个版本，其中过去 12 个月发布了 23 个；首次发布于 2020/05/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。