woocommerce/packages/js/navigation/zh-cn

导航

一组用于处理查询参数对象、序列化查询参数、更新查询参数和触发路径更改的导航相关函数。

安装

安装模块

pnpm install @woocommerce/navigation --save

用法

getHistory

一个用于执行路径更改的单一历史对象。需要将其传递给 ReactRouter 才能使用此库中的其他路径函数。

import { getHistory } from '@woocommerce/navigation';

render() {
	return (
		<Router history={ getHistory() }>
			…
		</Router>
	);
}

getPath() ⇒ String

从历史中获取当前路径。

返回: String - 当前路径。

getTimeRelatedQuery(query) ⇒ Object

从查询中获取时间相关参数。

返回: Object - 包含时间相关查询的对象。

参数	类型	描述
query	Object	包含参数的查询。

getIdsFromQuery(queryString) ⇒ Array

从逗号分隔的查询参数中获取 ID 数组。

返回: Array - 转换为唯一整数数组的 ID 列表。

参数	类型	描述
queryString	string	从 URL 中提取的字符串值。

getNewPath(query, path, currentQuery) ⇒ String

返回一个设置了查询参数的网址。

返回: 字符串 - 将查询参数合并到现有参数后的已更新网址。

参数	类型	描述
query	Object	待更新的参数对象。
path	String	相对路径（默认为当前路径）。
currentQuery	Object	当前查询参数对象（默认为当前查询字符串）。

getQuery() ⇒ Object

获取当前查询字符串，从历史记录中解析为对象。

返回: Object - 当前查询对象，默认为空对象。

onQueryChange(param, path, query) ⇒ function

此函数返回给定 param 的事件句柄。

返回: function - 一个回调函数，调用时将 param 更新为通过的值。

参数	类型	描述
param	string	应更新的查询字符串中的参数（例如 page、per_page）
path	string	相对路径（默认为当前路径）。
query	string	当前查询参数的对象（默认为当前查询字符串）。

updateQueryString(query, path, currentQuery)

更新当前页面的查询参数。

参数	类型	描述
query	Object	待更新的参数字典。
path	String	相对路径（默认为当前路径）。
currentQuery	Object	当前查询参数字典（默认为当前查询字符串）。

flattenFilters(filters) ⇒ Array

将包含子筛选器的筛选器值数组折叠成一个一维数组。

返回: Array - 所有筛选器的扁平化数组。

参数	类型	描述
filters	Array	可能包含子筛选器的筛选器集合。

getActiveFiltersFromQuery(query, config) ⇒ Array.<activeFilters>

给定一个查询对象，返回一个 activeFilters 数组（如果存在）。

返回: Array.<activeFilters> - - activeFilters 数组

参数	类型	描述
query	object	查询对象
config	object	配置对象

getDefaultOptionValue(config, options) ⇒ string | undefined

从配置对象中获取给定过滤器的默认选项值。如果未提供 defaultOption，则使用第一个选项作为默认值。

返回: string | undefined - - 默认选项的值。

参数	类型	描述
config	object	过滤器配置对象。
options	array	选择选项。

getQueryFromActiveFilters(activeFilters, query, config) ⇒ object

根据 activeFilters，创建一个新的查询对象以更新网址。使用 previousFilters 来移除未使用的参数。

返回: object - - 表示新参数的查询对象

参数	类型	描述
activeFilters	Array.<activeFilters>	在 UI 中显示的启用筛选
query	object	当前网址查询对象
config	object	配置对象

getUrlKey(key, rule) ⇒ string

从过滤关键字和规则中获取网址查询关键字。

返回: string - - 网址查询关键字。

参数	类型	描述
key	string	过滤关键字。
rule	string	过滤规则。

activeFilter : Object

描述 activeFilter 对象。

属性

名称	类型	描述
key	string	过滤关键字。
[rule]	string	过滤器的修改规则，例如 'includes' 或 'is_not'。
value	string	过滤值。