feat(lists component): add new with-icon state

paghar commented 3 months ago

[x] I have followed the Your First Code Contribution section of the Contributing guide

Adding the new with-icon state to the list component

Summary by CodeRabbit

New Features
- Introduced the ability to use custom icons in lists, enhancing visual appeal and customization.
- Added a new component for rendering lists with icons, supporting both client-side and server-side rendering.
- Updated list components to support icons, including new styling options for enhanced visual customization.
Documentation
- Added documentation on using custom icons in lists.

stackblitz[bot] commented 3 months ago

Run & review this pull request in StackBlitz Codeflow.

vercel[bot] commented 3 months ago

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 19, 2024 8:39am

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent update introduces the capability to use custom icons in lists, enhancing the visual appeal and functionality of list components. This change spans across documentation, example code, and source files, focusing on the implementation of a new React component for lists with icons and updating the List and ListItem components to support icons through theme adjustments and new props.

Changes

Files	Change Summary
`content/docs/typography/list.mdx`	Added section on using custom icons in lists.
`examples/list/index.ts` `examples/list/list.icon.tsx`	Added export of `icon` and introduced a component for lists with icons.
`src/components/List/List.tsx` `src/components/List/ListItem.tsx` `src/components/List/theme.ts`	Updated `List` and `ListItem` for icon support; added `FlowbiteListItemTheme` and updated styling.

🐰✨
In the realm of code, where lists align,
A rabbit hopped in, with an idea so fine.
"Let icons and text, together be shown,
Enhancing the lists, with a style of their own."
So with a little hop, and a joyful tweak,
The lists now unique, their beauty we seek.
🌟📜

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests 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 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 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.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.53%. Comparing base (7461173) to head (281feff). Report is 202 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1304 +/- ## ========================================== - Coverage 99.54% 95.53% -4.01% ========================================== Files 163 217 +54 Lines 6621 9683 +3062 Branches 401 560 +159 ========================================== + Hits 6591 9251 +2660 - Misses 30 432 +402 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

themesberg / flowbite-react