fix: Refine the typing of the ListGroup's slot

[fdevillard]

Closes #1272

📑 Description

Refine the typing of the ListGroup such that the following code type checks correctly:

<script lang="ts">
let myItems = [
    {name: "test1", id: 1},
    {name: "test2", id: 2},
]
</script>

<Listgroup items={myItems} let:item>
    {item.name}
</Listgroup>

Status

• Not Completed
• Completed

✅ Checks

• My pull request adheres to the code style of this project
• My code requires changes to the documentation
• I have updated the documentation as required
• I have checked the page with https://validator.unl.edu/
• All the tests have passed
• My pull request is based on the latest commit (not the npm version).

ℹ Additional Information

Summary by CodeRabbit

• New Features
  • Enhanced flexibility of the List Group component by allowing it to accept a broader range of item types.
  • Improved type safety and reusability for better integration in various contexts.
• Documentation
  • Updated the component's documentation to reflect the new generic type functionality.

[vercel]

@fdevillard is attempting to deploy a commit to the Themesberg Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes to the Listgroup.svelte component introduce a generic type parameter T, enhancing type flexibility for the items property. This allows the component to accommodate a wider range of types, addressing previous typing errors. The introduction of a new $$Slots interface clarifies the slot content, improving type safety and reusability. Overall, these modifications aim to resolve issues related to type errors while maintaining the component's functionality.

Changes

Files	Change Summary
src/lib/list-group/Listgroup.svelte	Converted items to accept a generic type T, updated $$Props, and added new $$Slots interface.

Assessment against linked issues

Objective	Addressed	Explanation
Listgroup Example has a type error (#1272)	✅

🐇 In the meadow where bunnies play,
New types leap and dance today!
Flexibility blooms, errors fade,
With every change, our joy is made!
Hopping high, our code's in tune,
A better Listgroup, we'll sing this tune! 🌼

---

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
• Mastodon
• Reddit
• LinkedIn

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9cb9e52 and 870f411.

Files selected for processing (1)

• src/lib/list-group/Listgroup.svelte (2 hunks)

Additional comments not posted (4)

src/lib/list-group/Listgroup.svelte (4)

1-1: Enhance type flexibility with generics.

The introduction of a generic type parameter T allows the ListGroup component to handle a wider range of item types, improving type safety and flexibility. This change aligns with TypeScript best practices.

---

12-12: Update items property to use generic type T.

The items property now uses the generic type T, which enhances the component's ability to handle different item types without losing type safety.

---

16-18: Introduce $$Slots interface for slot typing.

The new $$Slots interface specifies the types for the default slot, improving type safety and clarity for developers using the component.

---

20-20: Update export statement for items.

The items array is now typed with the generic type T, ensuring that the component can handle various item types while maintaining type safety.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flowbite-svelte	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 19, 2024 7:29pm

[shinokada]

Will the following work without adding type definition to the script tag?

// $lib/types.ts
import type { ComponentProps } from 'svelte';
import type { ListGroupItemType } from '../types';
import type Frame from '../utils/Frame.svelte';

export type T = ListGroupItemType | string;

export interface ListGroupProps extends ComponentProps<Frame> {
  items?: T[];
  active?: boolean;
}

export interface ListGroupSlots {
  default: { item: T; index: number };
}

//src/lib/list-group/Listgroup.svelte
<script lang="ts">
  import type { ListGroupProps, ListGroupSlots, T } from './ListGroup';
  import { createEventDispatcher, setContext } from 'svelte';
  import { twMerge } from 'tailwind-merge';
  import Frame from '../utils/Frame.svelte';
  import ListgroupItem from './ListgroupItem.svelte';

  type $$Props = ListGroupProps;
  type $$Slots = ListGroupSlots;

  const dispatch = createEventDispatcher();
  export let items: T[] = [];
  // more lines
</script>

[ziadalzarka]

I have the same issue, this should fix it.

[fdevillard]

Will the following work without adding type definition to the script tag?

It could also, but the behavior would be slightly different. My understanding of the component (which is shallow, as I haven't used it a lot) is that:

• you can give list of strings to the ListGroup and then the slot's item is a string,
• or, you can give a list of ListGroupItemType and the slot's item is a ListGroupItemType.

If I understand your proposal correctly, we would loose this information. The typing would support a ListGroupItemType with a slot receiving a string. However, the actual value would be a string ListGroupItemType.

That's what the generics is expected to solve.

[shinokada]

I have no problem using the generics. It isn't common to use type in the script tag.

[shinokada]

Thank you for the PR.

[fdevillard]

Oh thank you for the merge 👍 Sorry for the delay, I didn't see the notification 🙈