Skip to content

Document ESM UI providers - #613

Open
ruibaby wants to merge 2 commits into
halo-dev:mainfrom
ruibaby:docs/esm-ui-providers
Open

Document ESM UI providers#613
ruibaby wants to merge 2 commits into
halo-dev:mainfrom
ruibaby:docs/esm-ui-providers

Conversation

@ruibaby

@ruibaby ruibaby commented Aug 7, 2026

Copy link
Copy Markdown
Member

Summary

  • Document ESM and IIFE output selection, shared runtime dependencies, lifecycle behavior, and packaging requirements for plugin UI providers.
  • Add a guide for building theme UI providers with Vite or Rsbuild and include it in the theme documentation navigation.
  • Document the stores.uiPlugins() API for querying plugin and theme provider registration status.
  • Update related plugin structure, manifest, development, API request, and Halo 2.26 changelog documentation.

Related

Testing

  • corepack pnpm@10.33.0 lint
  • corepack pnpm@10.33.0 build
  • git diff --check

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ad36cbb181

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

安装依赖:

```bash
pnpm install @halo-dev/ui-plugin-bundler-kit@2.26.0 vite -D

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Install ui-shared before building the theme provider

For a new ui-plugin created by following this guide, both dependency commands install only the bundler and build tool, while the entry shown above directly imports @halo-dev/ui-shared. With pnpm's strict dependency resolution, that import is unavailable unless the project declares it directly, so either Vite or Rsbuild fails before producing dist; include a compatible @halo-dev/ui-shared dependency in both setup paths.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant