Skip to content
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

fix: add scopeNormalizeStyle method #857

Merged
merged 1 commit into from
Dec 9, 2024
Merged

fix: add scopeNormalizeStyle method #857

merged 1 commit into from
Dec 9, 2024

Conversation

saint3347
Copy link
Collaborator

@saint3347 saint3347 commented Dec 9, 2024

Types of changes

  • New feature
  • Bug fix
  • Site / documentation update
  • Demo update
  • Component style update
  • TypeScript definition update
  • Bundle size optimization
  • Performance optimization
  • Enhancement feature
  • Internationalization
  • Refactoring
  • Code style optimization
  • Test Case
  • Branch merge
  • Workflow
  • Others

Background

Information Descriptions
Browser Chrome / Safari /
Version Chrome 49 ...
OS MacOS / Windows ...

Changelog

  • 增加scopeNormalizeStyle方法,供用户控制normalize css作用域

Summary by CodeRabbit

  • 新特性

    • 更新了版本号至 3.5.4-beta.9
    • 引入了 scopeNormalizeStyle 函数,增强了CSS样式管理和跨浏览器兼容性。
    • 添加了 appendNormalizeStyle 函数,用于创建和附加样式元素。
  • 样式

    • 修改了CSS规范化,确保更一致的样式表现。

Copy link

coderabbitai bot commented Dec 9, 2024

Walkthrough

该拉取请求包含对多个文件的更改。package.json文件的版本号从"3.5.4-beta.8"更新为"3.5.4-beta.9",表示小版本的增量。normalize.ts文件进行了CSS规范化和样式管理的多项修改,包括更改box-sizing属性、更新默认字体和行高、添加新的样式处理函数以及引入作用域CSS规则的功能。最后,index.ts文件更新了导出内容,新增了scopeNormalizeStyle函数的导出。

Changes

文件路径 更改摘要
package.json 版本更新:"version": "3.5.4-beta.8""version": "3.5.4-beta.9"
packages/shineout-style/src/normalize.ts 1. 更改box-sizing属性为border-box
2. 更新默认字体和行高。
3. 添加appendNormalizeStylescopeNormalizeStyle函数。
4. 处理特定设备的字体大小变化和非重叠滚动条样式。
packages/shineout/src/index.ts 新增导出scopeNormalizeStyle函数。更新了导出语句以包含此新实体。

Possibly related PRs

🐇 在草地上跳跃,版本更新来临,
CSS规范化,样式更清新。
新函数加入,样式更灵活,
兔子欢呼,代码更美好!
让我们一起庆祝,快乐无比,
版本号跃升,未来更精彩! 🌟


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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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

@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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 823a6ba and 344fd3f.

📒 Files selected for processing (3)
  • package.json (1 hunks)
  • packages/shineout-style/src/normalize.ts (2 hunks)
  • packages/shineout/src/index.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • package.json
🔇 Additional comments (1)
packages/shineout/src/index.ts (1)

58-58: 成功导出scopeNormalizeStyle方法

正确地从@sheinx/shineout-style模块中导出了scopeNormalizeStyle方法,便于在其他地方使用。

Comment on lines +389 to +419
export const scopeNormalizeStyle = (csScopePrefix = '#app') => {
const styleElement = document.getElementById(uniqueStyleId) as HTMLStyleElement;
// 移除styleElement

const styleSheet = styleElement?.sheet;
const cssRules = styleSheet?.cssRules;
// 遍历cssRules,给每一个selectorText添加前缀
if(cssRules){
for(let i = 0; i < cssRules.length; i++){
const rule = cssRules[i];
if (rule instanceof CSSStyleRule) {
// 如果选择器包含了body或html,则替换,不是加前缀
if(rule.selectorText.includes('body')){
rule.selectorText = rule.selectorText.replace('body', csScopePrefix);
}else if(rule.selectorText.includes('html')){
rule.selectorText = rule.selectorText.replace('html', csScopePrefix);
}else{
const selectors = rule.selectorText.split(',');
const newSelectors = selectors.map(selector => `${csScopePrefix} ${selector}`);
rule.selectorText = newSelectors.join(',');
}
}
}
}

const scopedStyleString = cssRules ? Array.from(cssRules).map(rule => rule.cssText).join('') : '';

document.head.removeChild(styleElement);

appendNormalizeStyle(scopedStyleString, uniqueStyleId);
};
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

⚠️ Potential issue

直接修改CSSRule.selectorText可能导致兼容性问题

scopeNormalizeStyle函数中,通过遍历cssRules并修改selectorText来添加作用域前缀。然而,直接修改selectorText在某些浏览器(尤其是旧版IE和某些移动浏览器)中可能不被支持,可能会引发兼容性问题。

建议在插入样式之前,对normalizeStyle字符串进行处理,添加作用域前缀,然后再将处理后的样式字符串插入到页面中。这样可以避免直接操作CSSOM,提高代码的兼容性和稳定性。

可以考虑如下方式修改代码:

 export const scopeNormalizeStyle = (csScopePrefix = '#app') => {
-  const styleElement = document.getElementById(uniqueStyleId) as HTMLStyleElement;
-  const styleSheet = styleElement?.sheet;
-  const cssRules = styleSheet?.cssRules;
-  if(cssRules){
-    for(let i = 0; i < cssRules.length; i++){
-      const rule = cssRules[i];
-      if (rule instanceof CSSStyleRule) {
-        if(rule.selectorText.includes('body')){
-          rule.selectorText = rule.selectorText.replace('body', csScopePrefix);
-        }else if(rule.selectorText.includes('html')){
-          rule.selectorText = rule.selectorText.replace('html', csScopePrefix);
-        }else{
-          const selectors = rule.selectorText.split(',');
-          const newSelectors = selectors.map(selector => `${csScopePrefix} ${selector}`);
-          rule.selectorText = newSelectors.join(',');
-        }
-      }
-    }
-  }
-  const scopedStyleString = cssRules ? Array.from(cssRules).map(rule => rule.cssText).join('') : '';
-  document.head.removeChild(styleElement);
-  appendNormalizeStyle(scopedStyleString, uniqueStyleId);
+  const scopedStyleString = normalizeStyle.replace(/(^|\n)([^\{\}]+)\{/g, (match, p1, p2) => {
+    let selectors = p2.trim().split(',');
+    selectors = selectors.map(selector => {
+      selector = selector.trim();
+      if (selector.includes('body') || selector.includes('html')) {
+        return selector.replace(/body|html/g, csScopePrefix);
+      } else {
+        return `${csScopePrefix} ${selector}`;
+      }
+    });
+    return `${p1}${selectors.join(', ')} {`;
+  });
+  appendNormalizeStyle(scopedStyleString, uniqueStyleId);
 };

这样,我们对normalizeStyle字符串进行正则替换,添加作用域前缀,避免直接操作CSSOM。

Committable suggestion skipped: line range outside the PR's diff.

@saint3347 saint3347 merged commit b3f06e2 into main Dec 9, 2024
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.

1 participant