@github/remote-input-element

中文文档
0.4.0发布于 2024/04/09MITTypeScriptESM + CJS零依赖近 30 天下载 8.6万

An input element that sends its value to a server endpoint and renders the response body.

原始使用文档
文档目录7 节
  1. Installation
  2. Usage
  3. Styling loading state
  4. Events
  5. Browser support
  6. Development
  7. License

<remote-input> element

An input element that sends its value to a server endpoint and renders the response body.

Installation

$ npm install @github/remote-input-element

Usage

import '@github/remote-input-element'
<!-- Filter a list of items from the server -->
<remote-input src="/query" aria-owns="results">
  <input>
</remote-input>
<ul id="results"></ul>

A GET request will be sent to /query?q=${input.value}.

The parameter name (q) is customizable with the [param] attribute:

<!-- Live preview of Markdown -->
<remote-input src="/preview" aria-owns="md-preview" param="body">
  <textarea></textarea>
</remote-input>
<div id="md-preview"></div>

Styling loading state

A boolean [loading] attribute is added to <remote-input> when a network request begins and removed when it ends.

.loading-icon { display: none; }
remote-input[loading] .loading-icon { display: inline; }

Events

  • loadstart - The server fetch has started.
  • load - The network request completed successfully.
  • error - The network request failed.
  • loadend - The network request has completed.
  • remote-input-success – Received a successful response (status code 200-299), and response HTML has been set. Bubbles.
  • remote-input-error – Received a not successful response. Bubbles.

Browser support

Browsers without native custom element support require a polyfill.

  • Chrome
  • Firefox
  • Safari
  • Microsoft Edge

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.

版本与发布记录

@github/remote-input-element 共发布 15 个版本,首次发布于 2019/05/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.4.0latest2024/04/092 年前
0.3.12020/03/196 年前
0.3.02020/03/116 年前
0.2.12020/01/296 年前
0.2.02019/10/237 年前
0.1.22019/09/217 年前

关于 @github/remote-input-element 的常见问题

@github/remote-input-element 是什么?

An input element that sends its value to a server endpoint and renders the response body.

如何安装 @github/remote-input-element?

在项目目录运行 npm install @github/remote-input-element,或使用 pnpm add / yarn add / bun add。

@github/remote-input-element 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@github/remote-input-element 支持 ESM 还是 CommonJS?

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

@github/remote-input-element 可以商用吗?

@github/remote-input-element 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@github/remote-input-element 的下载量有多少?

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

@github/remote-input-element 还在维护吗?

最新版本 0.4.0 发布于 2024/04/09(2 年前);至今共发布 15 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/05/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。