`AdoptedStyleSheets` Update: Attach styles to `document` or `this.shadowRoot`

himerus commented 9 months ago

Summary by CodeRabbit

New Features
- Enhanced style management efficiency by introducing a method for attaching encapsulated stylesheets to web components.
Refactor
- Updated the AdoptedStylesheets controller for improved handling of CSSStyleSheet objects and connection lifecycle.
Documentation
- Added documentation for the new createRenderRoot method in the AdoptedStylesheets controller.

changeset-bot[bot] commented 9 months ago

⚠️ No Changeset found

Latest commit: d5637cdd149d32ef8de46f288a95f64567c58af9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

netlify[bot] commented 9 months ago

Deploy Preview for outlinejs failed.

Name	Link
Latest commit	d5637cdd149d32ef8de46f288a95f64567c58af9
Latest deploy log	https://app.netlify.com/sites/outlinejs/deploys/65ce629f706a9b0008990919

coderabbitai[bot] commented 9 months ago

[!IMPORTANT]

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
* `packages/controllers/adopted-stylesheets/package.json` is excluded by: `!**/*.json`

Walkthrough

The update introduces a refined approach to managing styles within web components through the AdoptedStylesheets controller. This enhancement focuses on the seamless attachment of encapsulated stylesheets via the createRenderRoot method. By leveraging modern browser capabilities, it ensures a more efficient and standardized inclusion of styles, significantly improving the style management process in web components.

Changes

File Path Change Summary

.../adopted-stylesheets/README.md Updated documentation to reflect the new method for attaching encapsulated stylesheets using createRenderRoot.

.../adopted-stylesheets/src/adopted-stylesheets.ts - Introduced constructor with globalStyles, root, and host parameters.
- Added adoptedSheet private property.
- Implemented logic to manage CSSStyleSheet objects, ensuring they are efficiently included and removed from adoptedStyleSheets.
- Renamed class from AdoptedStyleSheets to AdoptedStylesheets.
- Added root and host as new private properties.
- Updated hostConnected and hostDisconnected methods to align with the new property structure and logic.

File Path	Change Summary
`.../adopted-stylesheets/README.md`	Updated documentation to reflect the new method for attaching encapsulated stylesheets using `createRenderRoot`.
`.../adopted-stylesheets/src/adopted-stylesheets.ts`	- Introduced `constructor` with `globalStyles`, `root`, and `host` parameters. - Added `adoptedSheet` private property. - Implemented logic to manage `CSSStyleSheet` objects, ensuring they are efficiently included and removed from `adoptedStyleSheets`. - Renamed class from `AdoptedStyleSheets` to `AdoptedStylesheets`. - Added `root` and `host` as new private properties. - Updated `hostConnected` and `hostDisconnected` methods to align with the new property structure and logic.

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 .` - `Generate unit-tests for this file.` - 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 tests 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 generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

phase2 / outline