ui README

项目的 README,来自 github.com/vercel-labs/ui。合并为一个 markdown 文件:README.md。

UI SDK

A library of behaviors for agents to build the next generation of user interfaces.

Keyboard navigation, focus, selection, dismissal, popups, drag and drop and the ARIA they need live in @ui-sdk/core, with adapters for React, Vue, Svelte, Solid and Web Components.

An environment selector split into three behaviors: createPopup, createSelection and createTypeahead.

Read the docs

Install

UI SDK is in beta. Install core and the adapter for your framework:

npm install @ui-sdk/react @ui-sdk/core

For other frameworks, swap @ui-sdk/react for @ui-sdk/vue, @ui-sdk/svelte, @ui-sdk/solid or @ui-sdk/web.

Then give your agent the UI SDK skill:

npx skills@latest add vercel-labs/ui --skill ui-sdk

Example

Every component in UI SDK is built from behaviors. You start by creating the primitive with behaviors.

Don't worry, you don't need to learn how to write this. Your agents will. And we made them really good at it.

import { createFocusRecovery, definePrimitive } from "@ui-sdk/core"

const searchField = definePrimitive({
  name: "search-field",
  state: () => ({ value: "" }),
  api: (context) => ({
    set: (value: string) => context.store.set({ value }),
    recovery: createFocusRecovery({ fallback: () => context.element("input") }),
  }),
  slots: (slot) => ({
    input: slot({
      attrs: (state) => ({ value: state.value }),
      on: {
        input: (event, { api }) =>
          api.set((event.target as HTMLInputElement).value),
      },
    }),
    clear: slot({
      present: (state) => state.value !== "",
      attrs: () => ({ type: "button" }),
      press: ({ api }) => api.set(""),
      bind: (el, part) => part.api.recovery.bind(el, part),
    }),
  }),
})

export { searchField }

Then render it in your framework with createParts. The parts are the same in all five.

React

import { createParts } from "@ui-sdk/react/primitive"
import { searchField } from "./search-field"

const parts = createParts(searchField, { input: "input", clear: "button" })

const SearchField = parts.Root
const SearchFieldInput = parts.Input
const SearchFieldClear = parts.Clear

function Search() {
  return (
    <SearchField>
      <SearchFieldInput placeholder="Search" />
      <SearchFieldClear>Clear</SearchFieldClear>
    </SearchField>
  )
}

export { Search }

Vue

<script setup lang="ts">
import { createParts } from "@ui-sdk/vue/primitive"
import { searchField } from "./search-field"

const parts = createParts(searchField, { input: "input", clear: "button" })

const SearchField = parts.Root
const SearchFieldInput = parts.Input
const SearchFieldClear = parts.Clear
</script>

<template>
  <SearchField>
    <SearchFieldInput placeholder="Search" />
    <SearchFieldClear>Clear</SearchFieldClear>
  </SearchField>
</template>

Svelte

<script lang="ts">
  import { createParts } from "@ui-sdk/svelte/primitive"
  import { searchField } from "./search-field"

  const parts = createParts(searchField, { input: "input", clear: "button" })

  const SearchField = parts.Root
  const SearchFieldInput = parts.Input
  const SearchFieldClear = parts.Clear
</script>

<SearchField>
  <SearchFieldInput placeholder="Search" />
  <SearchFieldClear>Clear</SearchFieldClear>
</SearchField>

Solid

import { createParts } from "@ui-sdk/solid/primitive"
import { searchField } from "./search-field"

const parts = createParts(searchField, { input: "input", clear: "button" })

const SearchField = parts.Root
const SearchFieldInput = parts.Input
const SearchFieldClear = parts.Clear

function Search() {
  return (
    <SearchField>
      <SearchFieldInput placeholder="Search" />
      <SearchFieldClear>Clear</SearchFieldClear>
    </SearchField>
  )
}

export { Search }

Web Components

Register a custom element for each part:

import { createParts, wrappedButton, wrappedChild } from "@ui-sdk/web"
import { searchField } from "./search-field"

createParts(searchField, {
  root: "search-field",
  input: { tag: "search-field-input", target: wrappedChild("input") },
  clear: { tag: "search-field-clear", target: wrappedButton },
})

Then use them in your HTML:

<search-field>
  <search-field-input><input placeholder="Search" /></search-field-input>
  <search-field-clear><button>Clear</button></search-field-clear>
</search-field>

Contributing

Contributions are welcome. See CONTRIBUTING.md to get the repo running locally and land a change, and use issues to report bugs. By participating, you agree to our Code of Conduct.

Security

Please do not open public issues for security vulnerabilities. Instead, follow SECURITY.md and report responsibly to [email protected].

Beta terms

UI SDK is currently in beta and subject to the Vercel beta terms; the framework, APIs, documentation, and behavior may change before general availability.

ui (vercel-labs/ui)

正在搜索数据库…

5.6K ·GitHub
这是什么?一个行为库,供智能体用来构建用户界面,包括键盘导航、焦点、选择、关闭、弹出层、拖放和 ARIA。它为 React、Vue、Svelte、Solid 和 Web Components 提供了适配器。
它是一套现成的组件吗?不完全是。核心包提供行为和 ARIA,你再通过框架适配器把它们组装成部件,因此每个组件都是由行为拼装而成,而不是直接复制一个成品控件。
我该怎么让它跑起来?安装 @ui-sdk/core 以及你所用框架对应的适配器,例如 @ui-sdk/react。如果使用 Vue、Svelte、Solid 或原生 Web Components,换成对应的包即可。然后把 UI SDK 技能提供给你的智能体。
支持哪些框架?React、Vue、Svelte、Solid 和 Web Components,每个框架都通过各自的 @ui-sdk 适配器包来使用。
现在就够稳定,可以用吗?目前处于测试版,因此在正式发布之前,框架、API、文档和行为都可能发生变化。
不用框架,直接用 Web Components 可以吗?可以。README 中展示了 Web Components 适配器(@ui-sdk/web),其中每个部件都注册为自定义元素,然后直接在普通 HTML 中使用。
同一个组件在每个框架里看起来都一样吗?README 说明,这些部件在五个框架中是相同的,因此 createParts 在 React、Vue、Svelte、Solid 和 Web Components 中都能提供一致的结构。
为什么不直接用成品组件,而要基于行为来构建?行为是可复用的基础模块,涵盖键盘操作、焦点、选择、弹出层和 ARIA。智能体可以把它们组合成新组件,你就不必逐个手写。
大小
15.8 MB
星标
5.6K
更新
提交Nov 17
时长
23天
提交 · 90 天