Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 27, 2026

Documentation was missing for the 12 field widget components (@object-ui/fields) and 5 core app components (@object-ui/react, @object-ui/layout). Users had no reference for available field types or core architectural components.

Changes

New documentation sections:

  • Fields (/docs/fields/*) - Documents all field widget components:

    • Input fields: Text, TextArea, Number, Currency, Date, Email, Phone, URL
    • Selection fields: Boolean, Select, Lookup
    • Rich content: Rich Text (Markdown/HTML)
  • Core (/docs/core/*) - Documents core rendering and layout components:

    • SchemaRenderer - JSON schema to React component renderer
    • FormRenderer - Dynamic form engine with validation
    • AppShell - Application shell with sidebar/header layout
    • PageHeader - Page header with actions
    • SidebarNav - Sidebar navigation with active states

Structure:

content/docs/
├── core/
│   ├── meta.json
│   ├── schema-renderer.mdx
│   ├── form-renderer.mdx
│   ├── app-shell.mdx
│   ├── page-header.mdx
│   └── sidebar-nav.mdx
├── fields/
│   ├── meta.json
│   ├── text.mdx
│   ├── textarea.mdx
│   ├── number.mdx
│   ├── currency.mdx
│   ├── boolean.mdx
│   ├── select.mdx
│   ├── date.mdx
│   ├── email.mdx
│   ├── phone.mdx
│   ├── url.mdx
│   ├── lookup.mdx
│   └── rich-text.mdx
└── meta.json (updated with new sections)

Each page includes TypeScript interfaces, ComponentDemo examples, use cases, and cell renderer info.

Screenshots

Fields documentation:
Fields Documentation

Core components documentation:
Core Documentation

Navigation structure:
Documentation Navigation

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • fonts.googleapis.com
    • Triggering command: /usr/local/bin/node /usr/local/bin/node /home/REDACTED/work/objectui/objectui/node_modules/.pnpm/next@16.1.4_@babel+core@7.28.6_react-dom@19.2.3_react@19.2.3__react@19.2.3/node_modules/next/dist/server/lib/start-server.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

在文档中如何展示字段类型组件以及基础的?page app内核组件?


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@vercel
Copy link

vercel bot commented Jan 27, 2026

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

Project Deployment Review Updated (UTC)
objectui-crm-app Ready Ready Preview, Comment Jan 27, 2026 2:10pm
objectui-site Ready Ready Preview, Comment Jan 27, 2026 2:10pm

Request Review

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for field type components Add documentation for field widgets and core components Jan 27, 2026
Copilot AI requested a review from hotlong January 27, 2026 13:36
Deleted unnecessary CSS imports from layout.tsx, including AG Grid and Object UI styles. Added fumadocs-ui dist JS files to Tailwind source scanning in global.css for improved style coverage.
@github-actions
Copy link

✅ All checks passed!

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

1 similar comment
@github-actions
Copy link

✅ All checks passed!

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

@xuyushun441-sys xuyushun441-sys marked this pull request as ready for review January 27, 2026 14:08
@xuyushun441-sys xuyushun441-sys merged commit fd5ddb7 into main Jan 27, 2026
9 of 11 checks passed
@github-actions
Copy link

✅ All checks passed!

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

1 similar comment
@github-actions
Copy link

✅ All checks passed!

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

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants