Controller: `@phase2/outline-controller-slot-manager` #389

bardleb · 2023-05-16T14:54:17Z

Description

Separated Slot Controller into its own package and renamed as Slot Manager

Summary by CodeRabbit

New Features
- Introduced the SlotManager for enhanced slot management within the shadow DOM, including cloning slots, adding annotations, and event dispatching between shadow and light DOM slots.
Documentation
- Updated the README.md for the SlotManager with usage and feature documentation.
Refactor
- Exported the SlotManager class from src/slot-manager in a new index.ts file.
- Introduced a new slot-manager.ts file with the SlotManager class for managing slots in Lit web components.

changeset-bot · 2023-05-16T14:54:20Z

⚠️ No Changeset found

Latest commit: cd94916

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 · 2023-05-16T14:54:23Z

✅ Deploy Preview for outlinejs ready!

Name	Link
🔨 Latest commit	`cd94916`
🔍 Latest deploy log	https://app.netlify.com/sites/outlinejs/deploys/65c29bed6edbb0000808ecee
😎 Deploy Preview	https://deploy-preview-389--outlinejs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

bardleb · 2023-05-23T13:40:29Z

packages/controllers/slot-manager/README.md

Please add code examples for usage with ShadowDOM, LightDOM and how to handle a single unnamed (default) slot.

himerus · 2023-07-25T14:16:35Z

This is marked Held for Review until further notice.
cc @bardleb @shaal

himerus

At a core level, I'd like to see/discuss this being moved into TWO controllers.

Controller 1: SlotManager - Has all sorts of cool slot tools for ALL components that have slots.
- Testing if a slot exists
- Conditional rendering a slot
Controller 2: SlotShifter (lol) - This one should, and I know this is a pain be a standalone piece that can be additive to the SlotManager.
- Can this EXTEND the SlotManager to add in the additional functionality related to managing slot movement/event delegation/etc??

glitchgirl · 2024-02-06T15:01:29Z

TODO:

review this code and simplify to only contain shadow dom tools

coderabbitai · 2024-02-06T15:01:42Z

Walkthrough

The update introduces the SlotManager, a utility class for managing slots in Lit web components. It provides methods for interacting with and manipulating slots, including retrieving slotted nodes, checking slot existence, identifying default slot text and elements, and conditionally rendering slots with wrappers and classes.

Changes

File(s)	Change Summary
`.../slot-manager/README.md`	Introduced documentation for the `SlotManager`, detailing its purpose and capabilities in managing slots within Lit web components.
`.../slot-manager/index.ts, src/slot-manager.ts`	Added `index.ts` to export the `SlotManager` class and implemented `slot-manager.ts` with methods for slot management in Lit web components.

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>.
- 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.
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 to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 9

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 330e286 and ff89682.

Files ignored due to path filters (2)

packages/controllers/slot-manager/package.json is excluded by: !**/*.json
packages/controllers/slot-manager/tsconfig.build.json is excluded by: !**/*.json

Files selected for processing (3)

packages/controllers/slot-manager/README.md (1 hunks)
packages/controllers/slot-manager/index.ts (1 hunks)
packages/controllers/slot-manager/src/slot-manager.ts (1 hunks)

Files skipped from review due to trivial changes (1)

packages/controllers/slot-manager/index.ts

Additional comments: 1

packages/controllers/slot-manager/src/slot-manager.ts (1)

373-400: The conditionalSlot method's implementation is clear, but ensure that the use of ifDefined and classMap from lit is optimal for the intended use cases.

packages/controllers/slot-manager/README.md

packages/controllers/slot-manager/src/slot-manager.ts

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between ff89682 and a208ab9.

Files selected for processing (1)

packages/controllers/slot-manager/src/slot-manager.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/controllers/slot-manager/src/slot-manager.ts

himerus · 2024-02-06T18:57:21Z

@coderabbitai review

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a208ab9 and cd94916.

Files ignored due to path filters (1)

