docs: update renderSettings MenuConfig example - #26
Open
Sion612 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
🟢 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 staleTunesMenuConfigphrasing toMenuConfig. - Updates the example to use
title(instead of the deprecatedlabelalias) and demonstrates a state-backed toggle viaisActive,toggle, andonActivate. - Keeps the existing guidance that
renderSettings()may alternatively return a customHTMLElementfor 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
TunesMenuConfigexample heading withMenuConfig;titlefield instead of the deprecatedlabelalias;isActive,toggle, andonActivate;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 --immutablenode node_modules/codex.docs/dist/backend/app.js build-statictools-api/index.htmlandmenu-config/index.htmlexistcodex.docsapplication/tools-apiand/menu-configreturn HTTP 200renderSettings()section in ChromeTools APIrecord changed semanticallygit diff --checkNo dependencies, lockfile entries, unrelated documentation records, or runtime
code were changed.