Skip to content

docs: update renderSettings MenuConfig example - #26

Open
Sion612 wants to merge 1 commit into
codex-team:mainfrom
Sion612:docs/render-settings-menu-config
Open

docs: update renderSettings MenuConfig example#26
Sion612 wants to merge 1 commit into
codex-team:mainfrom
Sion612:docs/render-settings-menu-config

Conversation

@Sion612

@Sion612 Sion612 commented Sep 3, 2026

Copy link
Copy Markdown

Summary

  • replace the stale TunesMenuConfig example heading with MenuConfig;
  • use the current title field instead of the deprecated label alias;
  • demonstrate a state-backed toggle using isActive, toggle, and
    onActivate;
  • preserve the existing custom element fallback guidance.

Context

This is a follow-up to
codex-team/editor.js#3021.

After that documentation update was merged, a maintainer noted that the
canonical website documentation data should also be updated in
codex-team/editorjs.io.

Verification

  • node .yarn/releases/yarn-3.3.1.cjs install --immutable
  • node node_modules/codex.docs/dist/backend/app.js build-static
    • generated 43 documentation pages;
    • verified that tools-api/index.html and menu-config/index.html exist
  • started the local codex.docs application
  • verified /tools-api and /menu-config return HTTP 200
  • visually checked the updated renderSettings() section in Chrome
  • syntax-checked the updated example
  • verified that the database still contains 43 records and only the
    Tools API record changed semantically
  • git diff --check

No dependencies, lockfile entries, unrelated documentation records, or runtime
code were changed.

Copilot AI 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.

🟢 Approval recommended

The change is confined to a documentation content record and the updated MenuConfig example matches the documented MenuConfigItem fields (including title, isActive, toggle, and onActivate).

Pull request overview

Updates the website’s canonical documentation record for the Tools API page so the renderSettings() section reflects the current MenuConfig API and recommended toggle patterns, aligning codex-team/editorjs.io with the upstream docs update in codex-team/editor.js#3021.

Changes:

  • Renames the renderSettings() example heading from the stale TunesMenuConfig phrasing to MenuConfig.
  • Updates the example to use title (instead of the deprecated label alias) and demonstrates a state-backed toggle via isActive, toggle, and onActivate.
  • Keeps the existing guidance that renderSettings() may alternatively return a custom HTMLElement for advanced use-cases.
File summaries
File Description
db/pages.db Updates the stored “Tools API” documentation record, refreshing the renderSettings() MenuConfig example.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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.

2 participants