@getaster/elements

中文文档
0.4.72发布于 2026/11/16Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 3529

Browser-native grids, forms and workspace controls backed by shared Aster data models.

原始使用文档
文档目录5 节
  1. Install
  2. Connect a grid
  3. Compose an application
  4. Documentation and support
  5. License

@getaster/elements

Browser-native controls for metadata-driven enterprise applications: grids, forms, pickers, filters, dashboards and workspaces. Controls share records and edit state through @getaster/data and use CSS for layout and theming.

Preview controls are published separately in @getaster/elements-preview.

Install

npm install @getaster/data @getaster/elements

Use a modern browser with custom elements and ES modules, plus a bundler that resolves npm modules and CSS imports. The package ships TypeScript declarations. Its main entry registers browser elements and requires a DOM; use @getaster/data for headless work. Package tooling requires Node 22 or later.

@getaster/elements/styles/theme-lamplight.css and @getaster/elements/styles/theme-harbour.css each compose the base primitives, element styles and one identity. Lamplight's entry also loads the packaged Bricolage Grotesque and Fraunces Latin faces, with metric-matched local fallbacks, from @getaster/elements/styles/fonts.css. Import one composed entry, not the parts.

Connect a grid

With an OData service exposing a Projects entity set and JSON CSDL metadata:

import { DataContext, fetchTransport } from '@getaster/data';
import { Grid } from '@getaster/elements';
import '@getaster/elements/styles/aster-ui.css';

const ctx = await DataContext.connect(
  fetchTransport('https://your-service.example/odata/')
);
const grid = new Grid();
grid.ctx = ctx;
grid.set = 'Projects';
grid.label = 'Projects';
grid.style.height = '24rem';
document.body.append(grid);

Replace the endpoint and entity set with your own. Give a virtualized grid a bounded height, and supply your application's theme tokens as described in the theming guide. When the view closes, remove the element; separately owned data models remain the host's responsibility.

Compose an application

Use a shared data context to connect a grid, form and selection. JavaScript and YAML composition support reusable workspace definitions. Controls provide keyboard interaction and semantic markup; application labels, focus flow and accessibility still need testing in the completed application.

The package depends on Aster's data core, Lit HTML and Preact signals. Keep one compatible copy of each shared runtime in your build. The YAML compiler is a separate subpath, @getaster/elements/yaml, and is the only entry that loads the yaml parser; a browser that imports a compiled definition never loads it. The optional ECharts adapter accepts an application-supplied runtime; ECharts, showcase data and the mock service are not bundled into this package. The Lamplight font files and their SIL Open Font License texts are included under styles/fonts/. There are no install scripts.

Documentation and support

License

Apache-2.0. See the included LICENSE and package-specific NOTICE. Separately installed dependencies retain their own licenses.

版本与发布记录

@getaster/elements 共发布 20 个版本,首次发布于 2026/10/21;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.72latest2026/11/16今天
0.4.472026/11/141 天前
0.4.422026/11/133 天前
0.4.402026/11/133 天前
0.4.382026/11/123 天前
0.4.352026/11/123 天前

其他发布通道:next → 0.1.0-preview.1。

关于 @getaster/elements 的常见问题

@getaster/elements 是什么?

Browser-native grids, forms and workspace controls backed by shared Aster data models.

如何安装 @getaster/elements?

在项目目录运行 npm install @getaster/elements,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 aster-lint、aster-skill、aster-theme-check,可以用 npx aster-lint 直接运行。

@getaster/elements 支持 TypeScript 吗?

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

@getaster/elements 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@getaster/elements 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getaster/elements 可以商用吗?

@getaster/elements 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@getaster/elements 的下载量有多少?

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

@getaster/elements 还在维护吗?

最新版本 0.4.72 发布于 2026/11/16(今天);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/10/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。