phase2 / outline

Tooling infrastructure for modern web component development.
https://outline.phase2tech.com
MIT License
128 stars 27 forks source link

Controller: `@phase2/outline-controller-resize-controller` #393

Open shaal opened 1 year ago

shaal commented 1 year ago

Testing

Description

The new resize controller includes multiple improvements over previous attempts

This resize-controller has been extensively tested by multiple projects.

Component width is being tracked by the Browser API's resize observer

Debounce during resize to reduce amount of events

Only when component width moves over from one breakpoint range to another, component update is called.

During component render, only current breakpoint range variable is read (no function is being called)

Provides the ability to separate the element tracking width from the element that will be updated (useful when we need to synchronize all items in a container to switch together at the same breakpoint).

Fixes # (issue)

Type of change

Please delete options that are not relevant.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Checklist

Summary by CodeRabbit

changeset-bot[bot] commented 1 year ago

⚠️ No Changeset found

Latest commit: 5b3724a4a76571957bfdc83e1f1db0142364765d

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 1 year ago

Deploy Preview for outlinejs ready!

Name Link
Latest commit 5b3724a4a76571957bfdc83e1f1db0142364765d
Latest deploy log https://app.netlify.com/sites/outlinejs/deploys/65c247cf76f0e1000864634d
Deploy Preview https://deploy-preview-393--outlinejs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

coderabbitai[bot] commented 8 months ago

Walkthrough

The update introduces a new utility module named resize-controller, which includes a ResizeController class for monitoring and reacting to size changes in web components. This module enhances dynamic responsiveness by simplifying the handling of resize events and enabling developers to execute actions based on component size adjustments.

Changes

File Path Change Summary
.../resize-controller/ Introduces the resize-controller utility module for monitoring and reacting to web component size changes.
.../resize-controller/index.ts Exports the ResizeController class from src/resize-controller.
.../resize-controller/src/resize-controller.ts Adds ResizeController class implementing ReactiveController for observing element resize events and managing breakpoints.

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.
glitchgirl commented 7 months ago

this needs to be updated @shaal