Skip to content

物料可以单独设置是否添加基础样式,可以和物料插件useBaseStyle配置组合使用#1238

Merged
chilingling merged 6 commits intoopentiny:developfrom
BWrong:develop
Jun 17, 2025
Merged

物料可以单独设置是否添加基础样式,可以和物料插件useBaseStyle配置组合使用#1238
chilingling merged 6 commits intoopentiny:developfrom
BWrong:develop

Conversation

@BWrong
Copy link
Copy Markdown
Contributor

@BWrong BWrong commented Mar 21, 2025

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Components now apply dynamic styling based on both global and material-specific design configurations, offering more tailored and consistent visual presentation.
    • The appearance can adapt conditionally, enhancing the overall flexibility and aesthetic control of the interface.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 21, 2025

Walkthrough

The generateNode function in packages/plugins/materials/src/composable/useMaterial.ts was updated to integrate material configuration via getMaterial(component). It now combines a global base style flag with the material-specific useBaseStyle setting to decide on applying base styles, adjusting className assignment accordingly. The handling of the 'block' type remains similar but uses only the global flag.

Changes

File Description
packages/.../useMaterial.ts Reworked generateNode to fetch material config with getMaterial(component), combined global and material useBaseStyle flags, and updated schema className logic.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant GN as generateNode
    participant GM as getMaterial

    Caller->>GN: Call generateNode({ type, component })
    GN->>GM: Request material configuration
    GM-->>GN: Return material config
    GN->>GN: Combine global and material useBaseStyle flags
    GN->>GN: Conditionally assign className in schema
    GN-->>Caller: Return node schema
Loading

Poem

In my burrow of code I joyfully hop,
New paths and checks make my heart never stop.
A carrot of config leads me on my way,
Where class names bloom with style every day.
Hopping through functions with a code-hop beat,
I celebrate changes with a twitch of my feet!
🥕🐇


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between de8d39b and 038ba2d.

📒 Files selected for processing (1)
  • packages/plugins/materials/src/composable/useMaterial.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/plugins/materials/src/composable/useMaterial.ts
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor Author

@BWrong BWrong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

物料可以单独设置是否添加基础样式,可以和物料插件useBaseStyle配置组合使用

@BWrong BWrong changed the title Develop 物料可以单独设置是否添加基础样式,可以和物料插件useBaseStyle配置组合使用 Mar 21, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
packages/plugins/materials/src/composable/useMaterial.ts (4)

466-487: Improved flexibility for material styling configuration

The reworked generateNode function now provides more granular control over base styles through the material configuration. This is a good improvement that allows individual materials to opt-out of base styles when needed.

Consider renaming notUseBaseStyle to skipBaseStyle or disableBaseStyle to avoid double negation, which would make the logic more intuitive:

- const notUseBaseStyle = material.configure?.notUseBaseStyle
- const useBaseStyle = getOptions(meta.id).useBaseStyle && !notUseBaseStyle
+ const skipBaseStyle = material.configure?.skipBaseStyle
+ const useBaseStyle = getOptions(meta.id).useBaseStyle && !skipBaseStyle

468-471: Consider adding a safety check for the material object

The current implementation could throw an error if material is undefined or null before accessing configure.

Add a safety check to ensure material is defined:

- const material = getMaterial(component)
+ const material = getMaterial(component) || {}

This matches line 389 where getMaterial returns an empty object as a fallback.


471-478: Consider extracting the base style class name into a variable

For better maintainability and to avoid repeating the options getter.

Extract the repeated pattern into variables:

  const useBaseStyle = getOptions(meta.id).useBaseStyle && !notUseBaseStyle
+ const componentBaseClassName = useBaseStyle ? getOptions(meta.id).componentBaseStyle.className : ''
  const schema = {
    componentName: component,
    ...snippet,
    props: {
      ...snippet.props,
-     className: useBaseStyle ? getOptions(meta.id).componentBaseStyle.className : ''
+     className: componentBaseClassName
    }
  }

481-484: Same pattern repeated for block type

Similar to the previous comment, the same pattern of accessing options and checking useBaseStyle is repeated.

For consistency and to avoid repeating logic, consider refactoring:

  if (type === 'block') {
    schema.componentType = 'Block'
-   schema.props.className = getOptions(meta.id).useBaseStyle ? getOptions(meta.id).blockBaseStyle.className : ''
+   schema.props.className = useBaseStyle ? getOptions(meta.id).blockBaseStyle.className : ''
  }

This maintains consistency with how useBaseStyle is used above and avoids re-evaluating getOptions(meta.id).useBaseStyle.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f061353 and de8d39b.

📒 Files selected for processing (1)
  • packages/plugins/materials/src/composable/useMaterial.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

Comment thread packages/plugins/materials/src/composable/useMaterial.ts Outdated
Copy link
Copy Markdown
Contributor Author

@BWrong BWrong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix: 优化配置名称为useBaseStyle,保持和全局配置一致

Copy link
Copy Markdown
Contributor Author

@BWrong BWrong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix: 优化配置名称为useBaseStyle,保持和全局配置一致

@chilingling
Copy link
Copy Markdown
Member

image
有冲突,麻烦解决一下冲突 @BWrong

@chilingling chilingling merged commit e26ea39 into opentiny:develop Jun 17, 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