Skip to content

Add documentation and showcase examples for all plugins#141

Merged
huangyiirene merged 4 commits intomainfrom
copilot/add-documentation-for-plugins
Jan 22, 2026
Merged

Add documentation and showcase examples for all plugins#141
huangyiirene merged 4 commits intomainfrom
copilot/add-documentation-for-plugins

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 21, 2026

Problem

Plugins were inconsistently documented: plugin-editor and plugin-markdown lacked showcase examples, plugin-object lacked documentation. The CLI also didn't auto-import plugins, causing registration failures.

Changes

Added Showcase Examples

  • code-editor.json: Monaco editor demonstrations (JavaScript, TypeScript, Python, JSON, HTML) with theme variants and read-only mode
  • markdown.json: GFM rendering examples (headings, tables, code blocks, task lists, blockquotes)

Added Documentation

  • plugin-object.md: Complete reference for ObjectTable, ObjectForm, and ObjectView with TypeScript types and ObjectQL integration examples

Fixed Plugin Loading

// packages/cli/src/utils/app-generator.ts
import '@object-ui/components';
import '@object-ui/plugin-charts';
import '@object-ui/plugin-editor';
import '@object-ui/plugin-kanban';
import '@object-ui/plugin-markdown';
import '@object-ui/plugin-object';  // Now auto-imported
// packages/cli/src/commands/dev.ts
viteConfig.resolve.alias = {
  '@object-ui/plugin-charts': join(cwd, 'packages/plugin-charts/src/index.tsx'),
  '@object-ui/plugin-editor': join(cwd, 'packages/plugin-editor/src/index.tsx'),
  '@object-ui/plugin-kanban': join(cwd, 'packages/plugin-kanban/src/index.tsx'),
  '@object-ui/plugin-markdown': join(cwd, 'packages/plugin-markdown/src/index.tsx'),
  '@object-ui/plugin-object': join(cwd, 'packages/plugin-object/src/index.ts'),  // Correct .ts extension
};

Updated Showcase Navigation

Added "Code Editor" and "Markdown" menu items to Complex section in app.json.

Result

All 5 plugins now have complete documentation and working showcase demonstrations.

Markdown Showcase

Original prompt

所有的插件也应该在文档中、演示效果。


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
objectui-docs Error Error Jan 21, 2026 5:48pm
objectui-site Ready Ready Preview, Comment Jan 21, 2026 5:48pm

Request Review

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
@vercel vercel Bot temporarily deployed to Preview – objectui-docs January 21, 2026 17:45 Inactive
Copilot AI changed the title [WIP] Add documentation and demo for all plugins Add documentation and showcase examples for all plugins Jan 21, 2026
Copilot AI requested a review from huangyiirene January 21, 2026 17:50
@github-actions github-actions Bot added documentation Improvements or additions to documentation examples labels Jan 22, 2026
@github-actions
Copy link
Copy Markdown
Contributor

📦 Bundle Size Report

Package Size Gzipped
components (index.js) 1548.04KB 364.64KB
core (index.js) 0.53KB 0.28KB
data-objectql (ObjectQLDataSource.js) 11.05KB 2.64KB
data-objectql (hooks.js) 5.62KB 1.43KB
data-objectql (index.js) 0.62KB 0.36KB
designer (index.js) 1.46KB 0.51KB
plugin-charts (AdvancedChartImpl-DazADGz5.js) 74.89KB 15.82KB
plugin-charts (BarChart-CRc8MAtI.js) 551.60KB 127.51KB
plugin-charts (ChartImpl-DVw_7KEd.js) 3.17KB 1.10KB
plugin-charts (index-CdgY2AuM.js) 12.39KB 3.83KB
plugin-charts (index.js) 0.21KB 0.16KB
plugin-editor (MonacoImpl-B7ZgZJJG.js) 18.15KB 5.59KB
plugin-editor (index-Dl3HAAqu.js) 10.07KB 3.31KB
plugin-editor (index.js) 0.19KB 0.15KB
plugin-kanban (KanbanImpl-CUWM-JC-.js) 76.50KB 20.46KB
plugin-kanban (index-BV3FWhCb.js) 11.86KB 3.67KB
plugin-kanban (index.js) 0.18KB 0.15KB
plugin-markdown (MarkdownImpl-BRkYjVWf.js) 256.79KB 64.50KB
plugin-markdown (index-D_CdfEXQ.js) 9.59KB 3.16KB
plugin-markdown (index.js) 0.19KB 0.15KB
react (SchemaRenderer.js) 1.44KB 0.73KB
react (index.js) 0.32KB 0.23KB
react (index.test.js) 0.34KB 0.26KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 0.20KB 0.18KB
types (base.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (data-display.js) 0.20KB 0.18KB
types (data.js) 0.20KB 0.18KB
types (disclosure.js) 0.20KB 0.18KB
types (feedback.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (index.js) 0.34KB 0.25KB
types (layout.js) 0.20KB 0.18KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (registry.js) 0.20KB 0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@github-actions
Copy link
Copy Markdown
Contributor

✅ All checks passed!

  • ✅ Type check passed
  • ✅ Tests passed
  • ✅ Lint check completed

@huangyiirene huangyiirene marked this pull request as ready for review January 22, 2026 01:56
@huangyiirene huangyiirene merged commit 26bea99 into main Jan 22, 2026
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants