Append HTML string literals with components

zefir-git commented 22 hours ago

Adds handling for HTML template literals with components.

The ElementComponent#html() method is a template literal tag function.

Example usage:

const button = new Component("button")
    .text("Click me")
    .on("click", () => console.log("clicked"));
new Component("div")
    .html`<h1>Hello world</h1>`
    .html`<div>
        <div>
            ${button}
        </div>
        <p>Unlike <code>element.innerHTML = "..."</code>, event listeners are preserved.</p>
    </div>`;

.tag() can be used the same way, except the return value is DocumentComponent. Example:

new Component("div")
    c.append(DocumentComponent.tag`<div>${button}</div>`);

This is a breaking change. For the old behaviour of .html() that removes the component's children, call the .empty() method first.

I sneaked in another method, NodeComponent#context(), which lets you access this component's instance in a function without breaking the chaining.

coderabbitai[bot] commented 22 hours ago

[!WARNING]

Rate limit exceeded

@zefir-git has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 29 seconds before requesting another review.

⌛ How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

📥 Commits
Files that changed from the base of the PR and between d1947300d4294ba108f222aad545724582cbc20a and b527052b5c23a53aa1a4002482826cc4c82dcd55.

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on the addition of the DocumentComponent class and modifications to the ElementComponent and NodeComponent classes. A new file, DocumentComponent.ts, is created, defining the DocumentComponent class that extends NodeComponent with a generic type of DocumentFragment. This class includes a constructor that can accept an optional HTML string, allowing for the creation of a DocumentFragment.

In ElementComponent.ts, the existing method for handling HTML is replaced by a new implementation that constructs a DocumentComponent using the DocumentComponent.tag method, which allows for dynamic content insertion. Additionally, two new methods are added to NodeComponent.ts: context, which executes a function in the context of the component, and empty, which removes all child nodes from the component. Finally, index.ts is updated to export the new DocumentComponent.

Possibly related PRs

#4: The changes in src/ElementComponent.ts involve modifications to the html method, which now utilizes the DocumentComponent.tag method, directly relating to the new DocumentComponent class introduced in the main PR.
#17: The introduction of the NodeComponent class in this PR is foundational for the DocumentComponent, as it extends NodeComponent, establishing a direct relationship between the two components.

Suggested labels

documentation

Suggested reviewers

kai-gitt

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

zefir-git commented 22 hours ago

@coderabbitai full review

coderabbitai[bot] commented 22 hours ago

:white_check_mark: Actions performed

Full review triggered.

cloudnode-pro / components