packages/controllers/slot-manager/package.json is excluded by: !**/*.json

Files selected for processing (2)

packages/controllers/slot-manager/README.md (1 hunks)
packages/controllers/slot-manager/src/slot-manager.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

packages/controllers/slot-manager/README.md
packages/controllers/slot-manager/src/slot-manager.ts

bardleb added 2 commits May 16, 2023 10:51

feat: Separating slot controller out into a package

ada4465

fix: updated readme

371ed8b

bardleb assigned shaal May 16, 2023

bardleb added the Work In Progress label May 16, 2023

fix: update README

2c0f57d

shaal changed the title ~~Feature/slot controller package~~ Feature/slot-manager package (previously called slots-controller) May 22, 2023

shaal added Ready for Review and removed Work In Progress labels May 22, 2023

himerus added Type: Controller Suggestion Use this label for any issue that is a recommendation for a specific type of controller. CANNOT MERGE Temporary flag for a PR that has failing tests, broken pipelines, etc. labels May 22, 2023

himerus added 2 commits May 22, 2023 14:07

Merge branch 'next' into feature/slot-controller-package

8573d7a

fix(prettier): Fixing improper indentations.

61f0f24

himerus removed the CANNOT MERGE Temporary flag for a PR that has failing tests, broken pipelines, etc. label May 22, 2023

himerus changed the title ~~Feature/slot-manager package (previously called slots-controller)~~ Controller: @phase2/outline-controller-slot-manager May 22, 2023

himerus self-assigned this May 22, 2023

bardleb commented May 23, 2023

View reviewed changes

himerus added the Held for Review Held for review. Considered as a Draft/POC. label Jul 25, 2023

himerus suggested changes Jul 28, 2023

View reviewed changes

Merge branch 'next' into feature/slot-controller-package

ff89682

coderabbitai bot reviewed Feb 6, 2024

View reviewed changes

feat(slot-manager): Simplified logic dramatically.

a208ab9

coderabbitai bot reviewed Feb 6, 2024

View reviewed changes

himerus self-requested a review February 6, 2024 20:24

himerus removed the Held for Review Held for review. Considered as a Draft/POC. label Feb 6, 2024

himerus added 2 commits February 6, 2024 15:28

feat(slot-manager): Fixed version number.

6fc96ff

feat(slot-manager): Tweaked docs.

cd94916

coderabbitai bot reviewed Feb 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Controller: `@phase2/outline-controller-slot-manager` #389

Controller: `@phase2/outline-controller-slot-manager` #389

bardleb commented May 16, 2023 •

edited by coderabbitai bot

Loading

changeset-bot bot commented May 16, 2023 •

edited

Loading

netlify bot commented May 16, 2023 •

edited

Loading

bardleb May 23, 2023

himerus commented Jul 25, 2023

himerus left a comment

glitchgirl commented Feb 6, 2024

coderabbitai bot commented Feb 6, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot left a comment

himerus commented Feb 6, 2024

coderabbitai bot left a comment

Controller: @phase2/outline-controller-slot-manager #389

Are you sure you want to change the base?

Controller: @phase2/outline-controller-slot-manager #389

Conversation

bardleb commented May 16, 2023 • edited by coderabbitai bot Loading

Description

Summary by CodeRabbit

changeset-bot bot commented May 16, 2023 • edited Loading

⚠️ No Changeset found

netlify bot commented May 16, 2023 • edited Loading

✅ Deploy Preview for outlinejs ready!

bardleb May 23, 2023

Choose a reason for hiding this comment

himerus commented Jul 25, 2023

himerus left a comment

Choose a reason for hiding this comment

glitchgirl commented Feb 6, 2024

coderabbitai bot commented Feb 6, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

himerus commented Feb 6, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

Controller: `@phase2/outline-controller-slot-manager` #389

Controller: `@phase2/outline-controller-slot-manager` #389

bardleb commented May 16, 2023 •

edited by coderabbitai bot

Loading

changeset-bot bot commented May 16, 2023 •

edited

Loading

netlify bot commented May 16, 2023 •

edited

Loading

coderabbitai bot commented Feb 6, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)