ngx-query-参数
反应和类型安全查询参数管理 角信号。 。 。 .
由Angular现代反应模式提供动力.
* 特性
- ✅ 自动符号 从查询参数
- ✅ 双向绑定: 更新信号 – 更新 URL
- ++ 与原始类型、阵列、布林、数字、enum 等工作
- ✅ 完全可动摇的树角-内置
- 零额外依赖
* 安装
利用国家预防机制:
npm install @geckosoft/ngx-query-params
使用 YARN :
yarn add @geckosoft/ngx-query-params
QQ 设置
保证您的应用使用 Angular 的 信号 (英语:Angular v17+).
不需要特别的设置——只需在任何角构件或服务中导入和使用.
使用量
绑上一个数字参数:
import { Component } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { qpNum } from '@geckosoft/ngx-query-params';
@Component({
selector: ...,
imports: [FormsModule],
template: `
<input type="number" [(ngModel)]="page">
<button (click)="nextPage()">Next Page</button>
`,
})
export class MyComponent {
page = qpNum('page', 1); // ?page=1
nextPage() {
this.page.set(this.page() + 1);
}
}
装入布尔参数 :
toggle = qpBool('debug', false); // ?debug=true
绑入字符串参数 :
filter = qp('filter', 'all'); // ?filter=all
可选单个参数:
sort = qp('sort'); // string | undefined
类似倒铸 :
type Tab = 'home' | 'profile' | 'settings';
tab = qpCast1<Tab>('tab', 'home'); // ?tab=home
多值参数 :
tags = qpMapN('tag', (x) => x.toLowerCase()); // ?tag=a&tag=b
* 如何运作
- 钩入角路由器
ActivatedRoute财务报告和审定财务报表queryParamMap - 同步为
WritableSignal<T> - 全球
QueryParamsService当任何参数发生变化时, 批次并更新 URL
API 参考
信号
| 函数 | 类型 | 说明 |
|---|---|---|
qp() | WritableSignal<string | undefined> | 字符串参数 |
qpNum() | WritableSignal<number | undefined> | 编号参数 |
qpBool() | WritableSignal<boolean | undefined> | 布尔参数 |
qpCast1<T>() | WritableSignal<T | undefined> | 铸至铝/合金类型 |
qpMapN() | WritableSignal<T[]> | 多值参数与映射 |
qpMap1() | WritableSignal<T | undefined> | 一般一值映射仪 |
高级
可以注射吗 QueryParamsService 手动批量或设置多个参数:
constructor(private readonly qps: QueryParamsService) {}
applyFilters() {
this.qps.set('filter', 'recent');
this.qps.set('limit', 20);
}
清理
不需要手动取消订阅- 内部处理 onDestroy() 和信号处理.
许可证
麻省理工学院
* 反馈/贡献
问题和公关欢迎!