Skip to content

feat(docs): Add button color examples and update preview components t… #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2025

Conversation

Azir-11
Copy link
Member

@Azir-11 Azir-11 commented Apr 3, 2025

…o support presentation properties

支持以多个独立块的方式在文档展示组件,效果如下:
image
--- 分割线 ---
image

组件文档书写流程如下:

  1. examples/src/ui/组件/对应demo.vue 新建/修改
    1.1 如果是新建组建的话,需要在组件下提供index.ts导出该文件夹下的全部demo组件,然后在 examples/src/index.ts 下导出该组件
    1.2 如果是新建demo的话,在组件下的index.ts还应该导出对应组件内容
  2. 执行 pnpm rebuild-code 重新生成用以预览的code信息
  3. 在 md 文档里,使用下面的这种形式去在页面渲染对应的内容
<ComponentPreview name="组件名" demo="demo名" />

该pr目前我发现还有三个问题,但是可以先提交,再继续修改

  1. ComponentPreview 组件在呈现上仍有一定问题,比如切换到代码块后组件高度不对,右侧功能按钮贴合程度不够,name的显示,整体页面的两栏显示等问题,这个我会在后续pr里进行修复优化
  2. 组件和生成code的代码,目前留有兼容旧版纯name和ui根目录直接写example的写法,需要在迁移完后删除
  3. 在src里目前没有考虑到多component的渲染,不过应该也是可以解决的

@honghuangdc honghuangdc merged commit 6595e07 into soybeanjs:main Apr 4, 2025
1 check passed
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