docs: fix typos #5105
docs: fix typos #5105
Conversation
mynetfan
requested review from
anncwb,
vince292007 and
a team
as code owners
|
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
packages/@core/ui-kit/form-ui/src/vben-use-form.vueOops! Something went wrong! :( ESLint: 9.16.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs WalkthroughThe pull request includes significant updates to the documentation for the Vben Form and Vben Modal components, enhancing clarity and usability. Key additions include detailed examples for integrating with Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
docs/src/components/common-ui/vben-modal.md (1)
114-114: LGTM! Consider adding a code example.The explanation of
appendToMainproperty is clear, accurate, and provides valuable implementation details. To further enhance the documentation, consider adding a minimal code example demonstrating the correct usage with thePagecomponent'sauto-content-heightproperty.Example addition:
`appendToMain`可以指定将弹窗挂载到内容区域，打开这种弹窗时，内容区域以外的部分（标签栏、导航菜单等等）不会被遮挡。默认情况下，弹窗会挂载到body上。但是：挂载到内容区域时，作为页面根容器的`Page`组件，需要设置`auto-content-height`属性，以便弹窗能够正确计算高度。 + +```vue +<template> + <Page auto-content-height> + <VbenModal :append-to-main="true"> + <!-- Modal content --> + </VbenModal> + </Page> +</template> +```packages/@core/ui-kit/form-ui/src/vben-use-form.vue (1)
65-67: Consider adding error handling for the form value changes.The simplified implementation looks good, but consider adding error handling for the
handleValuesChangecallback to gracefully handle any potential errors during form value updates.- forward.value.handleValuesChange?.(toRaw(form.values)); + try { + forward.value.handleValuesChange?.(toRaw(form.values)); + } catch (error) { + console.error('Error handling form value changes:', error); + }docs/src/components/common-ui/vben-form.md (1)
309-309: Add usage example for handleValuesChange.The property documentation is clear, but it would be helpful to add a code example demonstrating its usage, especially for form value change monitoring scenarios.
Consider adding an example like:
const [Form, formApi] = useVbenForm({ handleValuesChange: (values) => { console.log('Form values changed:', values); // Perform additional actions with the updated values }, });
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
docs/src/components/common-ui/vben-form.md(1 hunks)docs/src/components/common-ui/vben-modal.md(1 hunks)packages/@core/ui-kit/form-ui/src/vben-use-form.vue(1 hunks)
Description
修复文档错字；补全
form的handleValuesChange属性Type of change
Please delete options that are not relevant.
pnpm-lock.yamlunless you introduce a new test example.Checklist
pnpm run docs:devcommand.pnpm test.feat:,fix:,perf:,docs:, orchore:.Summary by CodeRabbit
Documentation
New Features
handleValuesChangeproperty in the useVbenForm props.initComponentAdaptermethod to Vben Form documentation.Bug Fixes